Agent (VMware-vmc-SDK-Java)

java.lang.Object
- com.vmware.vmc.model.Agent

All Implemented Interfaces:: StaticStructure, Structure, java.io.Serializable

public final class Agent
extends java.lang.Object
implements java.io.Serializable, StaticStructure

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Agent.Builder
Builder class for Agent.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Agent.Builder` Builder class for `Agent`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`_TYPE_IDENTIFIER` Identifier denoting this class, when it is used in polymorphic context.
`static java.lang.String`	`AGENT_STATE_CUSTOMIZING`
`static java.lang.String`	`AGENT_STATE_DELETED`
`static java.lang.String`	`AGENT_STATE_DELETING`
`static java.lang.String`	`AGENT_STATE_DEPLOYING`
`static java.lang.String`	`AGENT_STATE_FAILED`
`static java.lang.String`	`AGENT_STATE_NOT_READY`
`static java.lang.String`	`AGENT_STATE_READY`

Constructor Summary

Constructors
Modifier Constructor and Description

Agent()
Default constructor.

protected Agent(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`Agent()` Default constructor.
`protected`	`Agent(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 a dynamic field value, doesn't allow access to static fields (which have getters/setters).
`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 Agent`	`_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 Agent`	`_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)`
`java.util.List<java.lang.String>`	`getAddresses()` The addresses of the agent including its public IP and DNS names.
`java.lang.String`	`getAgentState()` Possible values are: `AGENT_STATE_NOT_READY` `AGENT_STATE_DEPLOYING` `AGENT_STATE_CUSTOMIZING` `AGENT_STATE_READY` `AGENT_STATE_DELETING` `AGENT_STATE_DELETED` `AGENT_STATE_FAILED` Agent state
`java.lang.String`	`getAgentUrl()` The accessible URL of the agent service, it is resolved to public IP address from the Internet and private IP address within SDDC
`java.lang.Boolean`	`getCertEnabled()` Boolean flag to indicate if the agent is using CA signed certificate
`java.util.Map<java.lang.String,java.lang.String>`	`getCustomProperties()`
`java.lang.Boolean`	`getHealthy()` Boolean flag to indicate if the agent is healthy.
`java.lang.Boolean`	`getHostnameVerifierEnabled()` Boolean flag to indicate if the agent is using FQDN in the certificate
`java.lang.String`	`getId()` The agent id
`java.lang.String`	`getInternalIp()` The internal IP address of the agent which is provided by the underlying cloud provider
`java.lang.String`	`getManagementIp()` The internal management IP address of the agent exposed to the SDDC, which might be different from the internal IP
`java.lang.Boolean`	`getMaster()` Boolean flag to indicate if the agent is the master, only the master Agent is accessible
`java.lang.String`	`getNetworkCidr()` Network CIDR of the agent
`java.lang.String`	`getNetworkGateway()` Network gateway of the agent
`java.lang.String`	`getNetworkNetmask()` Network netmask of the agent
`java.lang.String`	`getProvider()` The cloud provider The value of this property is automatically populated to `"Agent"`.
`AgentCspOauthClient`	`getSddcCspOauthClient()` CSP Oauth client credentials to access information from POP.
`TenantServiceInfo`	`getTenantServiceInfo()` Tenant service information that we will save as a part of agent data.
`java.util.List<java.lang.String>`	`getTinyproxyWhitelist()` The list of white listed domains of the HTTP proxy.
`int`	`hashCode()`
`void`	`setAddresses(java.util.List<java.lang.String> addresses)` The addresses of the agent including its public IP and DNS names.
`void`	`setAgentState(java.lang.String agentState)` Possible values are: `AGENT_STATE_NOT_READY` `AGENT_STATE_DEPLOYING` `AGENT_STATE_CUSTOMIZING` `AGENT_STATE_READY` `AGENT_STATE_DELETING` `AGENT_STATE_DELETED` `AGENT_STATE_FAILED` Agent state
`void`	`setAgentUrl(java.lang.String agentUrl)` The accessible URL of the agent service, it is resolved to public IP address from the Internet and private IP address within SDDC
`void`	`setCertEnabled(java.lang.Boolean certEnabled)` Boolean flag to indicate if the agent is using CA signed certificate
`void`	`setCustomProperties(java.util.Map<java.lang.String,java.lang.String> customProperties)`
`void`	`setHealthy(java.lang.Boolean healthy)` Boolean flag to indicate if the agent is healthy.
`void`	`setHostnameVerifierEnabled(java.lang.Boolean hostnameVerifierEnabled)` Boolean flag to indicate if the agent is using FQDN in the certificate
`void`	`setId(java.lang.String id)` The agent id
`void`	`setInternalIp(java.lang.String internalIp)` The internal IP address of the agent which is provided by the underlying cloud provider
`void`	`setManagementIp(java.lang.String managementIp)` The internal management IP address of the agent exposed to the SDDC, which might be different from the internal IP
`void`	`setMaster(java.lang.Boolean master)` Boolean flag to indicate if the agent is the master, only the master Agent is accessible
`void`	`setNetworkCidr(java.lang.String networkCidr)` Network CIDR of the agent
`void`	`setNetworkGateway(java.lang.String networkGateway)` Network gateway of the agent
`void`	`setNetworkNetmask(java.lang.String networkNetmask)` Network netmask of the agent
`void`	`setSddcCspOauthClient(AgentCspOauthClient sddcCspOauthClient)` CSP Oauth client credentials to access information from POP.
`void`	`setTenantServiceInfo(TenantServiceInfo tenantServiceInfo)` Tenant service information that we will save as a part of agent data.
`void`	`setTinyproxyWhitelist(java.util.List<java.lang.String> tinyproxyWhitelist)` The list of white listed domains of the HTTP proxy.
`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
  - _TYPE_IDENTIFIER
```
public static final java.lang.String _TYPE_IDENTIFIER
```
    Identifier denoting this class, when it is used in polymorphic context.
    This value should be assigned to the property which is used to discriminate the actual type used in the polymorphic context.
    
    See Also:
    
    Constant Field Values
  - AGENT_STATE_NOT_READY
```
public static final java.lang.String AGENT_STATE_NOT_READY
```
    See Also:
    
    Constant Field Values
  - AGENT_STATE_DEPLOYING
```
public static final java.lang.String AGENT_STATE_DEPLOYING
```
    See Also:
    
    Constant Field Values
  - AGENT_STATE_CUSTOMIZING
```
public static final java.lang.String AGENT_STATE_CUSTOMIZING
```
    See Also:
    
    Constant Field Values
  - AGENT_STATE_READY
```
public static final java.lang.String AGENT_STATE_READY
```
    See Also:
    
    Constant Field Values
  - AGENT_STATE_DELETING
```
public static final java.lang.String AGENT_STATE_DELETING
```
    See Also:
    
    Constant Field Values
  - AGENT_STATE_DELETED
```
public static final java.lang.String AGENT_STATE_DELETED
```
    See Also:
    
    Constant Field Values
  - AGENT_STATE_FAILED
```
public static final java.lang.String AGENT_STATE_FAILED
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected StructValue __dynamicStructureFields
```
- Constructor Detail
  - Agent
```
public Agent()
```
    Default constructor.
  - Agent
```
protected Agent(StructValue __dynamicStructureFields)
```
- Method Detail
  - getSddcCspOauthClient
```
public AgentCspOauthClient getSddcCspOauthClient()
```
    CSP Oauth client credentials to access information from POP.
    
    Returns:
    
    The current value of the property.
  - setSddcCspOauthClient
```
public void setSddcCspOauthClient(AgentCspOauthClient sddcCspOauthClient)
```
    CSP Oauth client credentials to access information from POP.
    
    Parameters:
    
    sddcCspOauthClient - New value for the property.
  - getAddresses
```
public java.util.List<java.lang.String> getAddresses()
```
    The addresses of the agent including its public IP and DNS names.
    
    Returns:
    
    The current value of the property.
  - setAddresses
```
public void setAddresses(java.util.List<java.lang.String> addresses)
```
    The addresses of the agent including its public IP and DNS names.
    
    Parameters:
    
    addresses - New value for the property.
  - getInternalIp
```
public java.lang.String getInternalIp()
```
    The internal IP address of the agent which is provided by the underlying cloud provider
    
    Returns:
    
    The current value of the property.
  - setInternalIp
```
public void setInternalIp(java.lang.String internalIp)
```
    The internal IP address of the agent which is provided by the underlying cloud provider
    
    Parameters:
    
    internalIp - New value for the property.
  - getHostnameVerifierEnabled
```
public java.lang.Boolean getHostnameVerifierEnabled()
```
    Boolean flag to indicate if the agent is using FQDN in the certificate
    
    Returns:
    
    The current value of the property.
  - setHostnameVerifierEnabled
```
public void setHostnameVerifierEnabled(java.lang.Boolean hostnameVerifierEnabled)
```
    Boolean flag to indicate if the agent is using FQDN in the certificate
    
    Parameters:
    
    hostnameVerifierEnabled - New value for the property.
  - getCertEnabled
```
public java.lang.Boolean getCertEnabled()
```
    Boolean flag to indicate if the agent is using CA signed certificate
    
    Returns:
    
    The current value of the property.
  - setCertEnabled
```
public void setCertEnabled(java.lang.Boolean certEnabled)
```
    Boolean flag to indicate if the agent is using CA signed certificate
    
    Parameters:
    
    certEnabled - New value for the property.
  - getNetworkCidr
```
public java.lang.String getNetworkCidr()
```
    Network CIDR of the agent
    
    Returns:
    
    The current value of the property.
  - setNetworkCidr
```
public void setNetworkCidr(java.lang.String networkCidr)
```
    Network CIDR of the agent
    
    Parameters:
    
    networkCidr - New value for the property.
  - getId
```
public java.lang.String getId()
```
    The agent id
    
    Returns:
    
    The current value of the property.
  - setId
```
public void setId(java.lang.String id)
```
    The agent id
    
    Parameters:
    
    id - New value for the property.
  - getTenantServiceInfo
```
public TenantServiceInfo getTenantServiceInfo()
```
    Tenant service information that we will save as a part of agent data.
    
    Returns:
    
    The current value of the property.
  - setTenantServiceInfo
```
public void setTenantServiceInfo(TenantServiceInfo tenantServiceInfo)
```
    Tenant service information that we will save as a part of agent data.
    
    Parameters:
    
    tenantServiceInfo - New value for the property.
  - getTinyproxyWhitelist
```
public java.util.List<java.lang.String> getTinyproxyWhitelist()
```
    The list of white listed domains of the HTTP proxy.
    
    Returns:
    
    The current value of the property.
  - setTinyproxyWhitelist
```
public void setTinyproxyWhitelist(java.util.List<java.lang.String> tinyproxyWhitelist)
```
    The list of white listed domains of the HTTP proxy.
    
    Parameters:
    
    tinyproxyWhitelist - New value for the property.
  - getHealthy
```
public java.lang.Boolean getHealthy()
```
    Boolean flag to indicate if the agent is healthy.
    
    Returns:
    
    The current value of the property.
  - setHealthy
```
public void setHealthy(java.lang.Boolean healthy)
```
    Boolean flag to indicate if the agent is healthy.
    
    Parameters:
    
    healthy - New value for the property.
  - getCustomProperties
```
public java.util.Map<java.lang.String,java.lang.String> getCustomProperties()
```
    Returns:
    
    The current value of the property.
  - setCustomProperties
```
public void setCustomProperties(java.util.Map<java.lang.String,java.lang.String> customProperties)
```
    Parameters:
    
    customProperties - New value for the property.
  - getManagementIp
```
public java.lang.String getManagementIp()
```
    The internal management IP address of the agent exposed to the SDDC, which might be different from the internal IP
    
    Returns:
    
    The current value of the property.
  - setManagementIp
```
public void setManagementIp(java.lang.String managementIp)
```
    The internal management IP address of the agent exposed to the SDDC, which might be different from the internal IP
    
    Parameters:
    
    managementIp - New value for the property.
  - getMaster
```
public java.lang.Boolean getMaster()
```
    Boolean flag to indicate if the agent is the master, only the master Agent is accessible
    
    Returns:
    
    The current value of the property.
  - setMaster
```
public void setMaster(java.lang.Boolean master)
```
    Boolean flag to indicate if the agent is the master, only the master Agent is accessible
    
    Parameters:
    
    master - New value for the property.
  - getNetworkNetmask
```
public java.lang.String getNetworkNetmask()
```
    Network netmask of the agent
    
    Returns:
    
    The current value of the property.
  - setNetworkNetmask
```
public void setNetworkNetmask(java.lang.String networkNetmask)
```
    Network netmask of the agent
    
    Parameters:
    
    networkNetmask - New value for the property.
  - getNetworkGateway
```
public java.lang.String getNetworkGateway()
```
    Network gateway of the agent
    
    Returns:
    
    The current value of the property.
  - setNetworkGateway
```
public void setNetworkGateway(java.lang.String networkGateway)
```
    Network gateway of the agent
    
    Parameters:
    
    networkGateway - New value for the property.
  - getProvider
```
public java.lang.String getProvider()
```
    The cloud provider The value of this property is automatically populated to "Agent".
    
    Returns:
    
    The current value of the property.
  - getAgentUrl
```
public java.lang.String getAgentUrl()
```
    The accessible URL of the agent service, it is resolved to public IP address from the Internet and private IP address within SDDC
    
    Returns:
    
    The current value of the property.
  - setAgentUrl
```
public void setAgentUrl(java.lang.String agentUrl)
```
    The accessible URL of the agent service, it is resolved to public IP address from the Internet and private IP address within SDDC
    
    Parameters:
    
    agentUrl - New value for the property.
  - getAgentState
```
public java.lang.String getAgentState()
```
    Possible values are:
    Agent state
    Returns:
    
    The current value of the property.
  - setAgentState
```
public void setAgentState(java.lang.String agentState)
```
    Possible values are:
    Agent state
    Parameters:
    
    agentState - 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 structure definition, i.e. not represented with getter/setter.

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 a dynamic field value, doesn't allow access to static fields (which have getters/setters).

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 Agent _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 Agent _newInstance2(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.

Class Agent

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_TYPE_IDENTIFIER

AGENT_STATE_NOT_READY

AGENT_STATE_DEPLOYING

AGENT_STATE_CUSTOMIZING

AGENT_STATE_READY

AGENT_STATE_DELETING

AGENT_STATE_DELETED

AGENT_STATE_FAILED

__dynamicStructureFields

Constructor Detail

Agent

Agent

Method Detail

getSddcCspOauthClient

setSddcCspOauthClient

getAddresses

setAddresses

getInternalIp

setInternalIp

getHostnameVerifierEnabled

setHostnameVerifierEnabled

getCertEnabled

setCertEnabled

getNetworkCidr

setNetworkCidr

getId

setId

getTenantServiceInfo

setTenantServiceInfo

getTinyproxyWhitelist

setTinyproxyWhitelist

getHealthy

setHealthy

getCustomProperties

setCustomProperties

getManagementIp

setManagementIp

getMaster

setMaster

getNetworkNetmask

setNetworkNetmask

getNetworkGateway

setNetworkGateway

getProvider

getAgentUrl

setAgentUrl

getAgentState

setAgentState

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2