Reference documentation and code samples for the Infrastructure Manager V1 API class Google::Cloud::ConfigService::V1::DeploymentGroup.
A DeploymentGroup is a collection of DeploymentUnits that in a DAG-like structure.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#annotations
def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.
#annotations=
def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Time when the deployment group was created.
#deployment_units
def deployment_units() -> ::Array<::Google::Cloud::ConfigService::V1::DeploymentUnit>
Returns
- (::Array<::Google::Cloud::ConfigService::V1::DeploymentUnit>) — The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.
#deployment_units=
def deployment_units=(value) -> ::Array<::Google::Cloud::ConfigService::V1::DeploymentUnit>
Parameter
- value (::Array<::Google::Cloud::ConfigService::V1::DeploymentUnit>) — The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.
Returns
- (::Array<::Google::Cloud::ConfigService::V1::DeploymentUnit>) — The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined metadata for the deployment group.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined metadata for the deployment group.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined metadata for the deployment group.
#name
def name() -> ::String
Returns
- (::String) — Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
Returns
- (::String) — Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
#provisioning_error
def provisioning_error() -> ::Google::Rpc::Status
Returns
- (::Google::Rpc::Status) — Output only. The error status of the deployment group provisioning or deprovisioning.
#provisioning_state
def provisioning_state() -> ::Google::Cloud::ConfigService::V1::DeploymentGroup::ProvisioningState
Returns
- (::Google::Cloud::ConfigService::V1::DeploymentGroup::ProvisioningState) — Output only. The provisioning state of the deployment group.
#provisioning_state_description
def provisioning_state_description() -> ::String
Returns
- (::String) — Output only. Additional information regarding the current provisioning state.
#state
def state() -> ::Google::Cloud::ConfigService::V1::DeploymentGroup::State
Returns
- (::Google::Cloud::ConfigService::V1::DeploymentGroup::State) — Output only. Current state of the deployment group.
#state_description
def state_description() -> ::String
Returns
- (::String) — Output only. Additional information regarding the current state.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Time when the deployment group was last updated.