SubscriptionInfo (vSphere Automation SDK for Java 7.0.1.0)

java.lang.Object
- com.vmware.content.library.SubscriptionInfo

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable
```
public final class SubscriptionInfo
extends java.lang.Object
implements java.io.Serializable, StaticStructure
```
The SubscriptionInfo class defines the subscription behavior for a subscribed library.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SubscriptionInfo.AuthenticationMethod` Indicate how the subscribed library should authenticate with the published library endpoint.
`static class`	`SubscriptionInfo.Builder` Builder class for `SubscriptionInfo`.

Field Summary

Fields
Modifier and Type Field and Description

protected StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

SubscriptionInfo()
Default constructor.

protected SubscriptionInfo(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`SubscriptionInfo()` Default constructor.
`protected`	`SubscriptionInfo(StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Structure> T`	`_convertTo(java.lang.Class<T> clazz)` Converts this structure into an instance of the provided class structure if possible.
`java.lang.String`	`_getCanonicalName()` Returns the canonical name of the structure.
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`StructValue`	`_getDataValue()` Returns this `Structure` represented in the dynamic `DataValue` model.
`DataValue`	`_getDynamicField(java.lang.String fieldName)` Get dynamic filed value.
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()` Get the names of the dynamic fields in the structure.
`com.vmware.vapi.bindings.type.StructType`	`_getType()` WARNING: Internal method, subject to change in future versions.
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)` Checks if the runtime type name of this structure matches the type represented by the specified binding class.
`static SubscriptionInfo`	`_newInstance(StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static SubscriptionInfo`	`_newInstance2(StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, DataValue fieldValue)` Sets a dynamic field value.
`protected void`	`_updateDataValue(StructValue structValue)`
`void`	`_validate()` Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding `Structure`.
`boolean`	`equals(java.lang.Object obj)`
`SubscriptionInfo.AuthenticationMethod`	`getAuthenticationMethod()` Indicate how the subscribed library should authenticate (BASIC, NONE) with the published library endpoint.
`java.lang.Boolean`	`getAutomaticSyncEnabled()` Whether the library should participate in automatic library synchronization.
`java.lang.Boolean`	`getOnDemand()` Indicates whether a library item's content will be synchronized only on demand.
`char[]`	`getPassword()` The password to use when authenticating.
`SourceInfo`	`getSourceInfo()` Information about the source published library.
`java.lang.String`	`getSslThumbprint()` An optional SHA-1 hash of the SSL certificate for the remote endpoint.
`java.net.URI`	`getSubscriptionUrl()` The URL of the endpoint where the metadata for the remotely published library is being served.
`java.lang.String`	`getUserName()` The username to use when authenticating.
`int`	`hashCode()`
`void`	`setAuthenticationMethod(SubscriptionInfo.AuthenticationMethod authenticationMethod)` Indicate how the subscribed library should authenticate (BASIC, NONE) with the published library endpoint.
`void`	`setAutomaticSyncEnabled(java.lang.Boolean automaticSyncEnabled)` Whether the library should participate in automatic library synchronization.
`void`	`setOnDemand(java.lang.Boolean onDemand)` Indicates whether a library item's content will be synchronized only on demand.
`void`	`setPassword(char[] password)` The password to use when authenticating.
`void`	`setSourceInfo(SourceInfo sourceInfo)` Information about the source published library.
`void`	`setSslThumbprint(java.lang.String sslThumbprint)` An optional SHA-1 hash of the SSL certificate for the remote endpoint.
`void`	`setSubscriptionUrl(java.net.URI subscriptionUrl)` The URL of the endpoint where the metadata for the remotely published library is being served.
`void`	`setUserName(java.lang.String userName)` The username to use when authenticating.
`java.lang.String`	`toString()` Returns a string representation of this structure.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __dynamicStructureFields
```
protected StructValue __dynamicStructureFields
```
- Constructor Detail
  - SubscriptionInfo
```
public SubscriptionInfo()
```
    Default constructor.
  - SubscriptionInfo
```
protected SubscriptionInfo(StructValue __dynamicStructureFields)
```
- Method Detail
  - getAuthenticationMethod
```
public SubscriptionInfo.AuthenticationMethod getAuthenticationMethod()
```
    Indicate how the subscribed library should authenticate (BASIC, NONE) with the published library endpoint. This property must be provided for the create method. It will always be present in the return value of the get or list methods. It is optional for the update method.
    
    Returns:
    
    The current value of the property.
  - setAuthenticationMethod
```
public void setAuthenticationMethod(SubscriptionInfo.AuthenticationMethod authenticationMethod)
```
    Indicate how the subscribed library should authenticate (BASIC, NONE) with the published library endpoint. This property must be provided for the create method. It will always be present in the return value of the get or list methods. It is optional for the update method.
    
    Parameters:
    
    authenticationMethod - New value for the property.
  - getAutomaticSyncEnabled
```
public java.lang.Boolean getAutomaticSyncEnabled()
```
    Whether the library should participate in automatic library synchronization. In order for automatic synchronization to happen, the global ConfigurationModel.getAutomaticSyncEnabled() option must also be true. The subscription is still active even when automatic synchronization is turned off, but synchronization is only activated with an explicit call to SubscribedLibrary.sync(java.lang.String) or SubscribedItem.sync(java.lang.String, boolean). In other words, manual synchronization is still available even when automatic synchronization is disabled. This property must be provided for the create method. It will always be present in the return value of the get or list methods. It is optional for the update method.
    
    Returns:
    
    The current value of the property.
  - setAutomaticSyncEnabled
```
public void setAutomaticSyncEnabled(java.lang.Boolean automaticSyncEnabled)
```
    Whether the library should participate in automatic library synchronization. In order for automatic synchronization to happen, the global ConfigurationModel.getAutomaticSyncEnabled() option must also be true. The subscription is still active even when automatic synchronization is turned off, but synchronization is only activated with an explicit call to SubscribedLibrary.sync(java.lang.String) or SubscribedItem.sync(java.lang.String, boolean). In other words, manual synchronization is still available even when automatic synchronization is disabled. This property must be provided for the create method. It will always be present in the return value of the get or list methods. It is optional for the update method.
    
    Parameters:
    
    automaticSyncEnabled - New value for the property.
  - getOnDemand
```
public java.lang.Boolean getOnDemand()
```
    Indicates whether a library item's content will be synchronized only on demand.
    If this is set to true, then the library item's metadata will be synchronized but the item's content (its files) will not be synchronized. The Content Library Service will synchronize the content upon request only. This can cause the first use of the content to have a noticeable delay.
    
    Items without synchronized content can be forcefully synchronized in advance using the SubscribedItem.sync(java.lang.String, boolean) call with forceSyncContent set to true. Once content has been synchronized, the content can removed with the SubscribedItem.evict(java.lang.String) call.
    
    If this value is set to false, all content will be synchronized in advance.
    This property must be provided for the create method. It will always be present in the return value of the get or list methods. It is optional for the update method.
    
    Returns:
    
    The current value of the property.
  - setOnDemand
```
public void setOnDemand(java.lang.Boolean onDemand)
```
    Indicates whether a library item's content will be synchronized only on demand.
    If this is set to true, then the library item's metadata will be synchronized but the item's content (its files) will not be synchronized. The Content Library Service will synchronize the content upon request only. This can cause the first use of the content to have a noticeable delay.
    
    Items without synchronized content can be forcefully synchronized in advance using the SubscribedItem.sync(java.lang.String, boolean) call with forceSyncContent set to true. Once content has been synchronized, the content can removed with the SubscribedItem.evict(java.lang.String) call.
    
    If this value is set to false, all content will be synchronized in advance.
    This property must be provided for the create method. It will always be present in the return value of the get or list methods. It is optional for the update method.
    
    Parameters:
    
    onDemand - New value for the property.
  - getPassword
```
public char[] getPassword()
```
    The password to use when authenticating.
    The password must be set when using a password-based authentication method; empty strings are not allowed.
    This property is optional for the create method. It will not be present in the return value of the get or list methods. It is optional for the update method.
    
    Returns:
    
    The current value of the property.
  - setPassword
```
public void setPassword(char[] password)
```
    The password to use when authenticating.
    The password must be set when using a password-based authentication method; empty strings are not allowed.
    This property is optional for the create method. It will not be present in the return value of the get or list methods. It is optional for the update method.
    
    Parameters:
    
    password - New value for the property.
  - getSslThumbprint
```
public java.lang.String getSslThumbprint()
```
    An optional SHA-1 hash of the SSL certificate for the remote endpoint.
    If this value is defined the SSL certificate will be verified by comparing it to the SSL thumbprint. The SSL certificate must verify against the thumbprint. When specified, the standard certificate chain validation behavior is not used. The certificate chain is validated normally if this value is null.
    This property is optional for the create method. It will not be present in the return value of the get or list methods. It is optional for the update method.
    
    Returns:
    
    The current value of the property.
  - setSslThumbprint
```
public void setSslThumbprint(java.lang.String sslThumbprint)
```
    An optional SHA-1 hash of the SSL certificate for the remote endpoint.
    If this value is defined the SSL certificate will be verified by comparing it to the SSL thumbprint. The SSL certificate must verify against the thumbprint. When specified, the standard certificate chain validation behavior is not used. The certificate chain is validated normally if this value is null.
    This property is optional for the create method. It will not be present in the return value of the get or list methods. It is optional for the update method.
    
    Parameters:
    
    sslThumbprint - New value for the property.
  - getSubscriptionUrl
```
public java.net.URI getSubscriptionUrl()
```
    The URL of the endpoint where the metadata for the remotely published library is being served.
    This URL can be the PublishInfo.getPublishUrl() of the published library (for example, https://server/path/lib.json).
    
    If the source content comes from a published library with PublishInfo.getPersistJsonEnabled(), the subscription URL can be a URL pointing to the library JSON file on a datastore or remote file system. The supported formats are:
    
    vSphere 6.5
    - ds:///vmfs/volumes/{uuid}/mylibrary/lib.json (for datastore)
    - nfs://server/path/mylibrary/lib.json (for NFSv3 server on vCenter Server Appliance)
    - nfs://server/path/mylibrary/lib.json?version=4 (for NFSv4 server on vCenter Server Appliance)
    - smb://server/path/mylibrary/lib.json (for SMB server)
    vSphere 6.0
    - file://server/mylibrary/lib.json (for UNC server on vCenter Server for Windows)
    - file:///path/mylibrary/lib.json (for local file system)
    When you specify a DS subscription URL, the datastore must be on the same vCenter Server as the subscribed library. When you specify an NFS or SMB subscription URL, the StorageBacking.getStorageUri() of the subscribed library must be on the same remote file server and should share a common parent path with the subscription URL.
    This property must be provided for the create method. It will always be present in the return value of the get or list methods. It is optional for the update method.
    Returns:
    
    The current value of the property.
  - setSubscriptionUrl
```
public void setSubscriptionUrl(java.net.URI subscriptionUrl)
```
    The URL of the endpoint where the metadata for the remotely published library is being served.
    This URL can be the PublishInfo.getPublishUrl() of the published library (for example, https://server/path/lib.json).
    
    If the source content comes from a published library with PublishInfo.getPersistJsonEnabled(), the subscription URL can be a URL pointing to the library JSON file on a datastore or remote file system. The supported formats are:
    
    vSphere 6.5
    - ds:///vmfs/volumes/{uuid}/mylibrary/lib.json (for datastore)
    - nfs://server/path/mylibrary/lib.json (for NFSv3 server on vCenter Server Appliance)
    - nfs://server/path/mylibrary/lib.json?version=4 (for NFSv4 server on vCenter Server Appliance)
    - smb://server/path/mylibrary/lib.json (for SMB server)
    vSphere 6.0
    - file://server/mylibrary/lib.json (for UNC server on vCenter Server for Windows)
    - file:///path/mylibrary/lib.json (for local file system)
    When you specify a DS subscription URL, the datastore must be on the same vCenter Server as the subscribed library. When you specify an NFS or SMB subscription URL, the StorageBacking.getStorageUri() of the subscribed library must be on the same remote file server and should share a common parent path with the subscription URL.
    This property must be provided for the create method. It will always be present in the return value of the get or list methods. It is optional for the update method.
    Parameters:
    
    subscriptionUrl - New value for the property.
  - getUserName
```
public java.lang.String getUserName()
```
    The username to use when authenticating.
    The username must be set when using a password-based authentication method. Empty strings are allowed for usernames.
    This property is optional for the create method. It is optional in the return value of the get or list methods. It is optional for the update method.
    
    Returns:
    
    The current value of the property.
  - setUserName
```
public void setUserName(java.lang.String userName)
```
    The username to use when authenticating.
    The username must be set when using a password-based authentication method. Empty strings are allowed for usernames.
    This property is optional for the create method. It is optional in the return value of the get or list methods. It is optional for the update method.
    
    Parameters:
    
    userName - New value for the property.
  - getSourceInfo
```
public SourceInfo getSourceInfo()
```
    Information about the source published library. This property will be set for a subscribed library which is associated with a subscription of the published library. This property was added in vSphere API 6.7.2. This property is optional for the create method. It is optional in the return value of the get or list methods. It is optional for the update method.
    
    Returns:
    
    The current value of the property.
  - setSourceInfo
```
public void setSourceInfo(SourceInfo sourceInfo)
```
    Information about the source published library. This property will be set for a subscribed library which is associated with a subscription of the published library. This property was added in vSphere API 6.7.2. This property is optional for the create method. It is optional in the return value of the get or list methods. It is optional for the update method.
    
    Parameters:
    
    sourceInfo - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Description copied from interface: StaticStructure
    
    WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.
    
    Specified by:
    
    _getType in interface StaticStructure
    
    Returns:
    
    the static bindings StructType
  - _getDataValue
```
public StructValue _getDataValue()
```
    Description copied from interface: Structure
    
    Returns this Structure represented in the dynamic DataValue model.
    Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.
    
    Specified by:
    
    _getDataValue in interface Structure
    
    Returns:
    
    StructValue representing this structure
  - _updateDataValue
```
protected void _updateDataValue(StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Description copied from interface: StaticStructure
    
    Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
    More precisely, for each union: given value of the discriminant/tag field (@UnionTag in the IDL) of an union in this structure, validates that:
  - all fields of the union required for that value of the discriminant are set
  - fields of the union that are not allowed for that value of the discriminant are not set
  - any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:: _validate in interface StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:: equals in class java.lang.Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

toString
```
public java.lang.String toString()
```
Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
```
Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.
This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - bindings class for the target structure; must not be null

Returns:

true if this structures type name matches exactly the specified class' type name.

_convertTo
```
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
```
Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             DataValue fieldValue)
```
Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

_getDynamicField
```
public DataValue _getDynamicField(java.lang.String fieldName)
```
Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

_getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:

set of the canonical field names for the dynamic fields

_getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
WARNING: Internal method, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName
```
public java.lang.String _getCanonicalName()
```
Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:

canonical name

_getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance
```
public static SubscriptionInfo _newInstance(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.

Parameters:

structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.

Returns:

the static bindings StructType

_newInstance2
```
public static SubscriptionInfo _newInstance2(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.

Class SubscriptionInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

SubscriptionInfo

SubscriptionInfo

Method Detail

getAuthenticationMethod

setAuthenticationMethod

getAutomaticSyncEnabled

setAutomaticSyncEnabled

getOnDemand

setOnDemand

getPassword

setPassword

getSslThumbprint

setSslThumbprint

getSubscriptionUrl

setSubscriptionUrl

getUserName

setUserName

getSourceInfo

setSourceInfo

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2