Distributed Cloud Edge Container V1 API - Class Google::Cloud::EdgeContainer::V1::EdgeContainer::Rest::Client (v0.1.0)

Reference documentation and code samples for the Distributed Cloud Edge Container V1 API class Google::Cloud::EdgeContainer::V1::EdgeContainer::Rest::Client.

REST client for the EdgeContainer service.

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

Inherits

  • Object

Includes

Methods

.configure

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

Configure the EdgeContainer Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all EdgeContainer clients
::Google::Cloud::EdgeContainer::V1::EdgeContainer::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_cluster

def create_cluster(request, options = nil) -> ::Gapic::Operation
def create_cluster(parent: nil, cluster_id: nil, cluster: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Cluster in a given project and location.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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) — Required. The parent location where this cluster will be created.
  • cluster_id (::String) — Required. A client-specified unique identifier for the cluster.
  • cluster (::Google::Cloud::EdgeContainer::V1::Cluster, ::Hash) — Required. The cluster to create.
  • request_id (::String) — 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.
Example

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

#create_node_pool

def create_node_pool(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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) — Required. The parent cluster where this node pool will be created.
  • node_pool_id (::String) — Required. A client-specified unique identifier for the node pool.
  • node_pool (::Google::Cloud::EdgeContainer::V1::NodePool, ::Hash) — Required. The node pool to create.
  • request_id (::String) — 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.
Example

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

#create_vpn_connection

def create_vpn_connection(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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) — Required. The parent location where this vpn connection will be created.
  • vpn_connection_id (::String) — Required. The VPN connection identifier.
  • vpn_connection (::Google::Cloud::EdgeContainer::V1::VpnConnection, ::Hash) — Required. The VPN connection to create.
  • request_id (::String) — 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.
Example

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

#delete_cluster

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

Deletes a single Cluster.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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) — Required. The resource name of the cluster.
  • request_id (::String) — 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.
Example

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

#delete_node_pool

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

Deletes a single NodePool.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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) — Required. The resource name of the node pool.
  • request_id (::String) — 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.
Example

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

#delete_vpn_connection

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

Deletes a single VPN connection.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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) — Required. The resource name of the vpn connection.
  • request_id (::String) — 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.
Example

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

#generate_access_token

def generate_access_token(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::GenerateAccessTokenResponse
def generate_access_token(cluster: nil) -> ::Google::Cloud::EdgeContainer::V1::GenerateAccessTokenResponse

Generates an access token for a Cluster.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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).
Parameter
  • cluster (::String) — 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.
Example

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

#generate_offline_credential

def generate_offline_credential(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::GenerateOfflineCredentialResponse
def generate_offline_credential(cluster: nil) -> ::Google::Cloud::EdgeContainer::V1::GenerateOfflineCredentialResponse

Generates an offline credential for a Cluster.

Overloads 
def generate_offline_credential(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::GenerateOfflineCredentialResponse
Pass arguments to generate_offline_credential via a request object, either of type GenerateOfflineCredentialRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::EdgeContainer::V1::GenerateOfflineCredentialRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def generate_offline_credential(cluster: nil) -> ::Google::Cloud::EdgeContainer::V1::GenerateOfflineCredentialResponse
Pass arguments to generate_offline_credential via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • cluster (::String) — 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.
Example

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

#get_cluster

def get_cluster(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::Cluster
def get_cluster(name: nil) -> ::Google::Cloud::EdgeContainer::V1::Cluster

Gets details of a single Cluster.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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).
Parameter
  • name (::String) — 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.
Example

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

#get_machine

def get_machine(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::Machine
def get_machine(name: nil) -> ::Google::Cloud::EdgeContainer::V1::Machine

Gets details of a single Machine.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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).
Parameter
  • name (::String) — 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.
Example

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

#get_node_pool

def get_node_pool(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::NodePool
def get_node_pool(name: nil) -> ::Google::Cloud::EdgeContainer::V1::NodePool

Gets details of a single NodePool.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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).
Parameter
  • name (::String) — 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.
Example

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

#get_server_config

def get_server_config(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::ServerConfig
def get_server_config(name: nil) -> ::Google::Cloud::EdgeContainer::V1::ServerConfig

Gets the server config.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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).
Parameter
  • name (::String) — 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.
Example

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

#get_vpn_connection

def get_vpn_connection(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::VpnConnection
def get_vpn_connection(name: nil) -> ::Google::Cloud::EdgeContainer::V1::VpnConnection

Gets details of a single VPN connection.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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).
Parameter
  • name (::String) — 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.
Example

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

#initialize

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

Create a new EdgeContainer REST client object.

Yields
  • (config) — Configure the EdgeContainer client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# 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

#list_clusters

def list_clusters(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::ListClustersResponse
def list_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::EdgeContainer::V1::ListClustersResponse

Lists Clusters in a given project and location.

Overloads 
def list_clusters(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::ListClustersResponse
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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::EdgeContainer::V1::ListClustersResponse
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) — Required. The parent location, which owns this collection of clusters.
  • page_size (::Integer) — The maximum number of resources to list.
  • page_token (::String) — A page token received from previous list request. A page token received from previous list request.
  • filter (::String) — Only resources matching this filter will be listed.
  • order_by (::String) — 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.
Example

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

#list_machines

def list_machines(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::ListMachinesResponse
def list_machines(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::EdgeContainer::V1::ListMachinesResponse

Lists Machines in a given project and location.

Overloads 
def list_machines(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::ListMachinesResponse
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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_machines(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::EdgeContainer::V1::ListMachinesResponse
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) — Required. The parent site, which owns this collection of machines.
  • page_size (::Integer) — The maximum number of resources to list.
  • page_token (::String) — A page token received from previous list request.
  • filter (::String) — Only resources matching this filter will be listed.
  • order_by (::String) — 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.
Example

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

#list_node_pools

def list_node_pools(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::ListNodePoolsResponse
def list_node_pools(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::EdgeContainer::V1::ListNodePoolsResponse

Lists NodePools in a given project and location.

Overloads 
def list_node_pools(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::ListNodePoolsResponse
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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_node_pools(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::EdgeContainer::V1::ListNodePoolsResponse
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) — Required. The parent cluster, which owns this collection of node pools.
  • page_size (::Integer) — The maximum number of resources to list.
  • page_token (::String) — A page token received from previous list request.
  • filter (::String) — Only resources matching this filter will be listed.
  • order_by (::String) — 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.
Example

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

#list_vpn_connections

def list_vpn_connections(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::ListVpnConnectionsResponse
def list_vpn_connections(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::EdgeContainer::V1::ListVpnConnectionsResponse

Lists VPN connections in a given project and location.

Overloads 
def list_vpn_connections(request, options = nil) -> ::Google::Cloud::EdgeContainer::V1::ListVpnConnectionsResponse
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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_vpn_connections(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::EdgeContainer::V1::ListVpnConnectionsResponse
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) — Required. The parent location, which owns this collection of VPN connections.
  • page_size (::Integer) — The maximum number of resources to list.
  • page_token (::String) — A page token received from previous list request.
  • filter (::String) — Only resources matching this filter will be listed.
  • order_by (::String) — 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.
Example

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

#location_client

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

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

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

#operations_client

def operations_client() -> ::Google::Cloud::EdgeContainer::V1::EdgeContainer::Rest::Operations

Get the associated client for long-running operations.

Returns

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_cluster

def update_cluster(request, options = nil) -> ::Gapic::Operation
def update_cluster(update_mask: nil, cluster: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single Cluster.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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) — 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) — The updated cluster.
  • request_id (::String) — 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.
Example

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

#update_node_pool

def update_node_pool(request, options = nil) -> ::Gapic::Operation
def update_node_pool(update_mask: nil, node_pool: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single NodePool.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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) — 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) — The updated node pool.
  • request_id (::String) — 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.
Example

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

#upgrade_cluster

def upgrade_cluster(request, options = nil) -> ::Gapic::Operation
def upgrade_cluster(name: nil, target_version: nil, schedule: nil, request_id: nil) -> ::Gapic::Operation

Upgrades a single cluster.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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) — Required. The resource name of the cluster.
  • target_version (::String) — Required. The version the cluster is going to be upgraded to.
  • schedule (::Google::Cloud::EdgeContainer::V1::UpgradeClusterRequest::Schedule) — The schedule for the upgrade.
  • request_id (::String) — 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.
Example

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