Network Connectivity V1 API - Class Google::Cloud::NetworkConnectivity::V1::DataTransferService::Client (v1.9.0)

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

Client for the DataTransferService service.

DataTransferService is the service for the Data Transfer API.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the DataTransferService 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 DataTransferService clients
::Google::Cloud::NetworkConnectivity::V1::DataTransferService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the DataTransferService 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_destination

def create_destination(request, options = nil) -> ::Gapic::Operation
def create_destination(parent: nil, destination_id: nil, destination: nil, request_id: nil) -> ::Gapic::Operation

Creates a Destination resource in a specified project and location.

Overloads 
def create_destination(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_destination via a request object, either of type CreateDestinationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::CreateDestinationRequest, ::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_destination(parent: nil, destination_id: nil, destination: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_destination 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 name of the parent resource.
  • destination_id (::String) — Required. The ID to use for the Destination resource, which becomes the final component of the Destination resource name.
  • destination (::Google::Cloud::NetworkConnectivity::V1::Destination, ::Hash) — Required. The Destination resource to create.
  • request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate Destination resources.

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

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::DataTransferService::Client.new

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

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

def create_multicloud_data_transfer_config(request, options = nil) -> ::Gapic::Operation
def create_multicloud_data_transfer_config(parent: nil, multicloud_data_transfer_config_id: nil, multicloud_data_transfer_config: nil, request_id: nil) -> ::Gapic::Operation

Creates a MulticloudDataTransferConfig resource in a specified project and location.

Overloads 
def create_multicloud_data_transfer_config(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_multicloud_data_transfer_config via a request object, either of type CreateMulticloudDataTransferConfigRequest or an equivalent Hash.
Parameters 
def create_multicloud_data_transfer_config(parent: nil, multicloud_data_transfer_config_id: nil, multicloud_data_transfer_config: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_multicloud_data_transfer_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The name of the parent resource.
  • multicloud_data_transfer_config_id (::String) — Required. The ID to use for the MulticloudDataTransferConfig resource, which becomes the final component of the MulticloudDataTransferConfig resource name.
  • multicloud_data_transfer_config (::Google::Cloud::NetworkConnectivity::V1::MulticloudDataTransferConfig, ::Hash) — Required. The MulticloudDataTransferConfig resource to create.
  • request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate MulticloudDataTransferConfig resources.

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

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::DataTransferService::Client.new

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

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

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

#delete_destination

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

Deletes a Destination resource.

Overloads 
def delete_destination(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_destination via a request object, either of type Google::Cloud::NetworkConnectivity::V1::DeleteDestinationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::DeleteDestinationRequest, ::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_destination(name: nil, request_id: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_destination 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 Destination resource to delete.
  • request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request.

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

  • etag (::String) — Optional. The etag is computed by the server, and might be sent with update and delete requests so that 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::DataTransferService::Client.new

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

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

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

Deletes a MulticloudDataTransferConfig resource.

Overloads 
def delete_multicloud_data_transfer_config(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_multicloud_data_transfer_config via a request object, either of type Google::Cloud::NetworkConnectivity::V1::DeleteMulticloudDataTransferConfigRequest or an equivalent Hash.
Parameters 
def delete_multicloud_data_transfer_config(name: nil, request_id: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_multicloud_data_transfer_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the MulticloudDataTransferConfig resource to delete.
  • request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate MulticloudDataTransferConfig resources.

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

  • etag (::String) — Optional. The etag is computed by the server, and might be sent with update and delete requests so that 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::DataTransferService::Client.new

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

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

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

#get_destination

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

Gets the details of a Destination resource.

Overloads 
def get_destination(request, options = nil) -> ::Google::Cloud::NetworkConnectivity::V1::Destination
Pass arguments to get_destination via a request object, either of type GetDestinationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::GetDestinationRequest, ::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_destination(name: nil) -> ::Google::Cloud::NetworkConnectivity::V1::Destination
Pass arguments to get_destination via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the Destination resource to get.
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::DataTransferService::Client.new

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

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

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

#get_multicloud_data_transfer_config

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

Gets the details of a MulticloudDataTransferConfig resource.

Overloads 
def get_multicloud_data_transfer_config(request, options = nil) -> ::Google::Cloud::NetworkConnectivity::V1::MulticloudDataTransferConfig
Pass arguments to get_multicloud_data_transfer_config via a request object, either of type GetMulticloudDataTransferConfigRequest or an equivalent Hash.
Parameters 
def get_multicloud_data_transfer_config(name: nil) -> ::Google::Cloud::NetworkConnectivity::V1::MulticloudDataTransferConfig
Pass arguments to get_multicloud_data_transfer_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the MulticloudDataTransferConfig resource to get.
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::DataTransferService::Client.new

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

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

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

#get_multicloud_data_transfer_supported_service

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

Gets the details of a service that is supported for Data Transfer Essentials.

Overloads 
def get_multicloud_data_transfer_supported_service(request, options = nil) -> ::Google::Cloud::NetworkConnectivity::V1::MulticloudDataTransferSupportedService
Pass arguments to get_multicloud_data_transfer_supported_service via a request object, either of type GetMulticloudDataTransferSupportedServiceRequest or an equivalent Hash.
Parameters 
def get_multicloud_data_transfer_supported_service(name: nil) -> ::Google::Cloud::NetworkConnectivity::V1::MulticloudDataTransferSupportedService
Pass arguments to get_multicloud_data_transfer_supported_service via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the service.
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::DataTransferService::Client.new

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

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

# The returned object is of type Google::Cloud::NetworkConnectivity::V1::MulticloudDataTransferSupportedService.
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 DataTransferService client object.

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

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

#list_destinations

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

Lists the Destination resources in a specified project and location.

Overloads 
def list_destinations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::Destination>
Pass arguments to list_destinations via a request object, either of type ListDestinationsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::ListDestinationsRequest, ::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_destinations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, return_partial_success: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::Destination>
Pass arguments to list_destinations 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 name of the parent resource.
  • page_size (::Integer) — Optional. The maximum number of results listed per page.
  • page_token (::String) — Optional. The page token.
  • filter (::String) — Optional. An expression that filters the results listed in the response.
  • order_by (::String) — Optional. The sort order of the results.
  • return_partial_success (::Boolean) — Optional. If true, allow partial responses for multi-regional aggregated list requests.
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::DataTransferService::Client.new

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

# Call the list_destinations method.
result = client.list_destinations 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::Destination.
  p item
end

#list_multicloud_data_transfer_configs

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

Lists the MulticloudDataTransferConfig resources in a specified project and location.

Overloads 
def list_multicloud_data_transfer_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::MulticloudDataTransferConfig>
Pass arguments to list_multicloud_data_transfer_configs via a request object, either of type ListMulticloudDataTransferConfigsRequest or an equivalent Hash.
Parameters 
def list_multicloud_data_transfer_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil, return_partial_success: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::MulticloudDataTransferConfig>
Pass arguments to list_multicloud_data_transfer_configs 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 name of the parent resource.
  • page_size (::Integer) — Optional. The maximum number of results listed per page.
  • page_token (::String) — Optional. The page token.
  • filter (::String) — Optional. An expression that filters the results listed in the response.
  • order_by (::String) — Optional. The sort order of the results.
  • return_partial_success (::Boolean) — Optional. If true, allows partial responses for multi-regional aggregated list requests.
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::DataTransferService::Client.new

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

# Call the list_multicloud_data_transfer_configs method.
result = client.list_multicloud_data_transfer_configs 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::MulticloudDataTransferConfig.
  p item
end

#list_multicloud_data_transfer_supported_services

def list_multicloud_data_transfer_supported_services(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::MulticloudDataTransferSupportedService>
def list_multicloud_data_transfer_supported_services(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::MulticloudDataTransferSupportedService>

Lists the services in the project for a region that are supported for Data Transfer Essentials.

Overloads 
def list_multicloud_data_transfer_supported_services(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::MulticloudDataTransferSupportedService>
Pass arguments to list_multicloud_data_transfer_supported_services via a request object, either of type ListMulticloudDataTransferSupportedServicesRequest or an equivalent Hash.
Parameters 
def list_multicloud_data_transfer_supported_services(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::MulticloudDataTransferSupportedService>
Pass arguments to list_multicloud_data_transfer_supported_services 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 name of the parent resource.
  • page_size (::Integer) — Optional. The maximum number of results listed per page.
  • page_token (::String) — Optional. The page token.
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::DataTransferService::Client.new

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

# Call the list_multicloud_data_transfer_supported_services method.
result = client.list_multicloud_data_transfer_supported_services 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::MulticloudDataTransferSupportedService.
  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::DataTransferService::Operations

Get the associated client for long-running operations.

Returns

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_destination

def update_destination(request, options = nil) -> ::Gapic::Operation
def update_destination(update_mask: nil, destination: nil, request_id: nil) -> ::Gapic::Operation

Updates a Destination resource in a specified project and location.

Overloads 
def update_destination(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_destination via a request object, either of type UpdateDestinationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkConnectivity::V1::UpdateDestinationRequest, ::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_destination(update_mask: nil, destination: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_destination 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. FieldMask is used to specify the fields to be overwritten in the Destinationresource by the update. The fields specified inupdate_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten.
  • destination (::Google::Cloud::NetworkConnectivity::V1::Destination, ::Hash) — Required. The Destination resource to update.
  • request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request.

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

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::DataTransferService::Client.new

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

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

def update_multicloud_data_transfer_config(request, options = nil) -> ::Gapic::Operation
def update_multicloud_data_transfer_config(update_mask: nil, multicloud_data_transfer_config: nil, request_id: nil) -> ::Gapic::Operation

Updates a MulticloudDataTransferConfig resource in a specified project and location.

Overloads 
def update_multicloud_data_transfer_config(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_multicloud_data_transfer_config via a request object, either of type UpdateMulticloudDataTransferConfigRequest or an equivalent Hash.
Parameters 
def update_multicloud_data_transfer_config(update_mask: nil, multicloud_data_transfer_config: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_multicloud_data_transfer_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. FieldMask is used to specify the fields in the MulticloudDataTransferConfig resource to be overwritten by the update. The fields specified in update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten.
  • multicloud_data_transfer_config (::Google::Cloud::NetworkConnectivity::V1::MulticloudDataTransferConfig, ::Hash) — Required. The MulticloudDataTransferConfig resource to update.
  • request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server waits 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, can ignore the second request. This prevents clients from accidentally creating duplicate MulticloudDataTransferConfig resources.

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

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::DataTransferService::Client.new

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

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

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