Network Connectivity V1 API - Class Google::Cloud::NetworkConnectivity::V1::CrossNetworkAutomationService::Client (v1.4.0)

Reference documentation and code samples for the Network Connectivity V1 API class Google::Cloud::NetworkConnectivity::V1::CrossNetworkAutomationService::Client.

Client for the CrossNetworkAutomationService service.

The service for CrossNetworkAutomation resources.

Inherits

  • Object

Methods

.configure

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

Configure the CrossNetworkAutomationService Client class.

See Configuration for a description of the configuration fields.

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

#configure

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

Configure the CrossNetworkAutomationService 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

#create_service_connection_map

def create_service_connection_map(request, options = nil) -> ::Gapic::Operation
def create_service_connection_map(parent: nil, service_connection_map_id: nil, service_connection_map: nil, request_id: nil) -> ::Gapic::Operation

Creates a new ServiceConnectionMap in a given project and location.

Overloads
def create_service_connection_map(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_service_connection_map via a request object, either of type Google::Cloud::NetworkConnectivity::V1::CreateServiceConnectionMapRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::CreateServiceConnectionMapRequest, ::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_service_connection_map(parent: nil, service_connection_map_id: nil, service_connection_map: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_service_connection_map 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 resource's name of the ServiceConnectionMap. ex. projects/123/locations/us-east1
  • service_connection_map_id (::String) — Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionMaps/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated.
  • service_connection_map (::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionMap, ::Hash) — Required. Initial values for a new ServiceConnectionMaps
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

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

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

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

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

def create_service_connection_policy(request, options = nil) -> ::Gapic::Operation
def create_service_connection_policy(parent: nil, service_connection_policy_id: nil, service_connection_policy: nil, request_id: nil) -> ::Gapic::Operation

Creates a new ServiceConnectionPolicy in a given project and location.

Overloads
def create_service_connection_policy(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_service_connection_policy via a request object, either of type Google::Cloud::NetworkConnectivity::V1::CreateServiceConnectionPolicyRequest or an equivalent Hash.
Parameters
def create_service_connection_policy(parent: nil, service_connection_policy_id: nil, service_connection_policy: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_service_connection_policy 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 resource's name of the ServiceConnectionPolicy. ex. projects/123/locations/us-east1
  • service_connection_policy_id (::String) — Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/serviceConnectionPolicies/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.
  • service_connection_policy (::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionPolicy, ::Hash) — Required. Initial values for a new ServiceConnectionPolicies
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

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

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

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

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

def create_service_connection_token(request, options = nil) -> ::Gapic::Operation
def create_service_connection_token(parent: nil, service_connection_token_id: nil, service_connection_token: nil, request_id: nil) -> ::Gapic::Operation

Creates a new ServiceConnectionToken in a given project and location.

Overloads
def create_service_connection_token(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_service_connection_token via a request object, either of type Google::Cloud::NetworkConnectivity::V1::CreateServiceConnectionTokenRequest or an equivalent Hash.
Parameters
def create_service_connection_token(parent: nil, service_connection_token_id: nil, service_connection_token: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_service_connection_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
  • parent (::String) — Required. The parent resource's name of the ServiceConnectionToken. ex. projects/123/locations/us-east1
  • service_connection_token_id (::String) — Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/ServiceConnectionTokens/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated.
  • service_connection_token (::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionToken, ::Hash) — Required. Initial values for a new ServiceConnectionTokens
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

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

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

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

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

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

Deletes a single ServiceClass.

Overloads
def delete_service_class(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_service_class via a request object, either of type DeleteServiceClassRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::DeleteServiceClassRequest, ::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_service_class(name: nil, request_id: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_service_class via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the ServiceClass to delete.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

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

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

  • etag (::String) — Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

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

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

Deletes a single ServiceConnectionMap.

Overloads
def delete_service_connection_map(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_service_connection_map via a request object, either of type DeleteServiceConnectionMapRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::DeleteServiceConnectionMapRequest, ::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_service_connection_map(name: nil, request_id: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_service_connection_map via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the ServiceConnectionMap to delete.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

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

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

  • etag (::String) — Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

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

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

Deletes a single ServiceConnectionPolicy.

Overloads
def delete_service_connection_policy(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_service_connection_policy via a request object, either of type DeleteServiceConnectionPolicyRequest or an equivalent Hash.
Parameters
def delete_service_connection_policy(name: nil, request_id: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_service_connection_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the ServiceConnectionPolicy to delete.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

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

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

  • etag (::String) — Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

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

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

Deletes a single ServiceConnectionToken.

Overloads
def delete_service_connection_token(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_service_connection_token via a request object, either of type DeleteServiceConnectionTokenRequest or an equivalent Hash.
Parameters
def delete_service_connection_token(name: nil, request_id: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_service_connection_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
  • name (::String) — Required. The name of the ServiceConnectionToken to delete.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

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

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

  • etag (::String) — Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

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

#get_service_class

def get_service_class(request, options = nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceClass
def get_service_class(name: nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceClass

Gets details of a single ServiceClass.

Overloads
def get_service_class(request, options = nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceClass
Pass arguments to get_service_class via a request object, either of type GetServiceClassRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::GetServiceClassRequest, ::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_service_class(name: nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceClass
Pass arguments to get_service_class 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. Name of the ServiceClass to get.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkConnectivity::V1::ServiceClass.
p result

#get_service_connection_map

def get_service_connection_map(request, options = nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionMap
def get_service_connection_map(name: nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionMap

Gets details of a single ServiceConnectionMap.

Overloads
def get_service_connection_map(request, options = nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionMap
Pass arguments to get_service_connection_map via a request object, either of type GetServiceConnectionMapRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::GetServiceConnectionMapRequest, ::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_service_connection_map(name: nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionMap
Pass arguments to get_service_connection_map 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. Name of the ServiceConnectionMap to get.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkConnectivity::V1::ServiceConnectionMap.
p result

#get_service_connection_policy

def get_service_connection_policy(request, options = nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionPolicy
def get_service_connection_policy(name: nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionPolicy

Gets details of a single ServiceConnectionPolicy.

Overloads
def get_service_connection_policy(request, options = nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionPolicy
Pass arguments to get_service_connection_policy via a request object, either of type GetServiceConnectionPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::GetServiceConnectionPolicyRequest, ::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_service_connection_policy(name: nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionPolicy
Pass arguments to get_service_connection_policy 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. Name of the ServiceConnectionPolicy to get.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkConnectivity::V1::ServiceConnectionPolicy.
p result

#get_service_connection_token

def get_service_connection_token(request, options = nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionToken
def get_service_connection_token(name: nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionToken

Gets details of a single ServiceConnectionToken.

Overloads
def get_service_connection_token(request, options = nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionToken
Pass arguments to get_service_connection_token via a request object, either of type GetServiceConnectionTokenRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::GetServiceConnectionTokenRequest, ::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_service_connection_token(name: nil) -> ::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionToken
Pass arguments to get_service_connection_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
  • name (::String) — Required. Name of the ServiceConnectionToken to get.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkConnectivity::V1::ServiceConnectionToken.
p result

#iam_policy_client

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

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

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

#initialize

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

Create a new CrossNetworkAutomationService client object.

Yields
  • (config) — Configure the CrossNetworkAutomationService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example
# Create a client using the default configuration
client = ::Google::Cloud::NetworkConnectivity::V1::CrossNetworkAutomationService::Client.new

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

#list_service_classes

def list_service_classes(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceClass>
def list_service_classes(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceClass>

Lists ServiceClasses in a given project and location.

Overloads
def list_service_classes(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceClass>
Pass arguments to list_service_classes via a request object, either of type ListServiceClassesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::ListServiceClassesRequest, ::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_service_classes(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceClass>
Pass arguments to list_service_classes 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 resource's name. ex. projects/123/locations/us-east1
  • page_size (::Integer) — The maximum number of results per page that should be returned.
  • page_token (::String) — The page token.
  • filter (::String) — A filter expression that filters the results listed in the response.
  • order_by (::String) — Sort the results by a certain order.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

# Call the list_service_classes method.
result = client.list_service_classes 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::NetworkConnectivity::V1::ServiceClass.
  p item
end

#list_service_connection_maps

def list_service_connection_maps(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionMap>
def list_service_connection_maps(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionMap>

Lists ServiceConnectionMaps in a given project and location.

Overloads
def list_service_connection_maps(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionMap>
Pass arguments to list_service_connection_maps via a request object, either of type ListServiceConnectionMapsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::ListServiceConnectionMapsRequest, ::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_service_connection_maps(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionMap>
Pass arguments to list_service_connection_maps 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 resource's name. ex. projects/123/locations/us-east1
  • page_size (::Integer) — The maximum number of results per page that should be returned.
  • page_token (::String) — The page token.
  • filter (::String) — A filter expression that filters the results listed in the response.
  • order_by (::String) — Sort the results by a certain order.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

# Call the list_service_connection_maps method.
result = client.list_service_connection_maps 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::NetworkConnectivity::V1::ServiceConnectionMap.
  p item
end

#list_service_connection_policies

def list_service_connection_policies(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionPolicy>
def list_service_connection_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionPolicy>

Lists ServiceConnectionPolicies in a given project and location.

Overloads
def list_service_connection_policies(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionPolicy>
Pass arguments to list_service_connection_policies via a request object, either of type ListServiceConnectionPoliciesRequest or an equivalent Hash.
Parameters
def list_service_connection_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionPolicy>
Pass arguments to list_service_connection_policies 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 resource's name. ex. projects/123/locations/us-east1
  • page_size (::Integer) — The maximum number of results per page that should be returned.
  • page_token (::String) — The page token.
  • filter (::String) — A filter expression that filters the results listed in the response.
  • order_by (::String) — Sort the results by a certain order.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

# Call the list_service_connection_policies method.
result = client.list_service_connection_policies 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::NetworkConnectivity::V1::ServiceConnectionPolicy.
  p item
end

#list_service_connection_tokens

def list_service_connection_tokens(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionToken>
def list_service_connection_tokens(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionToken>

Lists ServiceConnectionTokens in a given project and location.

Overloads
def list_service_connection_tokens(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionToken>
Pass arguments to list_service_connection_tokens via a request object, either of type ListServiceConnectionTokensRequest or an equivalent Hash.
Parameters
def list_service_connection_tokens(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionToken>
Pass arguments to list_service_connection_tokens 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 resource's name. ex. projects/123/locations/us-east1
  • page_size (::Integer) — The maximum number of results per page that should be returned.
  • page_token (::String) — The page token.
  • filter (::String) — A filter expression that filters the results listed in the response.
  • order_by (::String) — Sort the results by a certain order.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

# Call the list_service_connection_tokens method.
result = client.list_service_connection_tokens 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::NetworkConnectivity::V1::ServiceConnectionToken.
  p item
end

#location_client

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

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

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

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::NetworkConnectivity::V1::CrossNetworkAutomationService::Operations

Get the associated client for long-running operations.

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_service_class

def update_service_class(request, options = nil) -> ::Gapic::Operation
def update_service_class(update_mask: nil, service_class: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single ServiceClass.

Overloads
def update_service_class(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_service_class via a request object, either of type UpdateServiceClassRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::UpdateServiceClassRequest, ::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_service_class(update_mask: nil, service_class: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_service_class via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Field mask is used to specify the fields to be overwritten in the ServiceClass 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.
  • service_class (::Google::Cloud::NetworkConnectivity::V1::ServiceClass, ::Hash) — Required. New values to be patched into the resource.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

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

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

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

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

def update_service_connection_map(request, options = nil) -> ::Gapic::Operation
def update_service_connection_map(update_mask: nil, service_connection_map: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single ServiceConnectionMap.

Overloads
def update_service_connection_map(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_service_connection_map via a request object, either of type UpdateServiceConnectionMapRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::UpdateServiceConnectionMapRequest, ::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_service_connection_map(update_mask: nil, service_connection_map: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_service_connection_map via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Field mask is used to specify the fields to be overwritten in the ServiceConnectionMap 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.
  • service_connection_map (::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionMap, ::Hash) — Required. New values to be patched into the resource.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

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

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

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

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

def update_service_connection_policy(request, options = nil) -> ::Gapic::Operation
def update_service_connection_policy(update_mask: nil, service_connection_policy: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single ServiceConnectionPolicy.

Overloads
def update_service_connection_policy(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_service_connection_policy via a request object, either of type UpdateServiceConnectionPolicyRequest or an equivalent Hash.
Parameters
def update_service_connection_policy(update_mask: nil, service_connection_policy: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_service_connection_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Field mask is used to specify the fields to be overwritten in the ServiceConnectionPolicy 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.
  • service_connection_policy (::Google::Cloud::NetworkConnectivity::V1::ServiceConnectionPolicy, ::Hash) — Required. New values to be patched into the resource.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

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

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

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_connectivity/v1"

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

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

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