com.vmware.nsx_policy.model

Class IdsPcapFileMetadata.Builder

java.lang.Object

com.vmware.nsx_policy.model.IdsPcapFileMetadata.Builder

Enclosing class:

IdsPcapFileMetadata

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

Builder class for IdsPcapFileMetadata.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
IdsPcapFileMetadata	build()
IdsPcapFileMetadata.Builder	setAvailableUntil(java.lang.String availableUntil) Time until which the file will be avilable for download.
IdsPcapFileMetadata.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
IdsPcapFileMetadata.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.
IdsPcapFileMetadata.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.
IdsPcapFileMetadata.Builder	setDescription(java.lang.String description) Description of this resource
IdsPcapFileMetadata.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
IdsPcapFileMetadata.Builder	setExportedOn(java.lang.String exportedOn) Time when the file extraction started.
IdsPcapFileMetadata.Builder	setFailureCause(java.lang.String failureCause) If creation of zipped pcap file fails then this will tell the failure cause.
IdsPcapFileMetadata.Builder	setFileName(java.lang.String fileName) Name of the Pcap File requested by the user.
IdsPcapFileMetadata.Builder	setFileSize(java.lang.Long fileSize) Tells the size of the zipped pcap file.
IdsPcapFileMetadata.Builder	setId(java.lang.String id) Unique identifier of this resource
IdsPcapFileMetadata.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.
IdsPcapFileMetadata.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.
IdsPcapFileMetadata.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
IdsPcapFileMetadata.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
IdsPcapFileMetadata.Builder	setNodeId(java.lang.String nodeId) Node wher file extraction is triggered.
IdsPcapFileMetadata.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
IdsPcapFileMetadata.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
IdsPcapFileMetadata.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
IdsPcapFileMetadata.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.
IdsPcapFileMetadata.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.
IdsPcapFileMetadata.Builder	setPcapIds(java.util.List<java.lang.String> pcapIds) List of all pcap ids which are requested by the user as part of this File.
IdsPcapFileMetadata.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.
IdsPcapFileMetadata.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
IdsPcapFileMetadata.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.
IdsPcapFileMetadata.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.
IdsPcapFileMetadata.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
IdsPcapFileMetadata.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
IdsPcapFileMetadata.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.
IdsPcapFileMetadata.Builder	setSelf(SelfResourceLink self)
IdsPcapFileMetadata.Builder	setSignatureIds(java.util.List<java.lang.String> signatureIds) List of all signature ids which are part of the events whose pcap files is selected by the user as part of this File.
IdsPcapFileMetadata.Builder	setStatus(java.lang.String status) Possible values are: IdsPcapFileMetadata.STATUS_READY IdsPcapFileMetadata.STATUS_IN_PROGRESS IdsPcapFileMetadata.STATUS_FAILED IdsPcapFileMetadata.STATUS_INCOMPLETE READY means zipped pcap file is succesfully created and ready to download.
IdsPcapFileMetadata.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.
IdsPcapFileMetadata.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
IdsPcapFileMetadata.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 IdsPcapFileMetadata.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public IdsPcapFileMetadata.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 IdsPcapFileMetadata.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 IdsPcapFileMetadata.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 IdsPcapFileMetadata.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 IdsPcapFileMetadata.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 IdsPcapFileMetadata.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 IdsPcapFileMetadata.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 IdsPcapFileMetadata.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.

setChildren

public IdsPcapFileMetadata.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 IdsPcapFileMetadata.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 IdsPcapFileMetadata.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.

setAvailableUntil

public IdsPcapFileMetadata.Builder setAvailableUntil(java.lang.String availableUntil)

Time until which the file will be avilable for download. 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:

availableUntil - New value for the property.

setExportedOn

public IdsPcapFileMetadata.Builder setExportedOn(java.lang.String exportedOn)

Time when the file extraction started. 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:

exportedOn - New value for the property.

setFailureCause

public IdsPcapFileMetadata.Builder setFailureCause(java.lang.String failureCause)

If creation of zipped pcap file fails then this will tell the failure cause. 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:

failureCause - New value for the property.

setFileName

public IdsPcapFileMetadata.Builder setFileName(java.lang.String fileName)

Name of the Pcap File requested by the user.

Parameters:

fileName - New value for the property.

setFileSize

public IdsPcapFileMetadata.Builder setFileSize(java.lang.Long fileSize)

Tells the size of the zipped pcap file. 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:

fileSize - New value for the property.

setNodeId

public IdsPcapFileMetadata.Builder setNodeId(java.lang.String nodeId)

Node wher file extraction is triggered. 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:

nodeId - New value for the property.

setPcapIds

public IdsPcapFileMetadata.Builder setPcapIds(java.util.List<java.lang.String> pcapIds)

List of all pcap ids which are requested by the user as part of this File.

Parameters:

pcapIds - New value for the property.

setSignatureIds

public IdsPcapFileMetadata.Builder setSignatureIds(java.util.List<java.lang.String> signatureIds)

List of all signature ids which are part of the events whose pcap files is selected by the user as part of this File.

Parameters:

signatureIds - New value for the property.

setStatus

public IdsPcapFileMetadata.Builder setStatus(java.lang.String status)

Possible values are:

• IdsPcapFileMetadata.STATUS_READY
• IdsPcapFileMetadata.STATUS_IN_PROGRESS
• IdsPcapFileMetadata.STATUS_FAILED
• IdsPcapFileMetadata.STATUS_INCOMPLETE

READY means zipped pcap file is succesfully created and ready to download. IN_PROGRESS means creation of zipped pcap file is in progress. FAILED means some error occurred during creation of zipped pcap file. INCOMPLETE means zipped pcap file doea not have all the specified pcaps. 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:

status - New value for the property.

build

public IdsPcapFileMetadata build()