Interface FrameworkDeploymentOrBuilder (0.7.0) 

public interface FrameworkDeploymentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCloudControlDeploymentReferences(int index)

public abstract CloudControlDeploymentReference getCloudControlDeploymentReferences(int index)

Output only. The references to the cloud control deployments. The reference includes all the cloud control deployments that are in the framework or in a cloud control group.

For example, if a framework deployment deploys two cloud controls, cc-deployment-1 and cc-deployment-2, then the references are:

<code><code> { cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-1" }, cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-2" } </code></code>

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlDeploymentReference cloud_control_deployment_references = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
CloudControlDeploymentReference

getCloudControlDeploymentReferencesCount()

public abstract int getCloudControlDeploymentReferencesCount()

Output only. The references to the cloud control deployments. The reference includes all the cloud control deployments that are in the framework or in a cloud control group.

For example, if a framework deployment deploys two cloud controls, cc-deployment-1 and cc-deployment-2, then the references are:

<code><code> { cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-1" }, cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-2" } </code></code>

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlDeploymentReference cloud_control_deployment_references = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getCloudControlDeploymentReferencesList()

public abstract List<CloudControlDeploymentReference> getCloudControlDeploymentReferencesList()

Output only. The references to the cloud control deployments. The reference includes all the cloud control deployments that are in the framework or in a cloud control group.

For example, if a framework deployment deploys two cloud controls, cc-deployment-1 and cc-deployment-2, then the references are:

<code><code> { cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-1" }, cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-2" } </code></code>

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlDeploymentReference cloud_control_deployment_references = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<CloudControlDeploymentReference>

getCloudControlDeploymentReferencesOrBuilder(int index)

public abstract CloudControlDeploymentReferenceOrBuilder getCloudControlDeploymentReferencesOrBuilder(int index)

Output only. The references to the cloud control deployments. The reference includes all the cloud control deployments that are in the framework or in a cloud control group.

For example, if a framework deployment deploys two cloud controls, cc-deployment-1 and cc-deployment-2, then the references are:

<code><code> { cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-1" }, cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-2" } </code></code>

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlDeploymentReference cloud_control_deployment_references = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
CloudControlDeploymentReferenceOrBuilder

getCloudControlDeploymentReferencesOrBuilderList()

public abstract List<? extends CloudControlDeploymentReferenceOrBuilder> getCloudControlDeploymentReferencesOrBuilderList()

Output only. The references to the cloud control deployments. The reference includes all the cloud control deployments that are in the framework or in a cloud control group.

For example, if a framework deployment deploys two cloud controls, cc-deployment-1 and cc-deployment-2, then the references are:

<code><code> { cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-1" }, cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-2" } </code></code>

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlDeploymentReference cloud_control_deployment_references = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.cloudsecuritycompliance.v1.CloudControlDeploymentReferenceOrBuilder>

getCloudControlMetadata(int index)

public abstract CloudControlMetadata getCloudControlMetadata(int index)

Required. The deployment mode and parameters for each of the cloud controls in the framework. Every cloud control in the framework includes metadata.

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlMetadata cloud_control_metadata = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
CloudControlMetadata

getCloudControlMetadataCount()

public abstract int getCloudControlMetadataCount()

Required. The deployment mode and parameters for each of the cloud controls in the framework. Every cloud control in the framework includes metadata.

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlMetadata cloud_control_metadata = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getCloudControlMetadataList()

public abstract List<CloudControlMetadata> getCloudControlMetadataList()

Required. The deployment mode and parameters for each of the cloud controls in the framework. Every cloud control in the framework includes metadata.

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlMetadata cloud_control_metadata = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<CloudControlMetadata>

getCloudControlMetadataOrBuilder(int index)

public abstract CloudControlMetadataOrBuilder getCloudControlMetadataOrBuilder(int index)

Required. The deployment mode and parameters for each of the cloud controls in the framework. Every cloud control in the framework includes metadata.

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlMetadata cloud_control_metadata = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
CloudControlMetadataOrBuilder

getCloudControlMetadataOrBuilderList()

public abstract List<? extends CloudControlMetadataOrBuilder> getCloudControlMetadataOrBuilderList()

Required. The deployment mode and parameters for each of the cloud controls in the framework. Every cloud control in the framework includes metadata.

repeated .google.cloud.cloudsecuritycompliance.v1.CloudControlMetadata cloud_control_metadata = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.cloudsecuritycompliance.v1.CloudControlMetadataOrBuilder>

getComputedTargetResource()

public abstract String getComputedTargetResource()

Output only. The target resource to deploy the framework to, in one the following formats:

  • organizations/{organizationID}
  • folders/{folderID}
  • projects/{projectID}

string computed_target_resource = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The computedTargetResource.

getComputedTargetResourceBytes()

public abstract ByteString getComputedTargetResourceBytes()

Output only. The target resource to deploy the framework to, in one the following formats:

  • organizations/{organizationID}
  • folders/{folderID}
  • projects/{projectID}

string computed_target_resource = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for computedTargetResource.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time at which the resource was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which the resource was created.

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

Returns
Type Description
TimestampOrBuilder

getDeploymentState()

public abstract DeploymentState getDeploymentState()

Output only. The state for the framework deployment.

.google.cloud.cloudsecuritycompliance.v1.DeploymentState deployment_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DeploymentState

The deploymentState.

getDeploymentStateValue()

public abstract int getDeploymentStateValue()

Output only. The state for the framework deployment.

.google.cloud.cloudsecuritycompliance.v1.DeploymentState deployment_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for deploymentState.

getDescription()

public abstract String getDescription()

Optional. A user-provided description of the framework deployment.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. A user-provided description of the framework deployment.

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

Returns
Type Description
ByteString

The bytes for description.

getEtag()

public abstract String getEtag()

Optional. To prevent concurrent updates from overwriting each other, always provide the etag when you update a framework deployment. You can also provide the etag when you delete a framework deployment, to help ensure that you're deleting the intended version of the framework deployment.

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

Returns
Type Description
String

The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

Optional. To prevent concurrent updates from overwriting each other, always provide the etag when you update a framework deployment. You can also provide the etag when you delete a framework deployment, to help ensure that you're deleting the intended version of the framework deployment.

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

Returns
Type Description
ByteString

The bytes for etag.

getFramework()

public abstract FrameworkReference getFramework()

Required. A reference to the framework that you're deploying.

.google.cloud.cloudsecuritycompliance.v1.FrameworkReference framework = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FrameworkReference

The framework.

getFrameworkOrBuilder()

public abstract FrameworkReferenceOrBuilder getFrameworkOrBuilder()

Required. A reference to the framework that you're deploying.

.google.cloud.cloudsecuritycompliance.v1.FrameworkReference framework = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FrameworkReferenceOrBuilder

getName()

public abstract String getName()

Identifier. The name of the framework deployment, in the format organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}. The only supported location is global.

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The name of the framework deployment, in the format organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}. The only supported location is global.

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

Returns
Type Description
ByteString

The bytes for name.

getTargetResourceConfig()

public abstract TargetResourceConfig getTargetResourceConfig()

Required. The details of the target resource that you want to deploy the framework to. You can specify an existing resource, or create a new one.

.google.cloud.cloudsecuritycompliance.v1.TargetResourceConfig target_resource_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TargetResourceConfig

The targetResourceConfig.

getTargetResourceConfigOrBuilder()

public abstract TargetResourceConfigOrBuilder getTargetResourceConfigOrBuilder()

Required. The details of the target resource that you want to deploy the framework to. You can specify an existing resource, or create a new one.

.google.cloud.cloudsecuritycompliance.v1.TargetResourceConfig target_resource_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TargetResourceConfigOrBuilder

getTargetResourceDisplayName()

public abstract String getTargetResourceDisplayName()

Output only. The display name of the target resource.

string target_resource_display_name = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The targetResourceDisplayName.

getTargetResourceDisplayNameBytes()

public abstract ByteString getTargetResourceDisplayNameBytes()

Output only. The display name of the target resource.

string target_resource_display_name = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for targetResourceDisplayName.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time at which the resource last updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time at which the resource last updated.

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time at which the resource was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasFramework()

public abstract boolean hasFramework()

Required. A reference to the framework that you're deploying.

.google.cloud.cloudsecuritycompliance.v1.FrameworkReference framework = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the framework field is set.

hasTargetResourceConfig()

public abstract boolean hasTargetResourceConfig()

Required. The details of the target resource that you want to deploy the framework to. You can specify an existing resource, or create a new one.

.google.cloud.cloudsecuritycompliance.v1.TargetResourceConfig target_resource_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the targetResourceConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time at which the resource last updated.

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

Returns
Type Description
boolean

Whether the updateTime field is set.