com.vmware.nsx_policy.model

Class RealizedFirewallRule.Builder

java.lang.Object

com.vmware.nsx_policy.model.RealizedFirewallRule.Builder

Enclosing class:

RealizedFirewallRule

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

Builder class for RealizedFirewallRule.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
RealizedFirewallRule	build()
RealizedFirewallRule.Builder	setAction(java.lang.String action) Possible values are: RealizedFirewallRule.ACTION_ALLOW RealizedFirewallRule.ACTION_DROP RealizedFirewallRule.ACTION_REJECT Action enforced on the packets which matches the firewall rule.
RealizedFirewallRule.Builder	setAlarms(java.util.List<PolicyAlarmResource> alarms) Alarm info detail
RealizedFirewallRule.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.
RealizedFirewallRule.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.
RealizedFirewallRule.Builder	setDescription(java.lang.String description) Description of this resource
RealizedFirewallRule.Builder	setDestinations(java.util.List<ResourceReference> destinations) List of the destinations.
RealizedFirewallRule.Builder	setDirection(java.lang.String direction) Possible values are: RealizedFirewallRule.DIRECTION_IN RealizedFirewallRule.DIRECTION_OUT RealizedFirewallRule.DIRECTION_IN_OUT Rule direction in case of stateless firewall rules.
RealizedFirewallRule.Builder	setDisabled(java.lang.Boolean disabled) Flag to deactivate rule.
RealizedFirewallRule.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
RealizedFirewallRule.Builder	setId(java.lang.String id) Unique identifier of this resource
RealizedFirewallRule.Builder	setIntentReference(java.util.List<java.lang.String> intentReference) Desire state paths of this object
RealizedFirewallRule.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.
RealizedFirewallRule.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.
RealizedFirewallRule.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
RealizedFirewallRule.Builder	setOperationalStatus(java.lang.String operationalStatus) Possible values could be UP, DOWN, UNKNOWN, FAILURE This list is not exhaustive.
RealizedFirewallRule.Builder	setOperationalStatusError(java.lang.String operationalStatusError) It defines the root cause for operational status error.
RealizedFirewallRule.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
RealizedFirewallRule.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
RealizedFirewallRule.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.
RealizedFirewallRule.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.
RealizedFirewallRule.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.
RealizedFirewallRule.Builder	setPublishStatus(java.lang.String publishStatus) Possible values could be UP, DOWN, UNKNOWN, SUCCESS This list is not exhaustive.
RealizedFirewallRule.Builder	setPublishStatusError(java.lang.String publishStatusError) It defines the root cause for publish status error.
RealizedFirewallRule.Builder	setPublishStatusErrorCode(java.lang.Long publishStatusErrorCode) It defines error code for publish status error.
RealizedFirewallRule.Builder	setPublishStatusErrorDetails(java.util.List<ConfigurationStateElement> publishStatusErrorDetails) Error details for publish status.
RealizedFirewallRule.Builder	setPublishTime(java.lang.Long publishTime) This is the time when our system detects that data has been pushed to the transport nodes.
RealizedFirewallRule.Builder	setRealizationApi(java.lang.String realizationApi) Realization API of this object on enforcement point
RealizedFirewallRule.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
RealizedFirewallRule.Builder	setRealizationSpecificIdentifier(java.lang.String realizationSpecificIdentifier) Realization id of this object
RealizedFirewallRule.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.
RealizedFirewallRule.Builder	setRemotePath(java.lang.String remotePath) This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers.
RealizedFirewallRule.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
RealizedFirewallRule.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
RealizedFirewallRule.Builder	setRuntimeError(java.lang.String runtimeError) It define the root cause for runtime error.
RealizedFirewallRule.Builder	setRuntimeStatus(java.lang.String runtimeStatus) Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive.
RealizedFirewallRule.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.
RealizedFirewallRule.Builder	setSelf(SelfResourceLink self)
RealizedFirewallRule.Builder	setServices(java.util.List<ResourceReference> services) List of the services.
RealizedFirewallRule.Builder	setSources(java.util.List<ResourceReference> sources) List of sources.
RealizedFirewallRule.Builder	setState(java.lang.String state) Possible values are: RealizedFirewallRule.STATE_UNAVAILABLE RealizedFirewallRule.STATE_UNREALIZED RealizedFirewallRule.STATE_REALIZED RealizedFirewallRule.STATE_ERROR Realization state of this object
RealizedFirewallRule.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.
RealizedFirewallRule.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
RealizedFirewallRule.Builder	setTimeTakenForRealization(java.lang.Long timeTakenForRealization) This is an approximate time taken for the realization of the intent to the data path.
RealizedFirewallRule.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities 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 RealizedFirewallRule.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public RealizedFirewallRule.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 NSX+. 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 RealizedFirewallRule.Builder setOwnerId(java.lang.String ownerId)

This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. 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 RealizedFirewallRule.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 RealizedFirewallRule.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 RealizedFirewallRule.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 their 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 RealizedFirewallRule.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 RealizedFirewallRule.Builder setRemotePath(java.lang.String remotePath)

This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ 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 RealizedFirewallRule.Builder setUniqueId(java.lang.String uniqueId)

This is a UUID generated by the GM/LM to uniquely identify entities 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.

setAlarms

public RealizedFirewallRule.Builder setAlarms(java.util.List<PolicyAlarmResource> alarms)

Alarm info detail

Parameters:

alarms - New value for the property.

setIntentReference

public RealizedFirewallRule.Builder setIntentReference(java.util.List<java.lang.String> intentReference)

Desire state paths of this object

Parameters:

intentReference - New value for the property.

setOperationalStatus

public RealizedFirewallRule.Builder setOperationalStatus(java.lang.String operationalStatus)

Possible values could be UP, DOWN, UNKNOWN, FAILURE This list is not exhaustive.

Parameters:

operationalStatus - New value for the property.

setOperationalStatusError

public RealizedFirewallRule.Builder setOperationalStatusError(java.lang.String operationalStatusError)

It defines the root cause for operational status error.

Parameters:

operationalStatusError - New value for the property.

setPublishStatus

public RealizedFirewallRule.Builder setPublishStatus(java.lang.String publishStatus)

Possible values could be UP, DOWN, UNKNOWN, SUCCESS This list is not exhaustive.

Parameters:

publishStatus - New value for the property.

setPublishStatusError

public RealizedFirewallRule.Builder setPublishStatusError(java.lang.String publishStatusError)

It defines the root cause for publish status error.

Parameters:

publishStatusError - New value for the property.

setPublishStatusErrorCode

public RealizedFirewallRule.Builder setPublishStatusErrorCode(java.lang.Long publishStatusErrorCode)

It defines error code for publish status error. format: int32

Parameters:

publishStatusErrorCode - New value for the property.

setPublishStatusErrorDetails

public RealizedFirewallRule.Builder setPublishStatusErrorDetails(java.util.List<ConfigurationStateElement> publishStatusErrorDetails)

Error details for publish status.

Parameters:

publishStatusErrorDetails - New value for the property.

setPublishTime

public RealizedFirewallRule.Builder setPublishTime(java.lang.Long publishTime)

This is the time when our system detects that data has been pushed to the transport nodes. This is based on a poll mechanism and hence this is not the accurate time when the intent was published at the data path. The value of -1 indicates that either the publishing is still in progress or the runtime status is UNKNOWN and hence not available. The Runtime status can be UNKNOWN if one or more hosts are down and the rules could not be sent to those hosts. When the host comes up, the runtime status will change to SUCCESS but the publish_time will show the value of the last realization time. Any new configuration change after this will start reflecting the proper value for publish_time 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:

publishTime - New value for the property.

setRealizationApi

public RealizedFirewallRule.Builder setRealizationApi(java.lang.String realizationApi)

Realization API of this object on enforcement point

Parameters:

realizationApi - New value for the property.

setRealizationSpecificIdentifier

public RealizedFirewallRule.Builder setRealizationSpecificIdentifier(java.lang.String realizationSpecificIdentifier)

Realization id of this object

Parameters:

realizationSpecificIdentifier - New value for the property.

setRuntimeError

public RealizedFirewallRule.Builder setRuntimeError(java.lang.String runtimeError)

It define the root cause for runtime error.

Parameters:

runtimeError - New value for the property.

setRuntimeStatus

public RealizedFirewallRule.Builder setRuntimeStatus(java.lang.String runtimeStatus)

Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive.

Parameters:

runtimeStatus - New value for the property.

setState

public RealizedFirewallRule.Builder setState(java.lang.String state)

Possible values are:

• RealizedFirewallRule.STATE_UNAVAILABLE
• RealizedFirewallRule.STATE_UNREALIZED
• RealizedFirewallRule.STATE_REALIZED
• RealizedFirewallRule.STATE_ERROR

Realization state of this object

Parameters:

state - New value for the property.

setTimeTakenForRealization

public RealizedFirewallRule.Builder setTimeTakenForRealization(java.lang.Long timeTakenForRealization)

This is an approximate time taken for the realization of the intent to the data path. The actual time taken could be lesser than what is reported here. The value of -1 indicates that either the publishing is still in progress or the runtime status is UNKNOWN and hence not available. The Runtime status can be UNKNOWN if one or more hosts are down and the rules could not be sent to those hosts. When the host comes up, the runtime status will change to SUCCESS but the time taken for realization will show the value of the last realization time. Any new configuration change after this will start reflecting the proper value for time_taken_for_realization format: int64

Parameters:

timeTakenForRealization - New value for the property.

setAction

public RealizedFirewallRule.Builder setAction(java.lang.String action)

Possible values are:

• RealizedFirewallRule.ACTION_ALLOW
• RealizedFirewallRule.ACTION_DROP
• RealizedFirewallRule.ACTION_REJECT

Action enforced on the packets which matches the firewall rule. 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:

action - New value for the property.

setDestinations

public RealizedFirewallRule.Builder setDestinations(java.util.List<ResourceReference> destinations)

List of the destinations. Null will be treated as any. 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:

destinations - New value for the property.

setDirection

public RealizedFirewallRule.Builder setDirection(java.lang.String direction)

Possible values are:

• RealizedFirewallRule.DIRECTION_IN
• RealizedFirewallRule.DIRECTION_OUT
• RealizedFirewallRule.DIRECTION_IN_OUT

Rule direction in case of stateless firewall rules. This will only considered if section level parameter is set to stateless. Default to IN_OUT if not specified. 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:

direction - New value for the property.

setDisabled

public RealizedFirewallRule.Builder setDisabled(java.lang.Boolean disabled)

Flag to deactivate rule. Deactivated will only be persisted but never provisioned/realized. 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:

disabled - New value for the property.

setServices

public RealizedFirewallRule.Builder setServices(java.util.List<ResourceReference> services)

List of the services. Null will be treated as any. 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:

services - New value for the property.

setSources

public RealizedFirewallRule.Builder setSources(java.util.List<ResourceReference> sources)

List of sources. Null will be treated as any. 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:

sources - New value for the property.

build

public RealizedFirewallRule build()