com.vmware.nsx.model

Class View.Builder

java.lang.Object

com.vmware.nsx.model.View.Builder

Enclosing class:

View

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

Builder class for View.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
View	build()
View.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.
View.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.
View.Builder	setDescription(java.lang.String description) Description of this resource
View.Builder	setDisplayName(java.lang.String displayName) Title of the widget.
View.Builder	setExcludeRoles(java.lang.String excludeRoles) Comma separated list of roles to which the shared view is not visible.
View.Builder	setId(java.lang.String id) Unique identifier of this resource
View.Builder	setIncludeRoles(java.lang.String includeRoles) Comma separated list of roles to which the shared view is visible.
View.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.
View.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.
View.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
View.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.
View.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
View.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
View.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.
View.Builder	setSelf(SelfResourceLink self)
View.Builder	setShared(java.lang.Boolean shared) Defaults to false.
View.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.
View.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
View.Builder	setWeight(java.lang.Long weight) Determines placement of view relative to other views.
View.Builder	setWidgets(java.util.List<WidgetItem> widgets) Array of widgets that are part of the view.

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 View.

Method Detail

setLinks

public View.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 View.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 View.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public View.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 View.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 View.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 View.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 View.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 View.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 View.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 View.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Title of the widget.

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setExcludeRoles

public View.Builder setExcludeRoles(java.lang.String excludeRoles)

Comma separated list of roles to which the shared view is not visible. Allows user to prevent the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles. If include_roles is specified then exclude_roles cannot be specified.

Parameters:

excludeRoles - New value for the property.

setIncludeRoles

public View.Builder setIncludeRoles(java.lang.String includeRoles)

Comma separated list of roles to which the shared view is visible. Allows user to specify the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles.

Parameters:

includeRoles - New value for the property.

setShared

public View.Builder setShared(java.lang.Boolean shared)

Defaults to false. Set to true to publish the view to other users. The widgets of a shared view are visible to other users.

Parameters:

shared - New value for the property.

setWeight

public View.Builder setWeight(java.lang.Long weight)

Determines placement of view relative to other views. The lower the weight, the higher it is in the placement order. format: int32

Parameters:

weight - New value for the property.

setWidgets

public View.Builder setWidgets(java.util.List<WidgetItem> widgets)

Array of widgets that are part of the view.

Parameters:

widgets - New value for the property.

build

public View build()