Class PostureDeployment (0.20.0) 

public final class PostureDeployment extends GeneratedMessageV3 implements PostureDeploymentOrBuilder

===

PostureDeployments

=== Message describing PostureDeployment resource.

Protobuf type google.cloud.securityposture.v1.PostureDeployment

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PostureDeployment

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DESIRED_POSTURE_ID_FIELD_NUMBER

public static final int DESIRED_POSTURE_ID_FIELD_NUMBER
Field Value
Type Description
int

DESIRED_POSTURE_REVISION_ID_FIELD_NUMBER

public static final int DESIRED_POSTURE_REVISION_ID_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

FAILURE_MESSAGE_FIELD_NUMBER

public static final int FAILURE_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

POSTURE_ID_FIELD_NUMBER

public static final int POSTURE_ID_FIELD_NUMBER
Field Value
Type Description
int

POSTURE_REVISION_ID_FIELD_NUMBER

public static final int POSTURE_REVISION_ID_FIELD_NUMBER
Field Value
Type Description
int

RECONCILING_FIELD_NUMBER

public static final int RECONCILING_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TARGET_RESOURCE_FIELD_NUMBER

public static final int TARGET_RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PostureDeployment getDefaultInstance()
Returns
Type Description
PostureDeployment

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PostureDeployment.Builder newBuilder()
Returns
Type Description
PostureDeployment.Builder

newBuilder(PostureDeployment prototype)

public static PostureDeployment.Builder newBuilder(PostureDeployment prototype)
Parameter
Name Description
prototype PostureDeployment
Returns
Type Description
PostureDeployment.Builder

parseDelimitedFrom(InputStream input)

public static PostureDeployment parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PostureDeployment
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PostureDeployment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PostureDeployment
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PostureDeployment parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PostureDeployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PostureDeployment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PostureDeployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PostureDeployment parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PostureDeployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PostureDeployment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PostureDeployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PostureDeployment parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PostureDeployment
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PostureDeployment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PostureDeployment
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PostureDeployment parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PostureDeployment
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PostureDeployment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PostureDeployment
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PostureDeployment parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PostureDeployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PostureDeployment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PostureDeployment
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PostureDeployment> parser()
Returns
Type Description
Parser<PostureDeployment>

Methods

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Optional. User annotations. These attributes can only be set and used by the user, and not by Google Security Postures. .

map<string, string> annotations = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Optional. User annotations. These attributes can only be set and used by the user, and not by Google Security Postures. .

map<string, string> annotations = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Optional. User annotations. These attributes can only be set and used by the user, and not by Google Security Postures. .

map<string, string> annotations = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

Optional. User annotations. These attributes can only be set and used by the user, and not by Google Security Postures. .

map<string, string> annotations = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Optional. User annotations. These attributes can only be set and used by the user, and not by Google Security Postures. .

map<string, string> annotations = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp that the PostureDeployment was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp that the PostureDeployment was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public PostureDeployment getDefaultInstanceForType()
Returns
Type Description
PostureDeployment

getDescription()

public String getDescription()

Optional. User provided description of the PostureDeployment.

string description = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. User provided description of the PostureDeployment.

string description = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDesiredPostureId()

public String getDesiredPostureId()

Output only. This is a output only optional field which will be filled in case where PostureDeployment state is UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED. It denotes the desired Posture.

string desired_posture_id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The desiredPostureId.

getDesiredPostureIdBytes()

public ByteString getDesiredPostureIdBytes()

Output only. This is a output only optional field which will be filled in case where PostureDeployment state is UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED. It denotes the desired Posture.

string desired_posture_id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for desiredPostureId.

getDesiredPostureRevisionId()

public String getDesiredPostureRevisionId()

Output only. Output only optional field which provides revision_id of the desired_posture_id.

string desired_posture_revision_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The desiredPostureRevisionId.

getDesiredPostureRevisionIdBytes()

public ByteString getDesiredPostureRevisionIdBytes()

Output only. Output only optional field which provides revision_id of the desired_posture_id.

string desired_posture_revision_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for desiredPostureRevisionId.

getEtag()

public String getEtag()

Optional. An opaque tag indicating the current version of the PostureDeployment, used for concurrency control. When the PostureDeployment is returned from either a GetPostureDeployment or a ListPostureDeployments request, this etag indicates the version of the current PostureDeployment to use when executing a read-modify-write loop.

When the PostureDeployment is used in a UpdatePostureDeployment method, use the etag value that was returned from a GetPostureDeployment request as part of a read-modify-write loop for concurrency control. Not setting the etag in a UpdatePostureDeployment request will result in an unconditional write of the PostureDeployment.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Optional. An opaque tag indicating the current version of the PostureDeployment, used for concurrency control. When the PostureDeployment is returned from either a GetPostureDeployment or a ListPostureDeployments request, this etag indicates the version of the current PostureDeployment to use when executing a read-modify-write loop.

When the PostureDeployment is used in a UpdatePostureDeployment method, use the etag value that was returned from a GetPostureDeployment request as part of a read-modify-write loop for concurrency control. Not setting the etag in a UpdatePostureDeployment request will result in an unconditional write of the PostureDeployment.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for etag.

getFailureMessage()

public String getFailureMessage()

Output only. This is a output only optional field which will be filled in case where PostureDeployment enters a failure state like UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED.

string failure_message = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The failureMessage.

getFailureMessageBytes()

public ByteString getFailureMessageBytes()

Output only. This is a output only optional field which will be filled in case where PostureDeployment enters a failure state like UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED.

string failure_message = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for failureMessage.

getName()

public String getName()

Required. The name of this PostureDeployment resource, in the format of organizations/{organization}/locations/{location_id}/postureDeployments/{postureDeployment}.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of this PostureDeployment resource, in the format of organizations/{organization}/locations/{location_id}/postureDeployments/{postureDeployment}.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<PostureDeployment> getParserForType()
Returns
Type Description
Parser<PostureDeployment>
Overrides

getPostureId()

public String getPostureId()

Required. Posture that needs to be deployed. Format: organizations/{org_id}/locations/{location_id}/postures/<posture> Example: organizations/99/locations/global/postures/les-miserables.

string posture_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The postureId.

getPostureIdBytes()

public ByteString getPostureIdBytes()

Required. Posture that needs to be deployed. Format: organizations/{org_id}/locations/{location_id}/postures/<posture> Example: organizations/99/locations/global/postures/les-miserables.

string posture_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for postureId.

getPostureRevisionId()

public String getPostureRevisionId()

Required. Revision_id of the Posture that is to be deployed.

string posture_revision_id = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The postureRevisionId.

getPostureRevisionIdBytes()

public ByteString getPostureRevisionIdBytes()

Required. Revision_id of the Posture that is to be deployed.

string posture_revision_id = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for postureRevisionId.

getReconciling()

public boolean getReconciling()

Output only. Whether or not this Posture is in the process of being updated.

bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The reconciling.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public PostureDeployment.State getState()

Output only. State of PostureDeployment resource.

.google.cloud.securityposture.v1.PostureDeployment.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PostureDeployment.State

The state.

getStateValue()

public int getStateValue()

Output only. State of PostureDeployment resource.

.google.cloud.securityposture.v1.PostureDeployment.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTargetResource()

public String getTargetResource()

Required. Target resource where the Posture will be deployed. Currently supported resources are of types: projects/projectNumber, folders/folderNumber, organizations/organizationNumber.

string target_resource = 13 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The targetResource.

getTargetResourceBytes()

public ByteString getTargetResourceBytes()

Required. Target resource where the Posture will be deployed. Currently supported resources are of types: projects/projectNumber, folders/folderNumber, organizations/organizationNumber.

string target_resource = 13 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for targetResource.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp that the PostureDeployment was updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp that the PostureDeployment was updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp that the PostureDeployment was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp that the PostureDeployment was updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PostureDeployment.Builder newBuilderForType()
Returns
Type Description
PostureDeployment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PostureDeployment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PostureDeployment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PostureDeployment.Builder toBuilder()
Returns
Type Description
PostureDeployment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException