Interface PostureDeploymentOrBuilder (0.17.0) 

public interface PostureDeploymentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract 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

getAnnotations() (deprecated)

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getDescription()

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

getPostureId()

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

getState()

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