Class: Google::Cloud::ApiHub::V1::RuntimeProjectAttachmentService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/client.rb

Overview

REST client for the RuntimeProjectAttachmentService service.

This service is used for managing the runtime project attachments.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#location_path, #project_path, #runtime_project_attachment_path

Constructor Details

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

Create a new RuntimeProjectAttachmentService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::ApiHub::V1::RuntimeProjectAttachmentService::Rest::Client.new

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

Yields:

  • (config) —

    Configure the RuntimeProjectAttachmentService client.

Yield Parameters:



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
193
194
195
 
# File 'lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/client.rb', line 146

def initialize
  # 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

  @runtime_project_attachment_service_stub = ::Google::Cloud::ApiHub::V1::RuntimeProjectAttachmentService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @runtime_project_attachment_service_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @runtime_project_attachment_service_stub.endpoint
    config.universe_domain = @runtime_project_attachment_service_stub.universe_domain
    config.bindings_override = @config.bindings_override
    config.logger = @runtime_project_attachment_service_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)

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

Returns:

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


202
203
204
 
# File 'lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/client.rb', line 202

def location_client
  @location_client
end

Class Method Details

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

Configure the RuntimeProjectAttachmentService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all RuntimeProjectAttachmentService clients
::Google::Cloud::ApiHub::V1::RuntimeProjectAttachmentService::Rest::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
94
95
96
97
98
99
 
# File 'lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/client.rb', line 65

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "ApiHub", "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.rpcs.create_runtime_project_attachment.timeout = 60.0

    default_config.rpcs.get_runtime_project_attachment.timeout = 60.0
    default_config.rpcs.get_runtime_project_attachment.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_runtime_project_attachments.timeout = 60.0
    default_config.rpcs.list_runtime_project_attachments.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.delete_runtime_project_attachment.timeout = 60.0

    default_config.rpcs.lookup_runtime_project_attachment.timeout = 60.0
    default_config.rpcs.lookup_runtime_project_attachment.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

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



116
117
118
119
 
# File 'lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/client.rb', line 116

def configure
  yield @config if block_given?
  @config
end

#create_runtime_project_attachment(request, options = nil) ⇒ ::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment #create_runtime_project_attachment(parent: nil, runtime_project_attachment_id: nil, runtime_project_attachment: nil) ⇒ ::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment

Attaches a runtime project to the host project.

Examples:

Basic example

require "google/cloud/api_hub/v1"

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

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

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

# The returned object is of type Google::Cloud::ApiHub::V1::RuntimeProjectAttachment.
p result

Overloads:

  • #create_runtime_project_attachment(request, options = nil) ⇒ ::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment

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

    Parameters:

    • request (::Google::Cloud::ApiHub::V1::CreateRuntimeProjectAttachmentRequest, ::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_runtime_project_attachment(parent: nil, runtime_project_attachment_id: nil, runtime_project_attachment: nil) ⇒ ::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment

    Pass arguments to create_runtime_project_attachment 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 for the Runtime Project Attachment. Format: projects/{project}/locations/{location}

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

      Required. The ID to use for the Runtime Project Attachment, which will become the final component of the Runtime Project Attachment's name. The ID must be the same as the project ID of the Google cloud project specified in the runtime_project_attachment.runtime_project field.

    • runtime_project_attachment (::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment, ::Hash) (defaults to: nil) —

      Required. The Runtime Project Attachment to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call 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
 
# File 'lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/client.rb', line 266

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiHub::V1::CreateRuntimeProjectAttachmentRequest

  # 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
  call_metadata = @config.rpcs.create_runtime_project_attachment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApiHub::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_runtime_project_attachment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_runtime_project_attachment.retry_policy

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

  @runtime_project_attachment_service_stub.create_runtime_project_attachment request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_runtime_project_attachment(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_runtime_project_attachment(name: nil) ⇒ ::Google::Protobuf::Empty

Delete a runtime project attachment in the API Hub. This call will detach the runtime project from the host project.

Examples:

Basic example

require "google/cloud/api_hub/v1"

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

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

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_runtime_project_attachment(request, options = nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

    • request (::Google::Cloud::ApiHub::V1::DeleteRuntimeProjectAttachmentRequest, ::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_runtime_project_attachment(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_runtime_project_attachment 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. The name of the Runtime Project Attachment to delete. Format: projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
 
# File 'lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/client.rb', line 544

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiHub::V1::DeleteRuntimeProjectAttachmentRequest

  # 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
  call_metadata = @config.rpcs.delete_runtime_project_attachment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApiHub::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_runtime_project_attachment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_runtime_project_attachment.retry_policy

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

  @runtime_project_attachment_service_stub.delete_runtime_project_attachment request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_runtime_project_attachment(request, options = nil) ⇒ ::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment #get_runtime_project_attachment(name: nil) ⇒ ::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment

Gets a runtime project attachment.

Examples:

Basic example

require "google/cloud/api_hub/v1"

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

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

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

# The returned object is of type Google::Cloud::ApiHub::V1::RuntimeProjectAttachment.
p result

Overloads:

  • #get_runtime_project_attachment(request, options = nil) ⇒ ::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment

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

    Parameters:

    • request (::Google::Cloud::ApiHub::V1::GetRuntimeProjectAttachmentRequest, ::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_runtime_project_attachment(name: nil) ⇒ ::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment

    Pass arguments to get_runtime_project_attachment 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. The name of the API resource to retrieve. Format: projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
371
372
373
374
375
376
377
378
379
 
# File 'lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/client.rb', line 346

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiHub::V1::GetRuntimeProjectAttachmentRequest

  # 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
  call_metadata = @config.rpcs.get_runtime_project_attachment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApiHub::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_runtime_project_attachment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_runtime_project_attachment.retry_policy

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

  @runtime_project_attachment_service_stub.get_runtime_project_attachment request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_runtime_project_attachments(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment> #list_runtime_project_attachments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment>

List runtime projects attached to the host project.

Examples:

Basic example

require "google/cloud/api_hub/v1"

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

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

# Call the list_runtime_project_attachments method.
result = client.list_runtime_project_attachments 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::ApiHub::V1::RuntimeProjectAttachment.
  p item
end

Overloads:

  • #list_runtime_project_attachments(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment>

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

    Parameters:

    • request (::Google::Cloud::ApiHub::V1::ListRuntimeProjectAttachmentsRequest, ::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_runtime_project_attachments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApiHub::V1::RuntimeProjectAttachment>

    Pass arguments to list_runtime_project_attachments 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, which owns this collection of runtime project attachments. Format: projects/{project}/locations/{location}

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

      Optional. The maximum number of runtime project attachments to return. The service may return fewer than this value. If unspecified, at most 50 runtime project attachments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

      Optional. A page token, received from a previous ListRuntimeProjectAttachments call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters (except page_size) provided to ListRuntimeProjectAttachments must match the call that provided the page token.

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

      Optional. An expression that filters the list of RuntimeProjectAttachments.

      A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported.

      The following fields in the RuntimeProjectAttachment are eligible for filtering:

      • name - The name of the RuntimeProjectAttachment.
      • create_time - The time at which the RuntimeProjectAttachment was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format.
      • runtime_project - The Google cloud project associated with the RuntimeProjectAttachment.
    • order_by (::String) (defaults to: nil) —

      Optional. Hint for how to order the results.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
490
491
492
493
494
495
496
 
# File 'lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/client.rb', line 461

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiHub::V1::ListRuntimeProjectAttachmentsRequest

  # 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
  call_metadata = @config.rpcs.list_runtime_project_attachments.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApiHub::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_runtime_project_attachments.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_runtime_project_attachments.retry_policy

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

  @runtime_project_attachment_service_stub.list_runtime_project_attachments request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @runtime_project_attachment_service_stub, :list_runtime_project_attachments, "runtime_project_attachments", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


209
210
211
 
# File 'lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/client.rb', line 209

def logger
  @runtime_project_attachment_service_stub.logger
end

#lookup_runtime_project_attachment(request, options = nil) ⇒ ::Google::Cloud::ApiHub::V1::LookupRuntimeProjectAttachmentResponse #lookup_runtime_project_attachment(name: nil) ⇒ ::Google::Cloud::ApiHub::V1::LookupRuntimeProjectAttachmentResponse

Look up a runtime project attachment. This API can be called in the context of any project.

Examples:

Basic example

require "google/cloud/api_hub/v1"

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

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

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

# The returned object is of type Google::Cloud::ApiHub::V1::LookupRuntimeProjectAttachmentResponse.
p result

Overloads:

  • #lookup_runtime_project_attachment(request, options = nil) ⇒ ::Google::Cloud::ApiHub::V1::LookupRuntimeProjectAttachmentResponse

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

    Parameters:

    • request (::Google::Cloud::ApiHub::V1::LookupRuntimeProjectAttachmentRequest, ::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.

  • #lookup_runtime_project_attachment(name: nil) ⇒ ::Google::Cloud::ApiHub::V1::LookupRuntimeProjectAttachmentResponse

    Pass arguments to lookup_runtime_project_attachment 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. Runtime project ID to look up runtime project attachment for. Lookup happens across all regions. Expected format: projects/{project}/locations/{location}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/client.rb', line 625

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiHub::V1::LookupRuntimeProjectAttachmentRequest

  # 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
  call_metadata = @config.rpcs.lookup_runtime_project_attachment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::ApiHub::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.lookup_runtime_project_attachment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.lookup_runtime_project_attachment.retry_policy

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

  @runtime_project_attachment_service_stub.lookup_runtime_project_attachment request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


126
127
128
 
# File 'lib/google/cloud/api_hub/v1/runtime_project_attachment_service/rest/client.rb', line 126

def universe_domain
  @runtime_project_attachment_service_stub.universe_domain
end