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

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

Overview

REST client for the HostProjectRegistrationService service.

This service is used for managing the host project registrations.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#host_project_registration_path, #location_path, #project_path

Constructor Details

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

Create a new HostProjectRegistrationService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the HostProjectRegistrationService client.

Yield Parameters:



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

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

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

  @host_project_registration_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 = @host_project_registration_service_stub.endpoint
    config.universe_domain = @host_project_registration_service_stub.universe_domain
    config.bindings_override = @config.bindings_override
    config.logger = @host_project_registration_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) 


195
196
197
 
# File 'lib/google/cloud/api_hub/v1/host_project_registration_service/rest/client.rb', line 195

def location_client
  @location_client
end

Class Method Details

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

Configure the HostProjectRegistrationService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all HostProjectRegistrationService clients
::Google::Cloud::ApiHub::V1::HostProjectRegistrationService::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
 
# File 'lib/google/cloud/api_hub/v1/host_project_registration_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_host_project_registration.timeout = 60.0

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

    default_config.rpcs.list_host_project_registrations.timeout = 60.0
    default_config.rpcs.list_host_project_registrations.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 HostProjectRegistrationService 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:



109
110
111
112
 
# File 'lib/google/cloud/api_hub/v1/host_project_registration_service/rest/client.rb', line 109

def configure
  yield @config if block_given?
  @config
end

#create_host_project_registration(request, options = nil) ⇒ ::Google::Cloud::ApiHub::V1::HostProjectRegistration #create_host_project_registration(parent: nil, host_project_registration_id: nil, host_project_registration: nil) ⇒ ::Google::Cloud::ApiHub::V1::HostProjectRegistration

Create a host project registration. A Google cloud project can be registered as a host project if it is not attached as a runtime project to another host project. A project can be registered as a host project only once. Subsequent register calls for the same project will fail.

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

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

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

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

Overloads:

  • #create_host_project_registration(request, options = nil) ⇒ ::Google::Cloud::ApiHub::V1::HostProjectRegistration

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

    Parameters:

    • request (::Google::Cloud::ApiHub::V1::CreateHostProjectRegistrationRequest, ::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_host_project_registration(parent: nil, host_project_registration_id: nil, host_project_registration: nil) ⇒ ::Google::Cloud::ApiHub::V1::HostProjectRegistration

    Pass arguments to create_host_project_registration 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 host project. Format: projects/{project}/locations/{location}

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

      Required. The ID to use for the Host Project Registration, which will become the final component of the host project registration's resource name. The ID must be the same as the Google cloud project specified in the host_project_registration.gcp_project field.

    • host_project_registration (::Google::Cloud::ApiHub::V1::HostProjectRegistration, ::Hash) (defaults to: nil) —

      Required. The host project registration to register.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



263
264
265
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
 
# File 'lib/google/cloud/api_hub/v1/host_project_registration_service/rest/client.rb', line 263

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

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

  # 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_host_project_registration.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_host_project_registration.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_host_project_registration.retry_policy

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

  @host_project_registration_service_stub.create_host_project_registration 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_host_project_registration(request, options = nil) ⇒ ::Google::Cloud::ApiHub::V1::HostProjectRegistration #get_host_project_registration(name: nil) ⇒ ::Google::Cloud::ApiHub::V1::HostProjectRegistration

Get a host project registration.

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

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

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

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

Overloads:

  • #get_host_project_registration(request, options = nil) ⇒ ::Google::Cloud::ApiHub::V1::HostProjectRegistration

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

    Parameters:

    • request (::Google::Cloud::ApiHub::V1::GetHostProjectRegistrationRequest, ::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_host_project_registration(name: nil) ⇒ ::Google::Cloud::ApiHub::V1::HostProjectRegistration

    Pass arguments to get_host_project_registration 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. Host project registration resource name. projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration_id}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
371
372
373
374
375
 
# File 'lib/google/cloud/api_hub/v1/host_project_registration_service/rest/client.rb', line 342

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

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

  # 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_host_project_registration.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_host_project_registration.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_host_project_registration.retry_policy

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

  @host_project_registration_service_stub.get_host_project_registration 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_host_project_registrations(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApiHub::V1::HostProjectRegistration> #list_host_project_registrations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ApiHub::V1::HostProjectRegistration>

Lists host project registrations.

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

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

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

Overloads:

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

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

    Parameters:

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

    Pass arguments to list_host_project_registrations 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 host projects. Format: projects/*/locations/*

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

      Optional. The maximum number of host project registrations to return. The service may return fewer than this value. If unspecified, at most 50 host project registrations 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 ListHostProjectRegistrations call. Provide this to retrieve the subsequent page.

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

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

      Optional. An expression that filters the list of HostProjectRegistrations.

      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 HostProjectRegistration are eligible for filtering:

      • name - The name of the HostProjectRegistration.
      • create_time - The time at which the HostProjectRegistration was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format.
      • gcp_project - The Google cloud project associated with the HostProjectRegistration.
    • 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.



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
490
491
492
 
# File 'lib/google/cloud/api_hub/v1/host_project_registration_service/rest/client.rb', line 457

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

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

  # 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_host_project_registrations.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_host_project_registrations.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_host_project_registrations.retry_policy

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

  @host_project_registration_service_stub.list_host_project_registrations request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @host_project_registration_service_stub, :list_host_project_registrations, "host_project_registrations", 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) 


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

def logger
  @host_project_registration_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


119
120
121
 
# File 'lib/google/cloud/api_hub/v1/host_project_registration_service/rest/client.rb', line 119

def universe_domain
  @host_project_registration_service_stub.universe_domain
end