Class: Google::Cloud::NetworkManagement::V1::ReachabilityService::Client

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

Overview

Client for the ReachabilityService service.

The Reachability service in the Google Cloud Network Management API provides services that analyze the reachability within a single Google Virtual Private Cloud (VPC) network, between peered VPC networks, between VPC and on-premises networks, or between VPC networks and internet hosts. A reachability analysis is based on Google Cloud network configurations.

You can use the analysis results to verify these configurations and to troubleshoot connectivity issues.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#connectivity_test_path

Constructor Details

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

Create a new ReachabilityService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the ReachabilityService client.

Yield Parameters:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/google/cloud/network_management/v1/reachability_service/client.rb', line 118

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/networkmanagement/v1/reachability_services_pb"

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

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

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

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
  end

  @reachability_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::NetworkManagement::V1::ReachabilityService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::NetworkManagement::V1::ReachabilityService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



166
167
168
 
# File 'lib/google/cloud/network_management/v1/reachability_service/client.rb', line 166

def operations_client
  @operations_client
end

Class Method Details

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

Configure the ReachabilityService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

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

    default_config.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the ReachabilityService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



97
98
99
100
 
# File 'lib/google/cloud/network_management/v1/reachability_service/client.rb', line 97

def configure
  yield @config if block_given?
  @config
end

#create_connectivity_test(request, options = nil) ⇒ ::Gapic::Operation #create_connectivity_test(parent: nil, test_id: nil, resource: nil) ⇒ ::Gapic::Operation

Creates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes.

If the endpoint specifications in ConnectivityTest are invalid (for example, containing non-existent resources in the network, or you don't have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN.

If the endpoint specifications in ConnectivityTest are incomplete, the reachability result returns a value of AMBIGUOUS. For more information, see the Connectivity Test documentation.

Examples:

Basic example

require "google/cloud/network_management/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::NetworkManagement::V1::CreateConnectivityTestRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #create_connectivity_test(parent: nil, test_id: nil, resource: nil) ⇒ ::Gapic::Operation

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

    Parameters:

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

      Required. The parent resource of the Connectivity Test to create: projects/{project_id}/locations/global

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

      Required. The logical name of the Connectivity Test in your project with the following restrictions:

      • Must contain only lowercase letters, numbers, and hyphens.
      • Must start with a letter.
      • Must be between 1-40 characters.
      • Must end with a number or a letter.
      • Must be unique within the customer project
    • resource (::Google::Cloud::NetworkManagement::V1::ConnectivityTest, ::Hash) (defaults to: nil) —

      Required. A ConnectivityTest resource

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.



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/google/cloud/network_management/v1/reachability_service/client.rb', line 447

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkManagement::V1::CreateConnectivityTestRequest

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

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

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

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @reachability_service_stub.call_rpc :create_connectivity_test, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes a specific ConnectivityTest.

Examples:

Basic example

require "google/cloud/network_management/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::NetworkManagement::V1::DeleteConnectivityTestRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #delete_connectivity_test(name: nil) ⇒ ::Gapic::Operation

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

    Parameters:

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

      Required. Connectivity Test resource name using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}

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.



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'lib/google/cloud/network_management/v1/reachability_service/client.rb', line 755

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkManagement::V1::DeleteConnectivityTestRequest

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

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

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

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @reachability_service_stub.call_rpc :delete_connectivity_test, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_connectivity_test(request, options = nil) ⇒ ::Google::Cloud::NetworkManagement::V1::ConnectivityTest #get_connectivity_test(name: nil) ⇒ ::Google::Cloud::NetworkManagement::V1::ConnectivityTest

Gets the details of a specific Connectivity Test.

Examples:

Basic example

require "google/cloud/network_management/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkManagement::V1::ConnectivityTest.
p result

Overloads:

  • #get_connectivity_test(request, options = nil) ⇒ ::Google::Cloud::NetworkManagement::V1::ConnectivityTest

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

    Parameters:

    • request (::Google::Cloud::NetworkManagement::V1::GetConnectivityTestRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #get_connectivity_test(name: nil) ⇒ ::Google::Cloud::NetworkManagement::V1::ConnectivityTest

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

    Parameters:

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

      Required. ConnectivityTest resource name using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/google/cloud/network_management/v1/reachability_service/client.rb', line 331

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkManagement::V1::GetConnectivityTestRequest

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

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

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

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @reachability_service_stub.call_rpc :get_connectivity_test, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_connectivity_tests(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::NetworkManagement::V1::ConnectivityTest> #list_connectivity_tests(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::NetworkManagement::V1::ConnectivityTest>

Lists all Connectivity Tests owned by a project.

Examples:

Basic example

require "google/cloud/network_management/v1"

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

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

# Call the list_connectivity_tests method.
result = client.list_connectivity_tests 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::NetworkManagement::V1::ConnectivityTest.
  p item
end

Overloads:

  • #list_connectivity_tests(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::NetworkManagement::V1::ConnectivityTest>

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

    Parameters:

    • request (::Google::Cloud::NetworkManagement::V1::ListConnectivityTestsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #list_connectivity_tests(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::NetworkManagement::V1::ConnectivityTest>

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

    Parameters:

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

      Required. The parent resource of the Connectivity Tests: projects/{project_id}/locations/global

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

      Number of ConnectivityTests to return.

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

      Page token from an earlier query, as returned in next_page_token.

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

      Lists the ConnectivityTests that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form <field> <operator> <value> where operators: <, >, <=, >=, !=, =, : are supported (colon : represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

      Examples:

      • Filter by name: name = "projects/proj-1/locations/global/connectivityTests/test-1

      • Filter by labels:

        • Resources that have a key called foo labels.foo:*
        • Resources that have a key called foo whose value is bar labels.foo = bar
    • order_by (::String) (defaults to: nil) —

      Field to use to sort the list.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/google/cloud/network_management/v1/reachability_service/client.rb', line 244

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkManagement::V1::ListConnectivityTestsRequest

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

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

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

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @reachability_service_stub.call_rpc :list_connectivity_tests, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @reachability_service_stub, :list_connectivity_tests, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Rerun an existing ConnectivityTest. After the user triggers the rerun, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes.

Even though the test configuration remains the same, the reachability result may change due to underlying network configuration changes.

If the endpoint specifications in ConnectivityTest become invalid (for example, specified resources are deleted in the network, or you lost read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN.

Examples:

Basic example

require "google/cloud/network_management/v1"

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

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

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

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

Overloads:

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

    Pass arguments to rerun_connectivity_test via a request object, either of type Google::Cloud::NetworkManagement::V1::RerunConnectivityTestRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::NetworkManagement::V1::RerunConnectivityTestRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #rerun_connectivity_test(name: nil) ⇒ ::Gapic::Operation

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

    Parameters:

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

      Required. Connectivity Test resource name using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}

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.



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/google/cloud/network_management/v1/reachability_service/client.rb', line 661

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkManagement::V1::RerunConnectivityTestRequest

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

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

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

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @reachability_service_stub.call_rpc :rerun_connectivity_test, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_connectivity_test(request, options = nil) ⇒ ::Gapic::Operation #update_connectivity_test(update_mask: nil, resource: nil) ⇒ ::Gapic::Operation

Updates the configuration of an existing ConnectivityTest. After you update a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. The Reachability state in the test resource is updated with the new result.

If the endpoint specifications in ConnectivityTest are invalid (for example, they contain non-existent resources in the network, or the user does not have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN.

If the endpoint specifications in ConnectivityTest are incomplete, the reachability result returns a value of AMBIGUOUS. See the documentation in ConnectivityTest for for more details.

Examples:

Basic example

require "google/cloud/network_management/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::NetworkManagement::V1::UpdateConnectivityTestRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #update_connectivity_test(update_mask: nil, resource: nil) ⇒ ::Gapic::Operation

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

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.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/google/cloud/network_management/v1/reachability_service/client.rb', line 556

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkManagement::V1::UpdateConnectivityTestRequest

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

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

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

  header_params = {}
  if request.resource&.name
    header_params["resource.name"] = request.resource.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @reachability_service_stub.call_rpc :update_connectivity_test, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end