Class: Google::Cloud::EdgeContainer::V1::EdgeContainer::Rest::Client

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

Overview

REST client for the EdgeContainer service.

EdgeContainer API provides management of Kubernetes Clusters on Google Edge Cloud deployments.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#cluster_path, #crypto_key_path, #crypto_key_version_path, #location_path, #machine_path, #node_pool_path, #vpn_connection_path

Constructor Details

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

Create a new EdgeContainer REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the EdgeContainer client.

Yield Parameters:



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 201

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::EdgeContainer::V1::EdgeContainer::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

  @edge_container_stub = ::Google::Cloud::EdgeContainer::V1::EdgeContainer::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @edge_container_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @edge_container_stub.endpoint
    config.universe_domain = @edge_container_stub.universe_domain
    config.bindings_override = @config.bindings_override
    config.logger = @edge_container_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

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


271
272
273
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 271

def location_client
  @location_client
end

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

Get the associated client for long-running operations.

Returns:



264
265
266
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 264

def operations_client
  @operations_client
end

Class Method Details

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

Configure the EdgeContainer Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 66

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "EdgeContainer", "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.rpcs.list_clusters.timeout = 60.0
    default_config.rpcs.list_clusters.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_cluster.timeout = 60.0
    default_config.rpcs.get_cluster.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_cluster.timeout = 60.0

    default_config.rpcs.update_cluster.timeout = 60.0

    default_config.rpcs.upgrade_cluster.timeout = 60.0

    default_config.rpcs.delete_cluster.timeout = 60.0

    default_config.rpcs.generate_access_token.timeout = 60.0
    default_config.rpcs.generate_access_token.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.generate_offline_credential.timeout = 60.0
    default_config.rpcs.generate_offline_credential.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_node_pools.timeout = 60.0
    default_config.rpcs.list_node_pools.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_node_pool.timeout = 60.0
    default_config.rpcs.get_node_pool.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_node_pool.timeout = 60.0

    default_config.rpcs.update_node_pool.timeout = 60.0

    default_config.rpcs.delete_node_pool.timeout = 60.0

    default_config.rpcs.list_machines.timeout = 60.0
    default_config.rpcs.list_machines.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_machine.timeout = 60.0
    default_config.rpcs.get_machine.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_vpn_connections.timeout = 60.0
    default_config.rpcs.list_vpn_connections.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_vpn_connection.timeout = 60.0
    default_config.rpcs.get_vpn_connection.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_vpn_connection.timeout = 60.0

    default_config.rpcs.delete_vpn_connection.timeout = 60.0

    default_config.rpcs.get_server_config.timeout = 60.0
    default_config.rpcs.get_server_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the EdgeContainer 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:



171
172
173
174
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 171

def configure
  yield @config if block_given?
  @config
end

#create_cluster(request, options = nil) ⇒ ::Gapic::Operation #create_cluster(parent: nil, cluster_id: nil, cluster: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates a new Cluster in a given project and location.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

# Call the create_cluster method.
result = client.create_cluster 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_cluster(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::CreateClusterRequest, ::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_cluster(parent: nil, cluster_id: nil, cluster: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_cluster 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 location where this cluster will be created.

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

      Required. A client-specified unique identifier for the cluster.

    • cluster (::Google::Cloud::EdgeContainer::V1::Cluster, ::Hash) (defaults to: nil) —

      Required. The cluster to create.

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

      A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

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.



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 513

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::CreateClusterRequest

  # 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_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#create_node_pool(request, options = nil) ⇒ ::Gapic::Operation #create_node_pool(parent: nil, node_pool_id: nil, node_pool: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates a new NodePool in a given project and location.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

# Call the create_node_pool method.
result = client.create_node_pool 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_node_pool(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::CreateNodePoolRequest, ::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_node_pool(parent: nil, node_pool_id: nil, node_pool: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_node_pool 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 cluster where this node pool will be created.

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

      Required. A client-specified unique identifier for the node pool.

    • node_pool (::Google::Cloud::EdgeContainer::V1::NodePool, ::Hash) (defaults to: nil) —

      Required. The node pool to create.

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

      A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

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.



1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 1217

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::CreateNodePoolRequest

  # 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_node_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#create_vpn_connection(request, options = nil) ⇒ ::Gapic::Operation #create_vpn_connection(parent: nil, vpn_connection_id: nil, vpn_connection: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates a new VPN connection in a given project and location.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

# Call the create_vpn_connection method.
result = client.create_vpn_connection 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_vpn_connection(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::CreateVpnConnectionRequest, ::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_vpn_connection(parent: nil, vpn_connection_id: nil, vpn_connection: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_vpn_connection 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 location where this vpn connection will be created.

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

      Required. The VPN connection identifier.

    • vpn_connection (::Google::Cloud::EdgeContainer::V1::VpnConnection, ::Hash) (defaults to: nil) —

      Required. The VPN connection to create.

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

      A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

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.



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
1875
1876
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 1841

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::CreateVpnConnectionRequest

  # 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_vpn_connection.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

Deletes a single Cluster.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

# Call the delete_cluster method.
result = client.delete_cluster 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_cluster(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::DeleteClusterRequest, ::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_cluster(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_cluster 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 resource name of the cluster.

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

      A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

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.



796
797
798
799
800
801
802
803
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
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 796

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::DeleteClusterRequest

  # 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_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

Deletes a single NodePool.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

# Call the delete_node_pool method.
result = client.delete_node_pool 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_node_pool(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::DeleteNodePoolRequest, ::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_node_pool(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_node_pool 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 resource name of the node pool.

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

      A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

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.



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
1436
1437
1438
1439
1440
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 1405

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::DeleteNodePoolRequest

  # 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_node_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

Deletes a single VPN connection.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

# Call the delete_vpn_connection method.
result = client.delete_vpn_connection 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_vpn_connection(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::DeleteVpnConnectionRequest, ::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_vpn_connection(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_vpn_connection 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 resource name of the vpn connection.

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

      A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

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.



1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 1932

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::DeleteVpnConnectionRequest

  # 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_vpn_connection.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#generate_access_token(request, options = nil) ⇒ ::Google::Cloud::EdgeContainer::V1::GenerateAccessTokenResponse #generate_access_token(cluster: nil) ⇒ ::Google::Cloud::EdgeContainer::V1::GenerateAccessTokenResponse

Generates an access token for a Cluster.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

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

# The returned object is of type Google::Cloud::EdgeContainer::V1::GenerateAccessTokenResponse.
p result

Overloads:

  • #generate_access_token(request, options = nil) ⇒ ::Google::Cloud::EdgeContainer::V1::GenerateAccessTokenResponse

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::GenerateAccessTokenRequest, ::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.

  • #generate_access_token(cluster: nil) ⇒ ::Google::Cloud::EdgeContainer::V1::GenerateAccessTokenResponse

    Pass arguments to generate_access_token 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:

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

      Required. The resource name of the cluster.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



876
877
878
879
880
881
882
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
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 876

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::GenerateAccessTokenRequest

  # 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.generate_access_token.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#generate_offline_credential(request, options = nil) ⇒ ::Google::Cloud::EdgeContainer::V1::GenerateOfflineCredentialResponse #generate_offline_credential(cluster: nil) ⇒ ::Google::Cloud::EdgeContainer::V1::GenerateOfflineCredentialResponse

Generates an offline credential for a Cluster.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

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

# The returned object is of type Google::Cloud::EdgeContainer::V1::GenerateOfflineCredentialResponse.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



954
955
956
957
958
959
960
961
962
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
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 954

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::GenerateOfflineCredentialRequest

  # 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.generate_offline_credential.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#get_cluster(request, options = nil) ⇒ ::Google::Cloud::EdgeContainer::V1::Cluster #get_cluster(name: nil) ⇒ ::Google::Cloud::EdgeContainer::V1::Cluster

Gets details of a single Cluster.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

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

# The returned object is of type Google::Cloud::EdgeContainer::V1::Cluster.
p result

Overloads:

  • #get_cluster(request, options = nil) ⇒ ::Google::Cloud::EdgeContainer::V1::Cluster

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::GetClusterRequest, ::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_cluster(name: nil) ⇒ ::Google::Cloud::EdgeContainer::V1::Cluster

    Pass arguments to get_cluster 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 resource name of the cluster.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 420

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::GetClusterRequest

  # 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_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#get_machine(request, options = nil) ⇒ ::Google::Cloud::EdgeContainer::V1::Machine #get_machine(name: nil) ⇒ ::Google::Cloud::EdgeContainer::V1::Machine

Gets details of a single Machine.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

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

# The returned object is of type Google::Cloud::EdgeContainer::V1::Machine.
p result

Overloads:

  • #get_machine(request, options = nil) ⇒ ::Google::Cloud::EdgeContainer::V1::Machine

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::GetMachineRequest, ::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_machine(name: nil) ⇒ ::Google::Cloud::EdgeContainer::V1::Machine

    Pass arguments to get_machine 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 resource name of the machine.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

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
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 1577

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::GetMachineRequest

  # 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_machine.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#get_node_pool(request, options = nil) ⇒ ::Google::Cloud::EdgeContainer::V1::NodePool #get_node_pool(name: nil) ⇒ ::Google::Cloud::EdgeContainer::V1::NodePool

Gets details of a single NodePool.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

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

# The returned object is of type Google::Cloud::EdgeContainer::V1::NodePool.
p result

Overloads:

  • #get_node_pool(request, options = nil) ⇒ ::Google::Cloud::EdgeContainer::V1::NodePool

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::GetNodePoolRequest, ::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_node_pool(name: nil) ⇒ ::Google::Cloud::EdgeContainer::V1::NodePool

    Pass arguments to get_node_pool 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 resource name of the node pool.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 1124

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::GetNodePoolRequest

  # 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_node_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#get_server_config(request, options = nil) ⇒ ::Google::Cloud::EdgeContainer::V1::ServerConfig #get_server_config(name: nil) ⇒ ::Google::Cloud::EdgeContainer::V1::ServerConfig

Gets the server config.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

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

# The returned object is of type Google::Cloud::EdgeContainer::V1::ServerConfig.
p result

Overloads:

  • #get_server_config(request, options = nil) ⇒ ::Google::Cloud::EdgeContainer::V1::ServerConfig

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::GetServerConfigRequest, ::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_server_config(name: nil) ⇒ ::Google::Cloud::EdgeContainer::V1::ServerConfig

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

    Parameters:

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

      Required. The name (project and location) of the server config to get, specified in the format projects/*/locations/*.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 2013

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::GetServerConfigRequest

  # 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_server_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#get_vpn_connection(request, options = nil) ⇒ ::Google::Cloud::EdgeContainer::V1::VpnConnection #get_vpn_connection(name: nil) ⇒ ::Google::Cloud::EdgeContainer::V1::VpnConnection

Gets details of a single VPN connection.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

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

# The returned object is of type Google::Cloud::EdgeContainer::V1::VpnConnection.
p result

Overloads:

  • #get_vpn_connection(request, options = nil) ⇒ ::Google::Cloud::EdgeContainer::V1::VpnConnection

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::GetVpnConnectionRequest, ::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_vpn_connection(name: nil) ⇒ ::Google::Cloud::EdgeContainer::V1::VpnConnection

    Pass arguments to get_vpn_connection 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 resource name of the vpn connection.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 1748

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::GetVpnConnectionRequest

  # 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_vpn_connection.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#list_clusters(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::Cluster> #list_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::Cluster>

Lists Clusters in a given project and location.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

# Call the list_clusters method.
result = client.list_clusters 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::EdgeContainer::V1::Cluster.
  p item
end

Overloads:

  • #list_clusters(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::Cluster>

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::ListClustersRequest, ::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_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::Cluster>

    Pass arguments to list_clusters 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 location, which owns this collection of clusters.

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

      The maximum number of resources to list.

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

      A page token received from previous list request. A page token received from previous list request.

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

      Only resources matching this filter will be listed.

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

      Specifies the order in which resources will be listed.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 340

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::ListClustersRequest

  # 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_clusters.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @edge_container_stub.list_clusters request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @edge_container_stub, :list_clusters, "clusters", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_machines(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::Machine> #list_machines(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::Machine>

Lists Machines in a given project and location.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

# Call the list_machines method.
result = client.list_machines 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::EdgeContainer::V1::Machine.
  p item
end

Overloads:

  • #list_machines(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::Machine>

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::ListMachinesRequest, ::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_machines(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::Machine>

    Pass arguments to list_machines 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 site, which owns this collection of machines.

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

      The maximum number of resources to list.

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

      A page token received from previous list request.

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

      Only resources matching this filter will be listed.

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

      Specifies the order in which resources will be listed.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 1497

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::ListMachinesRequest

  # 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_machines.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @edge_container_stub.list_machines request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @edge_container_stub, :list_machines, "machines", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_node_pools(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::NodePool> #list_node_pools(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::NodePool>

Lists NodePools in a given project and location.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

# Call the list_node_pools method.
result = client.list_node_pools 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::EdgeContainer::V1::NodePool.
  p item
end

Overloads:

  • #list_node_pools(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::NodePool>

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::ListNodePoolsRequest, ::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_node_pools(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::NodePool>

    Pass arguments to list_node_pools 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 cluster, which owns this collection of node pools.

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

      The maximum number of resources to list.

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

      A page token received from previous list request.

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

      Only resources matching this filter will be listed.

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

      Specifies the order in which resources will be listed.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 1044

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::ListNodePoolsRequest

  # 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_node_pools.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @edge_container_stub.list_node_pools request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @edge_container_stub, :list_node_pools, "node_pools", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_vpn_connections(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::VpnConnection> #list_vpn_connections(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::VpnConnection>

Lists VPN connections in a given project and location.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

# Call the list_vpn_connections method.
result = client.list_vpn_connections 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::EdgeContainer::V1::VpnConnection.
  p item
end

Overloads:

  • #list_vpn_connections(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::VpnConnection>

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::ListVpnConnectionsRequest, ::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_vpn_connections(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::EdgeContainer::V1::VpnConnection>

    Pass arguments to list_vpn_connections 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 location, which owns this collection of VPN connections.

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

      The maximum number of resources to list.

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

      A page token received from previous list request.

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

      Only resources matching this filter will be listed.

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

      Specifies the order in which resources will be listed.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 1668

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::ListVpnConnectionsRequest

  # 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_vpn_connections.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @edge_container_stub.list_vpn_connections request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @edge_container_stub, :list_vpn_connections, "vpn_connections", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


278
279
280
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 278

def logger
  @edge_container_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


181
182
183
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 181

def universe_domain
  @edge_container_stub.universe_domain
end

#update_cluster(request, options = nil) ⇒ ::Gapic::Operation #update_cluster(update_mask: nil, cluster: nil, request_id: nil) ⇒ ::Gapic::Operation

Updates the parameters of a single Cluster.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

# Call the update_cluster method.
result = client.update_cluster 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_cluster(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::UpdateClusterRequest, ::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_cluster(update_mask: nil, cluster: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_cluster 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) —

      Field mask is used to specify the fields to be overwritten in the Cluster 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.

    • cluster (::Google::Cloud::EdgeContainer::V1::Cluster, ::Hash) (defaults to: nil) —

      The updated cluster.

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

      A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

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.



610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 610

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::UpdateClusterRequest

  # 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_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#update_node_pool(request, options = nil) ⇒ ::Gapic::Operation #update_node_pool(update_mask: nil, node_pool: nil, request_id: nil) ⇒ ::Gapic::Operation

Updates the parameters of a single NodePool.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

# Call the update_node_pool method.
result = client.update_node_pool 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_node_pool(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::UpdateNodePoolRequest, ::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_node_pool(update_mask: nil, node_pool: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_node_pool 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) —

      Field mask is used to specify the fields to be overwritten in the NodePool 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.

    • node_pool (::Google::Cloud::EdgeContainer::V1::NodePool, ::Hash) (defaults to: nil) —

      The updated node pool.

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

      A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

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.



1314
1315
1316
1317
1318
1319
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
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 1314

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::UpdateNodePoolRequest

  # 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_node_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#upgrade_cluster(request, options = nil) ⇒ ::Gapic::Operation #upgrade_cluster(name: nil, target_version: nil, schedule: nil, request_id: nil) ⇒ ::Gapic::Operation

Upgrades a single cluster.

Examples:

Basic example

require "google/cloud/edge_container/v1"

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

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

# Call the upgrade_cluster method.
result = client.upgrade_cluster 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:

  • #upgrade_cluster(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::EdgeContainer::V1::UpgradeClusterRequest, ::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.

  • #upgrade_cluster(name: nil, target_version: nil, schedule: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to upgrade_cluster 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 resource name of the cluster.

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

      Required. The version the cluster is going to be upgraded to.

    • schedule (::Google::Cloud::EdgeContainer::V1::UpgradeClusterRequest::Schedule) (defaults to: nil) —

      The schedule for the upgrade.

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

      A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if request_id is provided.

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.



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/google/cloud/edge_container/v1/edge_container/rest/client.rb', line 705

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::EdgeContainer::V1::UpgradeClusterRequest

  # 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.upgrade_cluster.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::EdgeContainer::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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