public final class SubscriptionInfo
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
SubscriptionInfo
class defines the subscription behavior for a
subscribed library.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 . |
Modifier and Type | Field and Description |
---|---|
protected com.vmware.vapi.data.StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
SubscriptionInfo()
Default constructor.
|
protected |
SubscriptionInfo(com.vmware.vapi.data.StructValue __dynamicStructureFields) |
Modifier and Type | Method and Description |
---|---|
<T extends com.vmware.vapi.bindings.Structure> |
_convertTo(java.lang.Class<T> clazz) |
java.lang.String |
_getCanonicalName() |
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.
|
com.vmware.vapi.data.StructValue |
_getDataValue() |
com.vmware.vapi.data.DataValue |
_getDynamicField(java.lang.String fieldName) |
java.util.Set<java.lang.String> |
_getDynamicFieldNames() |
com.vmware.vapi.bindings.type.StructType |
_getType() |
boolean |
_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz) |
static SubscriptionInfo |
_newInstance(com.vmware.vapi.data.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(com.vmware.vapi.data.StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism. |
void |
_setDynamicField(java.lang.String fieldName,
com.vmware.vapi.data.DataValue fieldValue) |
protected void |
_updateDataValue(com.vmware.vapi.data.StructValue structValue) |
void |
_validate() |
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() |
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
public SubscriptionInfo()
protected SubscriptionInfo(com.vmware.vapi.data.StructValue __dynamicStructureFields)
public SubscriptionInfo.AuthenticationMethod getAuthenticationMethod()
create
method. It will always be
present in the return value of the get
or list
methods. It is
optional for the update
method.public void setAuthenticationMethod(SubscriptionInfo.AuthenticationMethod authenticationMethod)
create
method. It will always be
present in the return value of the get
or list
methods. It is
optional for the update
method.authenticationMethod
- New value for the property.public java.lang.Boolean getAutomaticSyncEnabled()
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, java.lang.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.public void setAutomaticSyncEnabled(java.lang.Boolean automaticSyncEnabled)
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, java.lang.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.automaticSyncEnabled
- New value for the property.public java.lang.Boolean getOnDemand()
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, java.lang.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.
create
method. It will always be
present in the return value of the get
or list
methods. It is
optional for the update
method.public void setOnDemand(java.lang.Boolean onDemand)
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, java.lang.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.
create
method. It will always be
present in the return value of the get
or list
methods. It is
optional for the update
method.onDemand
- New value for the property.public char[] getPassword()
The password must be set when using a password-based authentication method; empty strings are not allowed.
This property is optional for thecreate
method. It will not be present
in the return value of the get
or list
methods. It is optional
for the update
method.public void setPassword(char[] password)
The password must be set when using a password-based authentication method; empty strings are not allowed.
This property is optional for thecreate
method. It will not be present
in the return value of the get
or list
methods. It is optional
for the update
method.password
- New value for the property.public java.lang.String getSslThumbprint()
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
. The
specified sslThumbprint will not be checked for SSL certificate validation if
{SubscriptionInfo#sslCertificate} is also Set
.
create
method. It will not be present
in the return value of the get
or list
methods. It is optional
for the update
method.public void setSslThumbprint(java.lang.String sslThumbprint)
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
. The
specified sslThumbprint will not be checked for SSL certificate validation if
{SubscriptionInfo#sslCertificate} is also Set
.
create
method. It will not be present
in the return value of the get
or list
methods. It is optional
for the update
method.sslThumbprint
- New value for the property.public java.net.URI getSubscriptionUrl()
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
vSphere 6.0
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.
create
method. It will always be
present in the return value of the get
or list
methods. It is
optional for the update
method.public void setSubscriptionUrl(java.net.URI subscriptionUrl)
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
vSphere 6.0
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.
create
method. It will always be
present in the return value of the get
or list
methods. It is
optional for the update
method.subscriptionUrl
- New value for the property.public java.lang.String getUserName()
The username must be set when using a password-based authentication method. Empty strings are allowed for usernames.
This property is optional for thecreate
method. It is optional in the
return value of the get
or list
methods. It is optional for the
update
method.public void setUserName(java.lang.String userName)
The username must be set when using a password-based authentication method. Empty strings are allowed for usernames.
This property is optional for thecreate
method. It is optional in the
return value of the get
or list
methods. It is optional for the
update
method.userName
- New value for the property.public SourceInfo getSourceInfo()
create
method. It is optional in the
return value of the get
or list
methods. It is optional for the
update
method.public void setSourceInfo(SourceInfo sourceInfo)
create
method. It is optional in the
return value of the get
or list
methods. It is optional for the
update
method.sourceInfo
- New value for the property.public com.vmware.vapi.bindings.type.StructType _getType()
_getType
in interface com.vmware.vapi.bindings.StaticStructure
public com.vmware.vapi.data.StructValue _getDataValue()
_getDataValue
in interface com.vmware.vapi.bindings.Structure
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
public void _validate()
_validate
in interface com.vmware.vapi.bindings.StaticStructure
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in interface com.vmware.vapi.bindings.StaticStructure
toString
in class java.lang.Object
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
_hasTypeNameOf
in interface com.vmware.vapi.bindings.Structure
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
_convertTo
in interface com.vmware.vapi.bindings.Structure
public void _setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
_setDynamicField
in interface com.vmware.vapi.bindings.StaticStructure
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
_getDynamicField
in interface com.vmware.vapi.bindings.StaticStructure
public java.util.Set<java.lang.String> _getDynamicFieldNames()
_getDynamicFieldNames
in interface com.vmware.vapi.bindings.StaticStructure
public static com.vmware.vapi.bindings.type.StructType _getClassType()
StructType
instance representing the static bindings
type for this Structure
.public java.lang.String _getCanonicalName()
_getCanonicalName
in interface com.vmware.vapi.bindings.Structure
public static java.lang.String _getCanonicalTypeName()
_getCanonicalName()
.public static SubscriptionInfo _newInstance(com.vmware.vapi.data.StructValue structValue)
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.StructType
public static SubscriptionInfo _newInstance2(com.vmware.vapi.data.StructValue structValue)