com.vmware.nsx_policy.model

Class UAAgentCommonResource.Builder

java.lang.Object

com.vmware.nsx_policy.model.UAAgentCommonResource.Builder

Enclosing class:

UAAgentCommonResource

public static final class UAAgentCommonResource.Builder
extends java.lang.Object

Builder class for UAAgentCommonResource.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of UAAgentCommonResource.

Method Summary

Modifier and Type	Method and Description
UAAgentCommonResource	build()
UAAgentCommonResource.Builder	setAdminAction(java.lang.String adminAction) Possible values are: UAAgentCommonResource.ADMIN_ACTION_ONBOARD UAAgentCommonResource.ADMIN_ACTION_OFFBOARD UAAgentCommonResource.ADMIN_ACTION_FORCE_OFFBOARD Action to perform for northstar agents
UAAgentCommonResource.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
UAAgentCommonResource.Builder	setCorrelationId(java.lang.String correlationId) Unique identifier created by DGS
UAAgentCommonResource.Builder	setCreateTime(java.lang.Long createTime) Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
UAAgentCommonResource.Builder	setCreateUser(java.lang.String createUser) ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
UAAgentCommonResource.Builder	setDescription(java.lang.String description) Description of this resource
UAAgentCommonResource.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
UAAgentCommonResource.Builder	setId(java.lang.String id) Unique identifier of this resource
UAAgentCommonResource.Builder	setInstanceId(java.lang.String instanceId) Id of the NSX SaaS Instance where the site is onboarded.
UAAgentCommonResource.Builder	setLastModifiedTime(java.lang.Long lastModifiedTime) Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
UAAgentCommonResource.Builder	setLastModifiedUser(java.lang.String lastModifiedUser) ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
UAAgentCommonResource.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
UAAgentCommonResource.Builder	setLogLevel(java.lang.String logLevel) Possible values are: UAAgentCommonResource.LOG_LEVEL_INFO UAAgentCommonResource.LOG_LEVEL_DEBUG Configure log level for northstar agents
UAAgentCommonResource.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
UAAgentCommonResource.Builder	setOrgId(java.lang.String orgId) Id of the NSX SaaS Organization where the site is onboarded.
UAAgentCommonResource.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
UAAgentCommonResource.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
UAAgentCommonResource.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
UAAgentCommonResource.Builder	setParentPath(java.lang.String parentPath) Path of its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
UAAgentCommonResource.Builder	setPath(java.lang.String path) Absolute path of this object This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
UAAgentCommonResource.Builder	setProtection(java.lang.String protection) Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
UAAgentCommonResource.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
UAAgentCommonResource.Builder	setReceiverEndpoint(java.lang.String receiverEndpoint) Receiver endpoint used by northstar agents to communicate with the cloud
UAAgentCommonResource.Builder	setRelativePath(java.lang.String relativePath) Path relative from its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
UAAgentCommonResource.Builder	setRemotePath(java.lang.String remotePath) This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.
UAAgentCommonResource.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
UAAgentCommonResource.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
UAAgentCommonResource.Builder	setSchema(java.lang.String schema) Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
UAAgentCommonResource.Builder	setSelf(SelfResourceLink self)
UAAgentCommonResource.Builder	setSystemOwned(java.lang.Boolean systemOwned) Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
UAAgentCommonResource.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
UAAgentCommonResource.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of UAAgentCommonResource.

Method Detail

setLinks

public UAAgentCommonResource.Builder setLinks(java.util.List<ResourceLink> links)

The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

links - New value for the property.

setSchema

public UAAgentCommonResource.Builder setSchema(java.lang.String schema)

Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

schema - New value for the property.

setSelf

public UAAgentCommonResource.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public UAAgentCommonResource.Builder setRevision(java.lang.Long revision)

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32

Parameters:

revision - New value for the property.

setCreateTime

public UAAgentCommonResource.Builder setCreateTime(java.lang.Long createTime)

Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

createTime - New value for the property.

setCreateUser

public UAAgentCommonResource.Builder setCreateUser(java.lang.String createUser)

ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

createUser - New value for the property.

setLastModifiedTime

public UAAgentCommonResource.Builder setLastModifiedTime(java.lang.Long lastModifiedTime)

Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

lastModifiedTime - New value for the property.

setLastModifiedUser

public UAAgentCommonResource.Builder setLastModifiedUser(java.lang.String lastModifiedUser)

ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

lastModifiedUser - New value for the property.

setProtection

public UAAgentCommonResource.Builder setProtection(java.lang.String protection)

Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

protection - New value for the property.

setSystemOwned

public UAAgentCommonResource.Builder setSystemOwned(java.lang.Boolean systemOwned)

Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

systemOwned - New value for the property.

setDescription

public UAAgentCommonResource.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

public UAAgentCommonResource.Builder setDisplayName(java.lang.String displayName)

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

public UAAgentCommonResource.Builder setId(java.lang.String id)

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

public UAAgentCommonResource.Builder setResourceType(java.lang.String resourceType)

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

public UAAgentCommonResource.Builder setTags(java.util.List<Tag> tags)

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public UAAgentCommonResource.Builder setOriginSiteId(java.lang.String originSiteId)

This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

originSiteId - New value for the property.

setOwnerId

public UAAgentCommonResource.Builder setOwnerId(java.lang.String ownerId)

This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

ownerId - New value for the property.

setParentPath

public UAAgentCommonResource.Builder setParentPath(java.lang.String parentPath)

Path of its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

parentPath - New value for the property.

setPath

public UAAgentCommonResource.Builder setPath(java.lang.String path)

Absolute path of this object This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

path - New value for the property.

setRealizationId

public UAAgentCommonResource.Builder setRealizationId(java.lang.String realizationId)

This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated thier unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

realizationId - New value for the property.

setRelativePath

public UAAgentCommonResource.Builder setRelativePath(java.lang.String relativePath)

Path relative from its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

relativePath - New value for the property.

setRemotePath

public UAAgentCommonResource.Builder setRemotePath(java.lang.String remotePath)

This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

remotePath - New value for the property.

setUniqueId

public UAAgentCommonResource.Builder setUniqueId(java.lang.String uniqueId)

This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

uniqueId - New value for the property.

setChildren

public UAAgentCommonResource.Builder setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)

Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.

Parameters:

children - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the property will contain all the properties defined in ChildPolicyConfigResource.

setMarkedForDelete

public UAAgentCommonResource.Builder setMarkedForDelete(java.lang.Boolean markedForDelete)

Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

markedForDelete - New value for the property.

setOverridden

public UAAgentCommonResource.Builder setOverridden(java.lang.Boolean overridden)

Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

overridden - New value for the property.

setAdminAction

public UAAgentCommonResource.Builder setAdminAction(java.lang.String adminAction)

Possible values are:

• UAAgentCommonResource.ADMIN_ACTION_ONBOARD
• UAAgentCommonResource.ADMIN_ACTION_OFFBOARD
• UAAgentCommonResource.ADMIN_ACTION_FORCE_OFFBOARD

Action to perform for northstar agents

Parameters:

adminAction - New value for the property.

setCorrelationId

public UAAgentCommonResource.Builder setCorrelationId(java.lang.String correlationId)

Unique identifier created by DGS

Parameters:

correlationId - New value for the property.

setInstanceId

public UAAgentCommonResource.Builder setInstanceId(java.lang.String instanceId)

Id of the NSX SaaS Instance where the site is onboarded.

Parameters:

instanceId - New value for the property.

setLogLevel

public UAAgentCommonResource.Builder setLogLevel(java.lang.String logLevel)

Possible values are:

• UAAgentCommonResource.LOG_LEVEL_INFO
• UAAgentCommonResource.LOG_LEVEL_DEBUG

Configure log level for northstar agents

Parameters:

logLevel - New value for the property.

setOrgId

public UAAgentCommonResource.Builder setOrgId(java.lang.String orgId)

Id of the NSX SaaS Organization where the site is onboarded.

Parameters:

orgId - New value for the property.

setReceiverEndpoint

public UAAgentCommonResource.Builder setReceiverEndpoint(java.lang.String receiverEndpoint)

Receiver endpoint used by northstar agents to communicate with the cloud

Parameters:

receiverEndpoint - New value for the property.

build

public UAAgentCommonResource build()