Infrastructure Manager V1 API - Class Google::Cloud::ConfigService::V1::Config::Client (v2.9.0)

Reference documentation and code samples for the Infrastructure Manager V1 API class Google::Cloud::ConfigService::V1::Config::Client.

Client for the Config service.

Infrastructure Manager is a managed service that automates the deployment and management of Google Cloud infrastructure resources.

Inherits

Object

Includes

Google::Cloud::ConfigService::V1::Config::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Config Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all Config clients
::Google::Cloud::ConfigService::V1::Config::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the Config Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_deployment

def create_deployment(request, options = nil) -> ::Gapic::Operation
def create_deployment(parent: nil, deployment_id: nil, deployment: nil, request_id: nil) -> ::Gapic::Operation

Creates a Deployment.

Overloads

def create_deployment(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_deployment via a request object, either of type Google::Cloud::ConfigService::V1::CreateDeploymentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::CreateDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_deployment(parent: nil, deployment_id: nil, deployment: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent in whose context the Deployment is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
deployment_id (::String) — Required. The Deployment ID.
deployment (::Google::Cloud::ConfigService::V1::Deployment, ::Hash) — Required. Deployment resource to be created.
request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::CreateDeploymentRequest.new

# Call the create_deployment method.
result = client.create_deployment request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_deployment_group

def create_deployment_group(request, options = nil) -> ::Gapic::Operation
def create_deployment_group(parent: nil, deployment_group_id: nil, deployment_group: nil, request_id: nil) -> ::Gapic::Operation

Creates a DeploymentGroup The newly created DeploymentGroup will be in the CREATING state and can be retrieved via Get and List calls.

Overloads

def create_deployment_group(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_deployment_group via a request object, either of type Google::Cloud::ConfigService::V1::CreateDeploymentGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::CreateDeploymentGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_deployment_group(parent: nil, deployment_group_id: nil, deployment_group: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_deployment_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent in whose context the Deployment Group is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'
deployment_group_id (::String) — Required. The deployment group ID.
deployment_group (::Google::Cloud::ConfigService::V1::DeploymentGroup, ::Hash) — Required. [Deployment Group][] resource to create
request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::CreateDeploymentGroupRequest.new

# Call the create_deployment_group method.
result = client.create_deployment_group request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_preview

def create_preview(request, options = nil) -> ::Gapic::Operation
def create_preview(parent: nil, preview_id: nil, preview: nil, request_id: nil) -> ::Gapic::Operation

Creates a Preview.

Overloads

def create_preview(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_preview via a request object, either of type Google::Cloud::ConfigService::V1::CreatePreviewRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::CreatePreviewRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_preview(parent: nil, preview_id: nil, preview: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_preview via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
preview_id (::String) — Optional. The preview ID.
preview (::Google::Cloud::ConfigService::V1::Preview, ::Hash) — Required. Preview resource to be created.
request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::CreatePreviewRequest.new

# Call the create_preview method.
result = client.create_preview request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_deployment

def delete_deployment(request, options = nil) -> ::Gapic::Operation
def delete_deployment(name: nil, request_id: nil, force: nil, delete_policy: nil) -> ::Gapic::Operation

Deletes a Deployment.

Overloads

def delete_deployment(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_deployment via a request object, either of type DeleteDeploymentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::DeleteDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_deployment(name: nil, request_id: nil, force: nil, delete_policy: nil) -> ::Gapic::Operation

Pass arguments to delete_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The name of the Deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
force (::Boolean) — Optional. If set to true, any revisions for this deployment will also be deleted. (Otherwise, the request will only work if the deployment has no revisions.)
delete_policy (::Google::Cloud::ConfigService::V1::DeleteDeploymentRequest::DeletePolicy) — Optional. Policy on how resources actuated by the deployment should be deleted. If unspecified, the default behavior is to delete the underlying resources.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::DeleteDeploymentRequest.new

# Call the delete_deployment method.
result = client.delete_deployment request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_deployment_group

def delete_deployment_group(request, options = nil) -> ::Gapic::Operation
def delete_deployment_group(name: nil, request_id: nil, force: nil, deployment_reference_policy: nil) -> ::Gapic::Operation

Deletes a DeploymentGroup

Overloads

def delete_deployment_group(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_deployment_group via a request object, either of type DeleteDeploymentGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::DeleteDeploymentGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_deployment_group(name: nil, request_id: nil, force: nil, deployment_reference_policy: nil) -> ::Gapic::Operation

Pass arguments to delete_deployment_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The name of DeploymentGroup in the format projects/{project_id}/locations/{location_id}/deploymentGroups/{deploymentGroup}
request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
force (::Boolean) — Optional. If set to true, any revisions for this deployment group will also be deleted. (Otherwise, the request will only work if the deployment group has no revisions.)
deployment_reference_policy (::Google::Cloud::ConfigService::V1::DeleteDeploymentGroupRequest::DeploymentReferencePolicy) — Optional. Policy on how to handle referenced deployments when deleting the DeploymentGroup. If unspecified, the default behavior is to fail the deletion if any deployments currently referenced in the deployment_units of the DeploymentGroup or in the latest revision are not deleted.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::DeleteDeploymentGroupRequest.new

# Call the delete_deployment_group method.
result = client.delete_deployment_group request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_preview

def delete_preview(request, options = nil) -> ::Gapic::Operation
def delete_preview(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a Preview.

Overloads

def delete_preview(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_preview via a request object, either of type DeletePreviewRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::DeletePreviewRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_preview(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_preview via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The name of the Preview in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.
request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::DeletePreviewRequest.new

# Call the delete_preview method.
result = client.delete_preview request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_statefile

def delete_statefile(request, options = nil) -> ::Google::Protobuf::Empty
def delete_statefile(name: nil, lock_id: nil) -> ::Google::Protobuf::Empty

Deletes Terraform state file in a given deployment.

Overloads

def delete_statefile(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_statefile via a request object, either of type DeleteStatefileRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::DeleteStatefileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_statefile(name: nil, lock_id: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_statefile via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
lock_id (::Integer) — Required. Lock ID of the lock file to verify that the user who is deleting the state file previously locked the Deployment.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::DeleteStatefileRequest.new

# Call the delete_statefile method.
result = client.delete_statefile request

# The returned object is of type Google::Protobuf::Empty.
p result

#deprovision_deployment_group

def deprovision_deployment_group(request, options = nil) -> ::Gapic::Operation
def deprovision_deployment_group(name: nil, force: nil, delete_policy: nil) -> ::Gapic::Operation

Deprovisions a deployment group.

NOTE: As a first step of this operation, Infra Manager will automatically delete any Deployments that were part of the last successful DeploymentGroupRevision but are no longer included in the current DeploymentGroup definition (e.g., following an UpdateDeploymentGroup call), along with their actuated resources.

Overloads

def deprovision_deployment_group(request, options = nil) -> ::Gapic::Operation

Pass arguments to deprovision_deployment_group via a request object, either of type DeprovisionDeploymentGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::DeprovisionDeploymentGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def deprovision_deployment_group(name: nil, force: nil, delete_policy: nil) -> ::Gapic::Operation

Pass arguments to deprovision_deployment_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The name of the deployment group to deprovision. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
force (::Boolean) — Optional. If set to true, this option is propagated to the deletion of each deployment in the group. This corresponds to the 'force' field in DeleteDeploymentRequest.
delete_policy (::Google::Cloud::ConfigService::V1::DeleteDeploymentRequest::DeletePolicy) — Optional. Policy on how resources within each deployment should be handled during deletion. This policy is applied globally to the deletion of all deployments in this group. This corresponds to the 'delete_policy' field in DeleteDeploymentRequest.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::DeprovisionDeploymentGroupRequest.new

# Call the deprovision_deployment_group method.
result = client.deprovision_deployment_group request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#export_deployment_statefile

def export_deployment_statefile(request, options = nil) -> ::Google::Cloud::ConfigService::V1::Statefile
def export_deployment_statefile(parent: nil, draft: nil) -> ::Google::Cloud::ConfigService::V1::Statefile

Exports Terraform state file from a given deployment.

Overloads

def export_deployment_statefile(request, options = nil) -> ::Google::Cloud::ConfigService::V1::Statefile

Pass arguments to export_deployment_statefile via a request object, either of type ExportDeploymentStatefileRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ExportDeploymentStatefileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def export_deployment_statefile(parent: nil, draft: nil) -> ::Google::Cloud::ConfigService::V1::Statefile

Pass arguments to export_deployment_statefile via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
draft (::Boolean) — Optional. If this flag is set to true, the exported deployment state file will be the draft state. This will enable the draft file to be validated before copying it over to the working state on unlock.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::Statefile)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::Statefile)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ExportDeploymentStatefileRequest.new

# Call the export_deployment_statefile method.
result = client.export_deployment_statefile request

# The returned object is of type Google::Cloud::ConfigService::V1::Statefile.
p result

#export_lock_info

def export_lock_info(request, options = nil) -> ::Google::Cloud::ConfigService::V1::LockInfo
def export_lock_info(name: nil) -> ::Google::Cloud::ConfigService::V1::LockInfo

Exports the lock info on a locked deployment.

Overloads

def export_lock_info(request, options = nil) -> ::Google::Cloud::ConfigService::V1::LockInfo

Pass arguments to export_lock_info via a request object, either of type ExportLockInfoRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ExportLockInfoRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def export_lock_info(name: nil) -> ::Google::Cloud::ConfigService::V1::LockInfo

Pass arguments to export_lock_info via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::LockInfo)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::LockInfo)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ExportLockInfoRequest.new

# Call the export_lock_info method.
result = client.export_lock_info request

# The returned object is of type Google::Cloud::ConfigService::V1::LockInfo.
p result

#export_preview_result

def export_preview_result(request, options = nil) -> ::Google::Cloud::ConfigService::V1::ExportPreviewResultResponse
def export_preview_result(parent: nil) -> ::Google::Cloud::ConfigService::V1::ExportPreviewResultResponse

Export Preview results.

Overloads

def export_preview_result(request, options = nil) -> ::Google::Cloud::ConfigService::V1::ExportPreviewResultResponse

Pass arguments to export_preview_result via a request object, either of type ExportPreviewResultRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ExportPreviewResultRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def export_preview_result(parent: nil) -> ::Google::Cloud::ConfigService::V1::ExportPreviewResultResponse

Pass arguments to export_preview_result via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

parent (::String) — Required. The preview whose results should be exported. The preview value is in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::ExportPreviewResultResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::ExportPreviewResultResponse)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ExportPreviewResultRequest.new

# Call the export_preview_result method.
result = client.export_preview_result request

# The returned object is of type Google::Cloud::ConfigService::V1::ExportPreviewResultResponse.
p result

#export_revision_statefile

def export_revision_statefile(request, options = nil) -> ::Google::Cloud::ConfigService::V1::Statefile
def export_revision_statefile(parent: nil) -> ::Google::Cloud::ConfigService::V1::Statefile

Exports Terraform state file from a given revision.

Overloads

def export_revision_statefile(request, options = nil) -> ::Google::Cloud::ConfigService::V1::Statefile

Pass arguments to export_revision_statefile via a request object, either of type ExportRevisionStatefileRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ExportRevisionStatefileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def export_revision_statefile(parent: nil) -> ::Google::Cloud::ConfigService::V1::Statefile

Pass arguments to export_revision_statefile via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

parent (::String) — Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::Statefile)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::Statefile)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ExportRevisionStatefileRequest.new

# Call the export_revision_statefile method.
result = client.export_revision_statefile request

# The returned object is of type Google::Cloud::ConfigService::V1::Statefile.
p result

#get_auto_migration_config

def get_auto_migration_config(request, options = nil) -> ::Google::Cloud::ConfigService::V1::AutoMigrationConfig
def get_auto_migration_config(name: nil) -> ::Google::Cloud::ConfigService::V1::AutoMigrationConfig

Get the AutoMigrationConfig for a given project and location.

Overloads

def get_auto_migration_config(request, options = nil) -> ::Google::Cloud::ConfigService::V1::AutoMigrationConfig

Pass arguments to get_auto_migration_config via a request object, either of type GetAutoMigrationConfigRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::GetAutoMigrationConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_auto_migration_config(name: nil) -> ::Google::Cloud::ConfigService::V1::AutoMigrationConfig

Pass arguments to get_auto_migration_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the AutoMigrationConfig. Format: 'projects/{project_id}/locations/{location}/AutoMigrationConfig'.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::AutoMigrationConfig)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::AutoMigrationConfig)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::GetAutoMigrationConfigRequest.new

# Call the get_auto_migration_config method.
result = client.get_auto_migration_config request

# The returned object is of type Google::Cloud::ConfigService::V1::AutoMigrationConfig.
p result

#get_deployment

def get_deployment(request, options = nil) -> ::Google::Cloud::ConfigService::V1::Deployment
def get_deployment(name: nil) -> ::Google::Cloud::ConfigService::V1::Deployment

Gets details about a Deployment.

Overloads

def get_deployment(request, options = nil) -> ::Google::Cloud::ConfigService::V1::Deployment

Pass arguments to get_deployment via a request object, either of type GetDeploymentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::GetDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_deployment(name: nil) -> ::Google::Cloud::ConfigService::V1::Deployment

Pass arguments to get_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the deployment. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::Deployment)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::Deployment)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::GetDeploymentRequest.new

# Call the get_deployment method.
result = client.get_deployment request

# The returned object is of type Google::Cloud::ConfigService::V1::Deployment.
p result

#get_deployment_group

def get_deployment_group(request, options = nil) -> ::Google::Cloud::ConfigService::V1::DeploymentGroup
def get_deployment_group(name: nil) -> ::Google::Cloud::ConfigService::V1::DeploymentGroup

Get a DeploymentGroup for a given project and location.

Overloads

def get_deployment_group(request, options = nil) -> ::Google::Cloud::ConfigService::V1::DeploymentGroup

Pass arguments to get_deployment_group via a request object, either of type GetDeploymentGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::GetDeploymentGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_deployment_group(name: nil) -> ::Google::Cloud::ConfigService::V1::DeploymentGroup

Pass arguments to get_deployment_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the deployment group to retrieve. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::DeploymentGroup)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::DeploymentGroup)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::GetDeploymentGroupRequest.new

# Call the get_deployment_group method.
result = client.get_deployment_group request

# The returned object is of type Google::Cloud::ConfigService::V1::DeploymentGroup.
p result

#get_deployment_group_revision

def get_deployment_group_revision(request, options = nil) -> ::Google::Cloud::ConfigService::V1::DeploymentGroupRevision
def get_deployment_group_revision(name: nil) -> ::Google::Cloud::ConfigService::V1::DeploymentGroupRevision

Gets details about a DeploymentGroupRevision.

Overloads

def get_deployment_group_revision(request, options = nil) -> ::Google::Cloud::ConfigService::V1::DeploymentGroupRevision

Pass arguments to get_deployment_group_revision via a request object, either of type GetDeploymentGroupRevisionRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::GetDeploymentGroupRevisionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_deployment_group_revision(name: nil) -> ::Google::Cloud::ConfigService::V1::DeploymentGroupRevision

Pass arguments to get_deployment_group_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the deployment group revision to retrieve. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}/revisions/{revision}'.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::DeploymentGroupRevision)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::DeploymentGroupRevision)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::GetDeploymentGroupRevisionRequest.new

# Call the get_deployment_group_revision method.
result = client.get_deployment_group_revision request

# The returned object is of type Google::Cloud::ConfigService::V1::DeploymentGroupRevision.
p result

#get_preview

def get_preview(request, options = nil) -> ::Google::Cloud::ConfigService::V1::Preview
def get_preview(name: nil) -> ::Google::Cloud::ConfigService::V1::Preview

Gets details about a Preview.

Overloads

def get_preview(request, options = nil) -> ::Google::Cloud::ConfigService::V1::Preview

Pass arguments to get_preview via a request object, either of type GetPreviewRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::GetPreviewRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_preview(name: nil) -> ::Google::Cloud::ConfigService::V1::Preview

Pass arguments to get_preview via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the preview. Format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::Preview)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::Preview)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::GetPreviewRequest.new

# Call the get_preview method.
result = client.get_preview request

# The returned object is of type Google::Cloud::ConfigService::V1::Preview.
p result

#get_resource

def get_resource(request, options = nil) -> ::Google::Cloud::ConfigService::V1::Resource
def get_resource(name: nil) -> ::Google::Cloud::ConfigService::V1::Resource

Gets details about a Resource deployed by Infra Manager.

Overloads

def get_resource(request, options = nil) -> ::Google::Cloud::ConfigService::V1::Resource

Pass arguments to get_resource via a request object, either of type GetResourceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::GetResourceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_resource(name: nil) -> ::Google::Cloud::ConfigService::V1::Resource

Pass arguments to get_resource via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the Resource in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}/resource/{resource}'.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::Resource)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::Resource)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::GetResourceRequest.new

# Call the get_resource method.
result = client.get_resource request

# The returned object is of type Google::Cloud::ConfigService::V1::Resource.
p result

#get_resource_change

def get_resource_change(request, options = nil) -> ::Google::Cloud::ConfigService::V1::ResourceChange
def get_resource_change(name: nil) -> ::Google::Cloud::ConfigService::V1::ResourceChange

Get a ResourceChange for a given preview.

Overloads

def get_resource_change(request, options = nil) -> ::Google::Cloud::ConfigService::V1::ResourceChange

Pass arguments to get_resource_change via a request object, either of type GetResourceChangeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::GetResourceChangeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_resource_change(name: nil) -> ::Google::Cloud::ConfigService::V1::ResourceChange

Pass arguments to get_resource_change via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the resource change to retrieve. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceChanges/{resource_change}'.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::ResourceChange)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::ResourceChange)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::GetResourceChangeRequest.new

# Call the get_resource_change method.
result = client.get_resource_change request

# The returned object is of type Google::Cloud::ConfigService::V1::ResourceChange.
p result

#get_resource_drift

def get_resource_drift(request, options = nil) -> ::Google::Cloud::ConfigService::V1::ResourceDrift
def get_resource_drift(name: nil) -> ::Google::Cloud::ConfigService::V1::ResourceDrift

Get a ResourceDrift for a given preview.

Overloads

def get_resource_drift(request, options = nil) -> ::Google::Cloud::ConfigService::V1::ResourceDrift

Pass arguments to get_resource_drift via a request object, either of type GetResourceDriftRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::GetResourceDriftRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_resource_drift(name: nil) -> ::Google::Cloud::ConfigService::V1::ResourceDrift

Pass arguments to get_resource_drift via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the resource drift to retrieve. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}'.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::ResourceDrift)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::ResourceDrift)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::GetResourceDriftRequest.new

# Call the get_resource_drift method.
result = client.get_resource_drift request

# The returned object is of type Google::Cloud::ConfigService::V1::ResourceDrift.
p result

#get_revision

def get_revision(request, options = nil) -> ::Google::Cloud::ConfigService::V1::Revision
def get_revision(name: nil) -> ::Google::Cloud::ConfigService::V1::Revision

Gets details about a Revision.

Overloads

def get_revision(request, options = nil) -> ::Google::Cloud::ConfigService::V1::Revision

Pass arguments to get_revision via a request object, either of type GetRevisionRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::GetRevisionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_revision(name: nil) -> ::Google::Cloud::ConfigService::V1::Revision

Pass arguments to get_revision via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the Revision in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::Revision)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::Revision)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::GetRevisionRequest.new

# Call the get_revision method.
result = client.get_revision request

# The returned object is of type Google::Cloud::ConfigService::V1::Revision.
p result

#get_terraform_version

def get_terraform_version(request, options = nil) -> ::Google::Cloud::ConfigService::V1::TerraformVersion
def get_terraform_version(name: nil) -> ::Google::Cloud::ConfigService::V1::TerraformVersion

Gets details about a TerraformVersion.

Overloads

def get_terraform_version(request, options = nil) -> ::Google::Cloud::ConfigService::V1::TerraformVersion

Pass arguments to get_terraform_version via a request object, either of type GetTerraformVersionRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::GetTerraformVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_terraform_version(name: nil) -> ::Google::Cloud::ConfigService::V1::TerraformVersion

Pass arguments to get_terraform_version via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the TerraformVersion. Format: 'projects/{project_id}/locations/{location}/terraformVersions/{terraform_version}'

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::TerraformVersion)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::TerraformVersion)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::GetTerraformVersionRequest.new

# Call the get_terraform_version method.
result = client.get_terraform_version request

# The returned object is of type Google::Cloud::ConfigService::V1::TerraformVersion.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns

(Google::Iam::V1::IAMPolicy::Client)

#import_statefile

def import_statefile(request, options = nil) -> ::Google::Cloud::ConfigService::V1::Statefile
def import_statefile(parent: nil, lock_id: nil, skip_draft: nil) -> ::Google::Cloud::ConfigService::V1::Statefile

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.

Overloads

def import_statefile(request, options = nil) -> ::Google::Cloud::ConfigService::V1::Statefile

Pass arguments to import_statefile via a request object, either of type ImportStatefileRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ImportStatefileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def import_statefile(parent: nil, lock_id: nil, skip_draft: nil) -> ::Google::Cloud::ConfigService::V1::Statefile

Pass arguments to import_statefile via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
lock_id (::Integer) — Required. Lock ID of the lock file to verify that the user who is importing the state file previously locked the Deployment.
skip_draft (::Boolean) — Optional.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ConfigService::V1::Statefile)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ConfigService::V1::Statefile)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ImportStatefileRequest.new

# Call the import_statefile method.
result = client.import_statefile request

# The returned object is of type Google::Cloud::ConfigService::V1::Statefile.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new Config client object.

Yields

(config) — Configure the Config client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::ConfigService::V1::Config::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::ConfigService::V1::Config::Client.new do |config|
  config.timeout = 10.0
end

#list_deployment_group_revisions

def list_deployment_group_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::DeploymentGroupRevision>
def list_deployment_group_revisions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::DeploymentGroupRevision>

Lists {::Google::Cloud::ConfigService::V1::DeploymentGroupRevision DeploymentGroupRevision}s in a given DeploymentGroup.

Overloads

def list_deployment_group_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::DeploymentGroupRevision>

Pass arguments to list_deployment_group_revisions via a request object, either of type ListDeploymentGroupRevisionsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ListDeploymentGroupRevisionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_deployment_group_revisions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::DeploymentGroupRevision>

Pass arguments to list_deployment_group_revisions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent, which owns this collection of deployment group revisions. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
page_size (::Integer) — Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, a sensible default will be used by the server. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token (::String) — Optional. Token returned by previous call to 'ListDeploymentGroupRevisions' which specifies the position in the list from where to continue listing the deployment group revisions. All other parameters provided to ListDeploymentGroupRevisions must match the call that provided the page token.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::DeploymentGroupRevision>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::DeploymentGroupRevision>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ListDeploymentGroupRevisionsRequest.new

# Call the list_deployment_group_revisions method.
result = client.list_deployment_group_revisions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ConfigService::V1::DeploymentGroupRevision.
  p item
end

#list_deployment_groups

def list_deployment_groups(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::DeploymentGroup>
def list_deployment_groups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::DeploymentGroup>

List DeploymentGroups for a given project and location.

Overloads

def list_deployment_groups(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::DeploymentGroup>

Pass arguments to list_deployment_groups via a request object, either of type ListDeploymentGroupsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ListDeploymentGroupsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_deployment_groups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::DeploymentGroup>

Pass arguments to list_deployment_groups via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent, which owns this collection of deployment groups. Format: 'projects/{project_id}/locations/{location}'.
page_size (::Integer) — Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
page_token (::String) — Optional. Token returned by previous call to 'ListDeploymentGroups' which specifies the position in the list from where to continue listing the deployment groups.
filter (::String) —
Optional. Lists the DeploymentGroups that match the filter expression. A filter expression filters the deployment groups listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:
- Filter by name: name = "projects/foo/locations/us-central1/deploymentGroups/bar"
- Filter by labels:
  - Resources that have a key called 'foo' labels.foo:*
  - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar
- Filter by state:
  - DeploymentGroups in CREATING state. state=CREATING
order_by (::String) — Optional. Field to use to sort the list.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::DeploymentGroup>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::DeploymentGroup>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ListDeploymentGroupsRequest.new

# Call the list_deployment_groups method.
result = client.list_deployment_groups request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ConfigService::V1::DeploymentGroup.
  p item
end

#list_deployments

def list_deployments(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Deployment>
def list_deployments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Deployment>

Lists {::Google::Cloud::ConfigService::V1::Deployment Deployment}s in a given project and location.

Overloads

def list_deployments(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Deployment>

Pass arguments to list_deployments via a request object, either of type ListDeploymentsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ListDeploymentsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_deployments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Deployment>

Pass arguments to list_deployments via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
page_size (::Integer) — When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
page_token (::String) — Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.
filter (::String) —
Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:
- Filter by name: name = "projects/foo/locations/us-central1/deployments/bar
- Filter by labels:
  - Resources that have a key called 'foo' labels.foo:*
  - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar
- Filter by state:
  - Deployments in CREATING state. state=CREATING
order_by (::String) — Field to use to sort the list.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Deployment>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Deployment>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ListDeploymentsRequest.new

# Call the list_deployments method.
result = client.list_deployments request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ConfigService::V1::Deployment.
  p item
end

#list_previews

def list_previews(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Preview>
def list_previews(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Preview>

Lists {::Google::Cloud::ConfigService::V1::Preview Preview}s in a given project and location.

Overloads

def list_previews(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Preview>

Pass arguments to list_previews via a request object, either of type ListPreviewsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ListPreviewsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_previews(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Preview>

Pass arguments to list_previews via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
page_size (::Integer) — Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
page_token (::String) — Optional. Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.
filter (::String) —
Optional. Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:
- Filter by name: name = "projects/foo/locations/us-central1/deployments/bar
- Filter by labels:
  - Resources that have a key called 'foo' labels.foo:*
  - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar
- Filter by state:
  - Deployments in CREATING state. state=CREATING
order_by (::String) — Optional. Field to use to sort the list.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Preview>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Preview>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ListPreviewsRequest.new

# Call the list_previews method.
result = client.list_previews request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ConfigService::V1::Preview.
  p item
end

#list_resource_changes

def list_resource_changes(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::ResourceChange>
def list_resource_changes(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::ResourceChange>

Lists ResourceChanges for a given preview.

Overloads

def list_resource_changes(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::ResourceChange>

Pass arguments to list_resource_changes via a request object, either of type ListResourceChangesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ListResourceChangesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_resource_changes(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::ResourceChange>

Pass arguments to list_resource_changes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent in whose context the ResourceChanges are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.
page_size (::Integer) — Optional. When requesting a page of resource changes, 'page_size' specifies number of resource changes to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
page_token (::String) — Optional. Token returned by previous call to 'ListResourceChanges' which specifies the position in the list from where to continue listing the resource changes.
filter (::String) —
Optional. Lists the resource changes that match the filter expression. A filter expression filters the resource changes listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:
- Filter by name: name = "projects/foo/locations/us-central1/previews/dep/resourceChanges/baz
order_by (::String) — Optional. Field to use to sort the list.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::ResourceChange>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::ResourceChange>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ListResourceChangesRequest.new

# Call the list_resource_changes method.
result = client.list_resource_changes request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ConfigService::V1::ResourceChange.
  p item
end

#list_resource_drifts

def list_resource_drifts(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::ResourceDrift>
def list_resource_drifts(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::ResourceDrift>

List ResourceDrifts for a given preview.

Overloads

def list_resource_drifts(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::ResourceDrift>

Pass arguments to list_resource_drifts via a request object, either of type ListResourceDriftsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ListResourceDriftsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_resource_drifts(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::ResourceDrift>

Pass arguments to list_resource_drifts via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent in whose context the ResourceDrifts are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.
page_size (::Integer) — Optional. When requesting a page of resource drifts, 'page_size' specifies number of resource drifts to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
page_token (::String) — Optional. Token returned by previous call to 'ListResourceDrifts' which specifies the position in the list from where to continue listing the resource drifts.
filter (::String) —
Optional. Lists the resource drifts that match the filter expression. A filter expression filters the resource drifts listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:
- Filter by name: name = "projects/foo/locations/us-central1/previews/dep/resourceDrifts/baz
order_by (::String) — Optional. Field to use to sort the list.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::ResourceDrift>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::ResourceDrift>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ListResourceDriftsRequest.new

# Call the list_resource_drifts method.
result = client.list_resource_drifts request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ConfigService::V1::ResourceDrift.
  p item
end

#list_resources

def list_resources(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Resource>
def list_resources(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Resource>

Lists Resources in a given revision.

Overloads

def list_resources(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Resource>

Pass arguments to list_resources via a request object, either of type ListResourcesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ListResourcesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_resources(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Resource>

Pass arguments to list_resources via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent in whose context the Resources are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.
page_size (::Integer) — When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
page_token (::String) — Token returned by previous call to 'ListResources' which specifies the position in the list from where to continue listing the resources.
filter (::String) —
Lists the Resources that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:
- Filter by name: name = "projects/foo/locations/us-central1/deployments/dep/revisions/bar/resources/baz
order_by (::String) — Field to use to sort the list.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Resource>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Resource>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ListResourcesRequest.new

# Call the list_resources method.
result = client.list_resources request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ConfigService::V1::Resource.
  p item
end

#list_revisions

def list_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Revision>
def list_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Revision>

Lists {::Google::Cloud::ConfigService::V1::Revision Revision}s of a deployment.

Overloads

def list_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Revision>

Pass arguments to list_revisions via a request object, either of type ListRevisionsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ListRevisionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Revision>

Pass arguments to list_revisions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent in whose context the Revisions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
page_size (::Integer) — When requesting a page of resources, page_size specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
page_token (::String) — Token returned by previous call to 'ListRevisions' which specifies the position in the list from where to continue listing the resources.
filter (::String) —
Lists the Revisions that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:
- Filter by name: name = "projects/foo/locations/us-central1/deployments/dep/revisions/bar
- Filter by labels:
  - Resources that have a key called 'foo' labels.foo:*
  - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar
- Filter by state:
  - Revisions in CREATING state. state=CREATING
order_by (::String) — Field to use to sort the list.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Revision>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::Revision>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ListRevisionsRequest.new

# Call the list_revisions method.
result = client.list_revisions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ConfigService::V1::Revision.
  p item
end

#list_terraform_versions

def list_terraform_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::TerraformVersion>
def list_terraform_versions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::TerraformVersion>

Lists {::Google::Cloud::ConfigService::V1::TerraformVersion TerraformVersion}s in a given project and location.

Overloads

def list_terraform_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::TerraformVersion>

Pass arguments to list_terraform_versions via a request object, either of type ListTerraformVersionsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ListTerraformVersionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_terraform_versions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::TerraformVersion>

Pass arguments to list_terraform_versions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent in whose context the TerraformVersions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
page_size (::Integer) — Optional. When requesting a page of terraform versions, 'page_size' specifies number of terraform versions to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
page_token (::String) — Optional. Token returned by previous call to 'ListTerraformVersions' which specifies the position in the list from where to continue listing the terraform versions.
filter (::String) — Optional. Lists the TerraformVersions that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.
order_by (::String) — Optional. Field to use to sort the list.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::TerraformVersion>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::ConfigService::V1::TerraformVersion>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ListTerraformVersionsRequest.new

# Call the list_terraform_versions method.
result = client.list_terraform_versions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ConfigService::V1::TerraformVersion.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns

(Google::Cloud::Location::Locations::Client)

#lock_deployment

def lock_deployment(request, options = nil) -> ::Gapic::Operation
def lock_deployment(name: nil) -> ::Gapic::Operation

Locks a deployment.

Overloads

def lock_deployment(request, options = nil) -> ::Gapic::Operation

Pass arguments to lock_deployment via a request object, either of type LockDeploymentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::LockDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def lock_deployment(name: nil) -> ::Gapic::Operation

Pass arguments to lock_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::LockDeploymentRequest.new

# Call the lock_deployment method.
result = client.lock_deployment request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns

(Logger)

#operations_client

def operations_client() -> ::Google::Cloud::ConfigService::V1::Config::Operations

Get the associated client for long-running operations.

Returns

(::Google::Cloud::ConfigService::V1::Config::Operations)

#provision_deployment_group

def provision_deployment_group(request, options = nil) -> ::Gapic::Operation
def provision_deployment_group(name: nil, deployment_specs: nil) -> ::Gapic::Operation

Provisions a deployment group.

Overloads

def provision_deployment_group(request, options = nil) -> ::Gapic::Operation

Pass arguments to provision_deployment_group via a request object, either of type ProvisionDeploymentGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::ProvisionDeploymentGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def provision_deployment_group(name: nil, deployment_specs: nil) -> ::Gapic::Operation

Pass arguments to provision_deployment_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The name of the deployment group to provision. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.
deployment_specs (::Hash{::String => ::Google::Cloud::ConfigService::V1::DeploymentSpec, ::Hash}) — Optional. The deployment specs of the deployment units to be created within the same project and location of the deployment group. The key is the unit ID, and the value is the DeploymentSpec. Provisioning will fail if a deployment_spec has a deployment_id that matches an existing deployment in the same project and location. If an existing deployment was part of the last successful revision but is no longer in the current DeploymentGroup's deployment_units, it will be recreated if included in deployment_specs.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::ProvisionDeploymentGroupRequest.new

# Call the provision_deployment_group method.
result = client.provision_deployment_group request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#unlock_deployment

def unlock_deployment(request, options = nil) -> ::Gapic::Operation
def unlock_deployment(name: nil, lock_id: nil) -> ::Gapic::Operation

Unlocks a locked deployment.

Overloads

def unlock_deployment(request, options = nil) -> ::Gapic::Operation

Pass arguments to unlock_deployment via a request object, either of type UnlockDeploymentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::UnlockDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def unlock_deployment(name: nil, lock_id: nil) -> ::Gapic::Operation

Pass arguments to unlock_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
lock_id (::Integer) — Required. Lock ID of the lock file to be unlocked.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::UnlockDeploymentRequest.new

# Call the unlock_deployment method.
result = client.unlock_deployment request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_auto_migration_config

def update_auto_migration_config(request, options = nil) -> ::Gapic::Operation
def update_auto_migration_config(update_mask: nil, auto_migration_config: nil) -> ::Gapic::Operation

Updates the AutoMigrationConfig for a given project and location.

Overloads

def update_auto_migration_config(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_auto_migration_config via a request object, either of type UpdateAutoMigrationConfigRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::UpdateAutoMigrationConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_auto_migration_config(update_mask: nil, auto_migration_config: nil) -> ::Gapic::Operation

Pass arguments to update_auto_migration_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The update mask applies to the resource. See google.protobuf.FieldMask.
auto_migration_config (::Google::Cloud::ConfigService::V1::AutoMigrationConfig, ::Hash) — Required. The AutoMigrationConfig to update.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::UpdateAutoMigrationConfigRequest.new

# Call the update_auto_migration_config method.
result = client.update_auto_migration_config request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_deployment

def update_deployment(request, options = nil) -> ::Gapic::Operation
def update_deployment(update_mask: nil, deployment: nil, request_id: nil) -> ::Gapic::Operation

Updates a Deployment.

Overloads

def update_deployment(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_deployment via a request object, either of type UpdateDeploymentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::UpdateDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_deployment(update_mask: nil, deployment: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Field mask used to specify the fields to be overwritten in the Deployment resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
deployment (::Google::Cloud::ConfigService::V1::Deployment, ::Hash) — Required. Deployment to update.

The deployment's name field is used to identify the resource to be updated. Format: projects/{project}/locations/{location}/deployments/{deployment}
request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::UpdateDeploymentRequest.new

# Call the update_deployment method.
result = client.update_deployment request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_deployment_group

def update_deployment_group(request, options = nil) -> ::Gapic::Operation
def update_deployment_group(update_mask: nil, deployment_group: nil, request_id: nil) -> ::Gapic::Operation

Updates a DeploymentGroup

Overloads

def update_deployment_group(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_deployment_group via a request object, either of type UpdateDeploymentGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::ConfigService::V1::UpdateDeploymentGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_deployment_group(update_mask: nil, deployment_group: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_deployment_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Field mask used to specify the fields to be overwritten in the Deployment Group resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
deployment_group (::Google::Cloud::ConfigService::V1::DeploymentGroup, ::Hash) — Required. DeploymentGroup to update.

The deployment group's name field is used to identify the resource to be updated. Format: projects/{project}/locations/{location}/deploymentGroups/{deployment_group_id}
request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/config_service/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ConfigService::V1::Config::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ConfigService::V1::UpdateDeploymentGroupRequest.new

# Call the update_deployment_group method.
result = client.update_deployment_group request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Infrastructure Manager V1 API - Class Google::Cloud::ConfigService::V1::Config::Client (v2.9.0) Stay organized with collections Save and categorize content based on your preferences.

Inherits

Includes

Methods

.configure

#configure

#create_deployment

#create_deployment_group

#create_preview

#delete_deployment

#delete_deployment_group

#delete_preview

#delete_statefile

#deprovision_deployment_group

#export_deployment_statefile

#export_lock_info

#export_preview_result

#export_revision_statefile

#get_auto_migration_config

#get_deployment

#get_deployment_group

#get_deployment_group_revision

#get_preview

#get_resource

#get_resource_change

#get_resource_drift

#get_revision

#get_terraform_version

#iam_policy_client

#import_statefile

#initialize

#list_deployment_group_revisions

#list_deployment_groups

#list_deployments

#list_previews

#list_resource_changes

#list_resource_drifts

#list_resources

#list_revisions

#list_terraform_versions

#location_client

#lock_deployment

#logger

#operations_client

#provision_deployment_group

#universe_domain

#unlock_deployment

#update_auto_migration_config

#update_deployment

#update_deployment_group

Infrastructure Manager V1 API - Class Google::Cloud::ConfigService::V1::Config::Client (v2.9.0)