Class: Google::Cloud::VpcAccess::V1::VpcAccessService::Client

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

Overview

Client for the VpcAccessService service.

Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#connector_path, #location_path

Constructor Details

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

Create a new VpcAccessService client object.

Examples:


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

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

Yields:

  • (config)

    Configure the VpcAccessService client.

Yield Parameters:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb', line 140

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/vpcaccess/v1/vpc_access_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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

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

  @vpc_access_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::VpcAccess::V1::VpcAccessService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @vpc_access_service_stub.endpoint
    config.universe_domain = @vpc_access_service_stub.universe_domain
  end
end

Instance Attribute Details

#location_clientGoogle::Cloud::Location::Locations::Client (readonly)

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

Returns:

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


206
207
208
# File 'lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb', line 206

def location_client
  @location_client
end

#operations_client::Google::Cloud::VpcAccess::V1::VpcAccessService::Operations (readonly)

Get the associated client for long-running operations.



199
200
201
# File 'lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb', line 199

def operations_client
  @operations_client
end

Class Method Details

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

Configure the VpcAccessService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb', line 65

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

    default_config.rpcs.create_connector.timeout = 60.0

    default_config.rpcs.get_connector.timeout = 60.0

    default_config.rpcs.list_connectors.timeout = 60.0

    default_config.rpcs.delete_connector.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

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



110
111
112
113
# File 'lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb', line 110

def configure
  yield @config if block_given?
  @config
end

#create_connector(request, options = nil) ⇒ ::Gapic::Operation #create_connector(parent: nil, connector_id: nil, connector: nil) ⇒ ::Gapic::Operation

Creates a Serverless VPC Access connector, returns an operation.

Examples:

Basic example

require "google/cloud/vpc_access/v1"

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

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

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

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

    Parameters:

    • request (::Google::Cloud::VpcAccess::V1::CreateConnectorRequest, ::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_connector(parent: nil, connector_id: nil, connector: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_connector 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 project and location in which the configuration should be created, specified in the format projects/*/locations/*.

    • connector_id (::String) (defaults to: nil)

      Required. The ID to use for this connector.

    • connector (::Google::Cloud::VpcAccess::V1::Connector, ::Hash) (defaults to: nil)

      Required. Resource to create.

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.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
# File 'lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb', line 266

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VpcAccess::V1::CreateConnectorRequest

  # 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
   = @config.rpcs.create_connector..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @vpc_access_service_stub.call_rpc :create_connector, 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_connector(request, options = nil) ⇒ ::Gapic::Operation #delete_connector(name: nil) ⇒ ::Gapic::Operation

Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

Examples:

Basic example

require "google/cloud/vpc_access/v1"

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

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

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

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

    Parameters:

    • request (::Google::Cloud::VpcAccess::V1::DeleteConnectorRequest, ::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_connector(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_connector 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. Name of a Serverless VPC Access connector to delete.

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.



543
544
545
546
547
548
549
550
551
552
553
554
555
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
# File 'lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb', line 543

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VpcAccess::V1::DeleteConnectorRequest

  # 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
   = @config.rpcs.delete_connector..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @vpc_access_service_stub.call_rpc :delete_connector, 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_connector(request, options = nil) ⇒ ::Google::Cloud::VpcAccess::V1::Connector #get_connector(name: nil) ⇒ ::Google::Cloud::VpcAccess::V1::Connector

Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

Examples:

Basic example

require "google/cloud/vpc_access/v1"

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

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

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

# The returned object is of type Google::Cloud::VpcAccess::V1::Connector.
p result

Overloads:

  • #get_connector(request, options = nil) ⇒ ::Google::Cloud::VpcAccess::V1::Connector

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

    Parameters:

    • request (::Google::Cloud::VpcAccess::V1::GetConnectorRequest, ::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_connector(name: nil) ⇒ ::Google::Cloud::VpcAccess::V1::Connector

    Pass arguments to get_connector 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. Name of a Serverless VPC Access connector 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.



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
# File 'lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb', line 354

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VpcAccess::V1::GetConnectorRequest

  # 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
   = @config.rpcs.get_connector..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @vpc_access_service_stub.call_rpc :get_connector, 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_connectors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::VpcAccess::V1::Connector> #list_connectors(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::VpcAccess::V1::Connector>

Lists Serverless VPC Access connectors.

Examples:

Basic example

require "google/cloud/vpc_access/v1"

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

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

# Call the list_connectors method.
result = client.list_connectors 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::VpcAccess::V1::Connector.
  p item
end

Overloads:

  • #list_connectors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::VpcAccess::V1::Connector>

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

    Parameters:

    • request (::Google::Cloud::VpcAccess::V1::ListConnectorsRequest, ::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_connectors(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::VpcAccess::V1::Connector>

    Pass arguments to list_connectors 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 project and location from which the routes should be listed.

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

      Maximum number of functions to return per call.

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

      Continuation token.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
488
489
# File 'lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb', line 448

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VpcAccess::V1::ListConnectorsRequest

  # 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
   = @config.rpcs.list_connectors..to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
  [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  [:"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("&")
  [:"x-goog-request-params"] ||= request_params_header

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

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

  @vpc_access_service_stub.call_rpc :list_connectors, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @vpc_access_service_stub, :list_connectors, 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

#universe_domainString

The effective universe domain

Returns:

  • (String)


120
121
122
# File 'lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb', line 120

def universe_domain
  @vpc_access_service_stub.universe_domain
end