Class: Google::Cloud::ConfigService::V1::Config::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/config_service/v1/config/rest/client.rb

Overview

REST client for the Config service.

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

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#deployment_path, #location_path, #preview_path, #resource_path, #revision_path, #service_account_path, #worker_pool_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Config REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the Config client.

Yield Parameters:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 126

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = ::Google::Cloud::ConfigService::V1::Config::Rest::Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @config_stub = ::Google::Cloud::ConfigService::V1::Config::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config_stub.endpoint
    config.universe_domain = @config_stub.universe_domain
    config.bindings_override = @config.bindings_override
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config_stub.endpoint
    config.universe_domain = @config_stub.universe_domain
    config.bindings_override = @config.bindings_override
  end
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Rest::Client (readonly)

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

Returns:

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


199
200
201
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 199

def iam_policy_client
  @iam_policy_client
end

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)

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

Returns:

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


192
193
194
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 192

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::ConfigService::V1::Config::Rest::Operations (readonly)

Get the associated client for long-running operations.

Returns:



185
186
187
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 185

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Config Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "ConfigService", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



96
97
98
99
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#create_deployment(request, options = nil) ⇒ ::Gapic::Operation #create_deployment(parent: nil, deployment_id: nil, deployment: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates a Deployment.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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) (defaults to: nil) —

      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) (defaults to: nil) —

      Required. The Deployment ID.

    • deployment (::Google::Cloud::ConfigService::V1::Deployment, ::Hash) (defaults to: nil) —

      Required. Deployment resource to be created.

    • request_id (::String) (defaults to: nil) —

      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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 468

def create_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::CreateDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_deployment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.create_deployment request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_preview(request, options = nil) ⇒ ::Gapic::Operation #create_preview(parent: nil, preview_id: nil, preview: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates a Preview.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. The preview ID.

    • preview (::Google::Cloud::ConfigService::V1::Preview, ::Hash) (defaults to: nil) —

      Required. Preview resource to be created.

    • request_id (::String) (defaults to: nil) —

      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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 1761

def create_preview request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::CreatePreviewRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_preview.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_preview.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_preview.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.create_preview request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_deployment(request, options = nil) ⇒ ::Gapic::Operation #delete_deployment(name: nil, request_id: nil, force: nil, delete_policy: nil) ⇒ ::Gapic::Operation

Deletes a Deployment.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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) (defaults to: nil) —

      Required. The name of the Deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

    • request_id (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. Policy on how resources actuated by the deployment should be deleted. If unspecified, the default behavior is to delete the underlying resources.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 688

def delete_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::DeleteDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_deployment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.delete_deployment request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_preview(request, options = nil) ⇒ ::Gapic::Operation #delete_preview(name: nil, request_id: nil) ⇒ ::Gapic::Operation

Deletes a Preview.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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) (defaults to: nil) —

      Required. The name of the Preview in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

    • request_id (::String) (defaults to: nil) —

      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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 2057

def delete_preview request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::DeletePreviewRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_preview.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_preview.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_preview.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.delete_preview request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_statefile(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_statefile(name: nil, lock_id: nil) ⇒ ::Google::Protobuf::Empty

Deletes Terraform state file in a given deployment.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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) (defaults to: nil) —

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

    • lock_id (::Integer) (defaults to: nil) —

      Required. Lock ID of the lock file to verify that the user who is deleting the state file previously locked the Deployment.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 1402

def delete_statefile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::DeleteStatefileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_statefile.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_statefile.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_statefile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.delete_statefile request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#export_deployment_statefile(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::Statefile #export_deployment_statefile(parent: nil, draft: nil) ⇒ ::Google::Cloud::ConfigService::V1::Statefile

Exports Terraform state file from a given deployment.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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) (defaults to: nil) —

      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) (defaults to: nil) —

      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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 1154

def export_deployment_statefile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ExportDeploymentStatefileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.export_deployment_statefile.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.export_deployment_statefile.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.export_deployment_statefile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.export_deployment_statefile request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#export_lock_info(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::LockInfo #export_lock_info(name: nil) ⇒ ::Google::Cloud::ConfigService::V1::LockInfo

Exports the lock info on a locked deployment.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 1657

def export_lock_info request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ExportLockInfoRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.export_lock_info.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.export_lock_info.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.export_lock_info.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.export_lock_info request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#export_preview_result(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::ExportPreviewResultResponse #export_preview_result(parent: nil) ⇒ ::Google::Cloud::ConfigService::V1::ExportPreviewResultResponse

Export Preview results.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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).

    Parameters:

    • parent (::String) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 2138

def export_preview_result request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ExportPreviewResultRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.export_preview_result.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.export_preview_result.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.export_preview_result.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.export_preview_result request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#export_revision_statefile(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::Statefile #export_revision_statefile(parent: nil) ⇒ ::Google::Cloud::ConfigService::V1::Statefile

Exports Terraform state file from a given revision.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 1234

def export_revision_statefile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ExportRevisionStatefileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.export_revision_statefile.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.export_revision_statefile.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.export_revision_statefile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.export_revision_statefile request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_deployment(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::Deployment #get_deployment(name: nil) ⇒ ::Google::Cloud::ConfigService::V1::Deployment

Gets details about a Deployment.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 363

def get_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::GetDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_deployment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.get_deployment request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_preview(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::Preview #get_preview(name: nil) ⇒ ::Google::Cloud::ConfigService::V1::Preview

Gets details about a Preview.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 1841

def get_preview request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::GetPreviewRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_preview.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_preview.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_preview.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.get_preview request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_resource(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::Resource #get_resource(name: nil) ⇒ ::Google::Cloud::ConfigService::V1::Resource

Gets details about a Resource deployed by Infra Manager.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 963

def get_resource request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::GetResourceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_resource.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_resource.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_resource.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.get_resource request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_revision(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::Revision #get_revision(name: nil) ⇒ ::Google::Cloud::ConfigService::V1::Revision

Gets details about a Revision.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 883

def get_revision request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::GetRevisionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_revision.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_revision.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_revision.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.get_revision request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#import_statefile(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::Statefile #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.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 1320

def import_statefile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ImportStatefileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.import_statefile.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.import_statefile.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.import_statefile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.import_statefile request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_deployments(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::ListDeploymentsResponse #list_deployments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::ConfigService::V1::ListDeploymentsResponse

Lists Deployments in a given project and location.

Examples:

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::Rest::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

Overloads:

  • #list_deployments(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::ListDeploymentsResponse

    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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_deployments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::ConfigService::V1::ListDeploymentsResponse

    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) (defaults to: nil) —

      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) (defaults to: nil) —

      When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

    • page_token (::String) (defaults to: nil) —

      Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.

    • filter (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Field to use to sort the list.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 284

def list_deployments request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ListDeploymentsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_deployments.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_deployments.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_deployments.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.list_deployments request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_previews(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::ListPreviewsResponse #list_previews(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::ConfigService::V1::ListPreviewsResponse

Lists Previews in a given project and location.

Examples:

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::Rest::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

Overloads:

  • #list_previews(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::ListPreviewsResponse

    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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_previews(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::ConfigService::V1::ListPreviewsResponse

    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) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

    • page_token (::String) (defaults to: nil) —

      Optional. Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.

    • filter (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. Field to use to sort the list.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 1957

def list_previews request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ListPreviewsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_previews.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_previews.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_previews.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.list_previews request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_resources(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::ListResourcesResponse #list_resources(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::ConfigService::V1::ListResourcesResponse

Lists Resources in a given revision.

Examples:

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::Rest::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

Overloads:

  • #list_resources(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::ListResourcesResponse

    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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_resources(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::ConfigService::V1::ListResourcesResponse

    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) (defaults to: nil) —

      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) (defaults to: nil) —

      When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

    • page_token (::String) (defaults to: nil) —

      Token returned by previous call to 'ListResources' which specifies the position in the list from where to continue listing the resources.

    • filter (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Field to use to sort the list.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 1070

def list_resources request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ListResourcesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_resources.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_resources.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_resources.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.list_resources request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_revisions(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::ListRevisionsResponse #list_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::ConfigService::V1::ListRevisionsResponse

Lists Revisions of a deployment.

Examples:

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::Rest::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

Overloads:

  • #list_revisions(request, options = nil) ⇒ ::Google::Cloud::ConfigService::V1::ListRevisionsResponse

    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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_revisions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::ConfigService::V1::ListRevisionsResponse

    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) (defaults to: nil) —

      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) (defaults to: nil) —

      When requesting a page of resources, page_size specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

    • page_token (::String) (defaults to: nil) —

      Token returned by previous call to 'ListRevisions' which specifies the position in the list from where to continue listing the resources.

    • filter (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Field to use to sort the list.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 804

def list_revisions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::ListRevisionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_revisions.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_revisions.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_revisions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.list_revisions request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#lock_deployment(request, options = nil) ⇒ ::Gapic::Operation #lock_deployment(name: nil) ⇒ ::Gapic::Operation

Locks a deployment.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 1488

def lock_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::LockDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.lock_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.lock_deployment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.lock_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.lock_deployment request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


106
107
108
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 106

def universe_domain
  @config_stub.universe_domain
end

#unlock_deployment(request, options = nil) ⇒ ::Gapic::Operation #unlock_deployment(name: nil, lock_id: nil) ⇒ ::Gapic::Operation

Unlocks a locked deployment.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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) (defaults to: nil) —

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

    • lock_id (::Integer) (defaults to: nil) —

      Required. Lock ID of the lock file to be unlocked.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 1577

def unlock_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::UnlockDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.unlock_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.unlock_deployment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.unlock_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.unlock_deployment request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_deployment(request, options = nil) ⇒ ::Gapic::Operation #update_deployment(update_mask: nil, deployment: nil, request_id: nil) ⇒ ::Gapic::Operation

Updates a Deployment.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/google/cloud/config_service/v1/config/rest/client.rb', line 579

def update_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ConfigService::V1::UpdateDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::ConfigService::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_deployment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @config_stub.update_deployment request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end