PublishInfo

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class PublishInfo
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The PublishInfo class defines how a local library is published publicly for synchronization to other libraries.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PublishInfo.AuthenticationMethod` The `AuthenticationMethod` enumeration class indicates how a subscribed library should authenticate to the published library endpoint.
`static class`	`PublishInfo.Builder` Builder class for `PublishInfo`.

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

PublishInfo()
Default constructor.

protected PublishInfo(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`PublishInfo()` Default constructor.
`protected`	`PublishInfo(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_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 PublishInfo`	`_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 PublishInfo`	`_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)`
`PublishInfo.AuthenticationMethod`	`getAuthenticationMethod()` Indicates how a subscribed library should authenticate (BASIC, NONE) to the published library endpoint.
`char[]`	`getCurrentPassword()` The current password to verify.
`char[]`	`getPassword()` The new password to require for authentication.
`java.lang.Boolean`	`getPersistJsonEnabled()` Whether library and library item metadata are persisted in the storage backing as JSON files.
`java.lang.Boolean`	`getPublished()` Whether the local library is published.
`java.net.URI`	`getPublishUrl()` The URL to which the library metadata is published by the Content Library Service.
`java.lang.String`	`getUserName()` The username to require for authentication.
`int`	`hashCode()`
`void`	`setAuthenticationMethod(PublishInfo.AuthenticationMethod authenticationMethod)` Indicates how a subscribed library should authenticate (BASIC, NONE) to the published library endpoint.
`void`	`setCurrentPassword(char[] currentPassword)` The current password to verify.
`void`	`setPassword(char[] password)` The new password to require for authentication.
`void`	`setPersistJsonEnabled(java.lang.Boolean persistJsonEnabled)` Whether library and library item metadata are persisted in the storage backing as JSON files.
`void`	`setPublished(java.lang.Boolean published)` Whether the local library is published.
`void`	`setPublishUrl(java.net.URI publishUrl)` The URL to which the library metadata is published by the Content Library Service.
`void`	`setUserName(java.lang.String userName)` The username to require for authentication.
`java.lang.String`	`toString()`

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

- Field Detail
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - PublishInfo
```
public PublishInfo()
```
    Default constructor.
  - PublishInfo
```
protected PublishInfo(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAuthenticationMethod
```
public PublishInfo.AuthenticationMethod getAuthenticationMethod()
```
    Indicates how a subscribed library should authenticate (BASIC, NONE) to the published library endpoint. This property is required for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) method. It is optional for the LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) operation, and if null the value will not be changed. When the existing authentication method is PublishInfo.AuthenticationMethod.BASIC and authentication is being turned off by updating this property to PublishInfo.AuthenticationMethod.NONE, then the getCurrentPassword() property is required. This property will always be present in the results of the LocalLibrary.get(java.lang.String) method.
    
    Returns:
    
    The current value of the property.
  - setAuthenticationMethod
```
public void setAuthenticationMethod(PublishInfo.AuthenticationMethod authenticationMethod)
```
    Indicates how a subscribed library should authenticate (BASIC, NONE) to the published library endpoint. This property is required for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) method. It is optional for the LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) operation, and if null the value will not be changed. When the existing authentication method is PublishInfo.AuthenticationMethod.BASIC and authentication is being turned off by updating this property to PublishInfo.AuthenticationMethod.NONE, then the getCurrentPassword() property is required. This property will always be present in the results of the LocalLibrary.get(java.lang.String) method.
    
    Parameters:
    
    authenticationMethod - New value for the property.
  - getPublished
```
public java.lang.Boolean getPublished()
```
    Whether the local library is published. This property is required for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) method. It is optional for the LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) operation, and if null the value will not be changed. When the existing authentication method is PublishInfo.AuthenticationMethod.BASIC and the local library is published, the getCurrentPassword() property is required before turning off publishing. This property will always be present in the results of the LocalLibrary.get(java.lang.String) method.
    
    Returns:
    
    The current value of the property.
  - setPublished
```
public void setPublished(java.lang.Boolean published)
```
    Whether the local library is published. This property is required for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) method. It is optional for the LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) operation, and if null the value will not be changed. When the existing authentication method is PublishInfo.AuthenticationMethod.BASIC and the local library is published, the getCurrentPassword() property is required before turning off publishing. This property will always be present in the results of the LocalLibrary.get(java.lang.String) method.
    
    Parameters:
    
    published - New value for the property.
  - getPublishUrl
```
public java.net.URI getPublishUrl()
```
    The URL to which the library metadata is published by the Content Library Service.
    This value can be used to set the SubscriptionInfo.getSubscriptionUrl() property when creating a subscribed library.
    This property is not used for the create method. It will always be present in the return value of the get or list methods. It is not used for the update method.
    
    Returns:
    
    The current value of the property.
  - setPublishUrl
```
public void setPublishUrl(java.net.URI publishUrl)
```
    The URL to which the library metadata is published by the Content Library Service.
    This value can be used to set the SubscriptionInfo.getSubscriptionUrl() property when creating a subscribed library.
    This property is not used for the create method. It will always be present in the return value of the get or list methods. It is not used for the update method.
    
    Parameters:
    
    publishUrl - New value for the property.
  - getUserName
```
public java.lang.String getUserName()
```
    The username to require for authentication. This property is optional for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) and LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) methods. When the authentication method is PublishInfo.AuthenticationMethod.NONE, the username can be left null. When the authentication method is PublishInfo.AuthenticationMethod.BASIC, the username is ignored in the current release. It defaults to "vcsp". It is preferable to leave this null. If specified, it must be set to "vcsp".
    
    Returns:
    
    The current value of the property.
  - setUserName
```
public void setUserName(java.lang.String userName)
```
    The username to require for authentication. This property is optional for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) and LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) methods. When the authentication method is PublishInfo.AuthenticationMethod.NONE, the username can be left null. When the authentication method is PublishInfo.AuthenticationMethod.BASIC, the username is ignored in the current release. It defaults to "vcsp". It is preferable to leave this null. If specified, it must be set to "vcsp".
    
    Parameters:
    
    userName - New value for the property.
  - getPassword
```
public char[] getPassword()
```
    The new password to require for authentication. This property is optional for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) method. When the authentication method is PublishInfo.AuthenticationMethod.NONE, the password can be left null. When the authentication method is PublishInfo.AuthenticationMethod.BASIC, the password should be a non-empty string. This property is optional for the LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) method. Leaving it null during update indicates that the password is not changed. When the password is changed, the getCurrentPassword() property is required. This property is not used for the LocalLibrary.get(java.lang.String) method.
    
    Returns:
    
    The current value of the property.
  - setPassword
```
public void setPassword(char[] password)
```
    The new password to require for authentication. This property is optional for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) method. When the authentication method is PublishInfo.AuthenticationMethod.NONE, the password can be left null. When the authentication method is PublishInfo.AuthenticationMethod.BASIC, the password should be a non-empty string. This property is optional for the LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) method. Leaving it null during update indicates that the password is not changed. When the password is changed, the getCurrentPassword() property is required. This property is not used for the LocalLibrary.get(java.lang.String) method.
    
    Parameters:
    
    password - New value for the property.
  - getCurrentPassword
```
public char[] getCurrentPassword()
```
    The current password to verify. This property is available starting in vSphere 6.7. This property is unused for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) method. This property is optional for the LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) method. When the existing authentication method is PublishInfo.AuthenticationMethod.NONE, the current password can be left null. When the existing authentication method is PublishInfo.AuthenticationMethod.BASIC, the current password is verified before applying the new getPassword(), turning off authentication, or unpublishing the library. This property is not used for the LocalLibrary.get(java.lang.String) method.
    
    Returns:
    
    The current value of the property.
  - setCurrentPassword
```
public void setCurrentPassword(char[] currentPassword)
```
    The current password to verify. This property is available starting in vSphere 6.7. This property is unused for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) method. This property is optional for the LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) method. When the existing authentication method is PublishInfo.AuthenticationMethod.NONE, the current password can be left null. When the existing authentication method is PublishInfo.AuthenticationMethod.BASIC, the current password is verified before applying the new getPassword(), turning off authentication, or unpublishing the library. This property is not used for the LocalLibrary.get(java.lang.String) method.
    
    Parameters:
    
    currentPassword - New value for the property.
  - getPersistJsonEnabled
```
public java.lang.Boolean getPersistJsonEnabled()
```
    Whether library and library item metadata are persisted in the storage backing as JSON files. This flag only applies if the local library is published.
    Enabling JSON persistence allows you to synchronize a subscribed library manually instead of over HTTP. You copy the local library content and metadata to another storage backing manually and then create a subscribed library referencing the location of the library JSON file in the SubscriptionInfo.getSubscriptionUrl(). When the subscribed library's storage backing matches the subscription URL, files do not need to be copied to the subscribed library.
    
    For a library backed by a datastore, the library JSON file will be stored at the path contentlib-{library_id}/lib.json on the datastore.
    
    For a library backed by a remote file system, the library JSON file will be stored at {library_id}/lib.json in the remote file system path.
    This property is optional 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.
  - setPersistJsonEnabled
```
public void setPersistJsonEnabled(java.lang.Boolean persistJsonEnabled)
```
    Whether library and library item metadata are persisted in the storage backing as JSON files. This flag only applies if the local library is published.
    Enabling JSON persistence allows you to synchronize a subscribed library manually instead of over HTTP. You copy the local library content and metadata to another storage backing manually and then create a subscribed library referencing the location of the library JSON file in the SubscriptionInfo.getSubscriptionUrl(). When the subscribed library's storage backing matches the subscription URL, files do not need to be copied to the subscribed library.
    
    For a library backed by a datastore, the library JSON file will be stored at the path contentlib-{library_id}/lib.json on the datastore.
    
    For a library backed by a remote file system, the library JSON file will be stored at {library_id}/lib.json in the remote file system path.
    This property is optional 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:
    
    persistJsonEnabled - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.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()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _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()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static PublishInfo _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.
    
    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 PublishInfo _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class PublishInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

PublishInfo

PublishInfo

Method Detail

getAuthenticationMethod

setAuthenticationMethod

getPublished

setPublished

getPublishUrl

setPublishUrl

getUserName

setUserName

getPassword

setPassword

getCurrentPassword

setCurrentPassword

getPersistJsonEnabled

setPersistJsonEnabled

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2