Class: Google::Cloud::ServiceUsage::V1::ServiceUsage::Rest::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/service_usage/v1/service_usage/rest/client.rb

Overview

REST client for the ServiceUsage service.

Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.

See Service Usage API

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new ServiceUsage REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the ServiceUsage client.

Yield Parameters:



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
160
161
162
163
 
# File 'lib/google/cloud/service_usage/v1/service_usage/rest/client.rb', line 127

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

  @operations_client = ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Rest::Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @service_usage_stub = ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Rest::Operations (readonly)

Get the associated client for long-running operations.

Returns:



170
171
172
 
# File 'lib/google/cloud/service_usage/v1/service_usage/rest/client.rb', line 170

def operations_client
  @operations_client
end

Class Method Details

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

Configure the ServiceUsage Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all ServiceUsage clients
::Google::Cloud::ServiceUsage::V1::ServiceUsage::Rest::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/service_usage/v1/service_usage/rest/client.rb', line 63

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "ServiceUsage", "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

#batch_enable_services(request, options = nil) ⇒ ::Gapic::Operation #batch_enable_services(parent: nil, service_ids: nil) ⇒ ::Gapic::Operation

Enable multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. To enable a single service, use the EnableService method instead.

Examples:

Basic example

require "google/cloud/service_usage/v1"

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

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

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

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

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

    Parameters:

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

  • #batch_enable_services(parent: nil, service_ids: nil) ⇒ ::Gapic::Operation

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

    Parameters:

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

      Parent to enable services on.

      An example name would be: projects/123 where 123 is the project number.

      The BatchEnableServices method currently only supports projects.

    • service_ids (::Array<::String>) (defaults to: nil) —

      The identifiers of the services to enable on the project.

      A valid identifier would be: serviceusage.googleapis.com

      Enabling services requires that each service is public or is shared with the user enabling the service.

      A single request can enable a maximum of 20 services at a time. If more than 20 services are specified, the request will fail, and no state changes will occur.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/google/cloud/service_usage/v1/service_usage/rest/client.rb', line 635

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceUsage::V1::BatchEnableServicesRequest

  # 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.batch_enable_services.metadata.to_h

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

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @service_usage_stub.batch_enable_services request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_get_services(request, options = nil) ⇒ ::Google::Cloud::ServiceUsage::V1::BatchGetServicesResponse #batch_get_services(parent: nil, names: nil) ⇒ ::Google::Cloud::ServiceUsage::V1::BatchGetServicesResponse

Returns the service configurations and enabled states for a given list of services.

Examples:

Basic example

require "google/cloud/service_usage/v1"

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

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

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

# The returned object is of type Google::Cloud::ServiceUsage::V1::BatchGetServicesResponse.
p result

Overloads:

  • #batch_get_services(request, options = nil) ⇒ ::Google::Cloud::ServiceUsage::V1::BatchGetServicesResponse

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

    Parameters:

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

  • #batch_get_services(parent: nil, names: nil) ⇒ ::Google::Cloud::ServiceUsage::V1::BatchGetServicesResponse

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

    Parameters:

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

      Parent to retrieve services from. If this is set, the parent of all of the services specified in names must match this field. An example name would be: projects/123 where 123 is the project number. The BatchGetServices method currently only supports projects.

    • names (::Array<::String>) (defaults to: nil) —

      Names of the services to retrieve.

      An example name would be: projects/123/services/serviceusage.googleapis.com where 123 is the project number. A single request can get a maximum of 30 services at a time.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'lib/google/cloud/service_usage/v1/service_usage/rest/client.rb', line 726

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceUsage::V1::BatchGetServicesRequest

  # 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.batch_get_services.metadata.to_h

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

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

Configure the ServiceUsage 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/service_usage/v1/service_usage/rest/client.rb', line 97

def configure
  yield @config if block_given?
  @config
end

#disable_service(request, options = nil) ⇒ ::Gapic::Operation #disable_service(name: nil, disable_dependent_services: nil, check_if_service_has_usage: nil) ⇒ ::Gapic::Operation

Disable a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks.

It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a FAILED_PRECONDITION status if the target service is not currently enabled.

Examples:

Basic example

require "google/cloud/service_usage/v1"

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

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

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

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

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

    Parameters:

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

  • #disable_service(name: nil, disable_dependent_services: nil, check_if_service_has_usage: nil) ⇒ ::Gapic::Operation

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

    Parameters:

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

      Name of the consumer and service to disable the service on.

      The enable and disable methods currently only support projects.

      An example name would be: projects/123/services/serviceusage.googleapis.com where 123 is the project number.

    • disable_dependent_services (::Boolean) (defaults to: nil) —

      Indicates if services that are enabled and which depend on this service should also be disabled. If not set, an error will be generated if any enabled services depend on the service to be disabled. When set, the service, and any enabled services that depend on it, will be disabled together.

    • check_if_service_has_usage (::Google::Cloud::ServiceUsage::V1::DisableServiceRequest::CheckIfServiceHasUsage) (defaults to: nil) —

      Defines the behavior for checking service usage when disabling a service.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



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

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceUsage::V1::DisableServiceRequest

  # 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.disable_service.metadata.to_h

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

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @service_usage_stub.disable_service request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Enable a service so that it can be used with a project.

Examples:

Basic example

require "google/cloud/service_usage/v1"

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

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

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

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

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

    Parameters:

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

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

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

    Parameters:

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

      Name of the consumer and service to enable the service on.

      The EnableService and DisableService methods currently only support projects.

      Enabling a service requires that the service is public or is shared with the user enabling the service.

      An example name would be: projects/123/services/serviceusage.googleapis.com where 123 is the project number.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



234
235
236
237
238
239
240
241
242
243
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
 
# File 'lib/google/cloud/service_usage/v1/service_usage/rest/client.rb', line 234

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceUsage::V1::EnableServiceRequest

  # 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.enable_service.metadata.to_h

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

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @service_usage_stub.enable_service request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_service(request, options = nil) ⇒ ::Google::Cloud::ServiceUsage::V1::Service #get_service(name: nil) ⇒ ::Google::Cloud::ServiceUsage::V1::Service

Returns the service configuration and enabled state for a given service.

Examples:

Basic example

require "google/cloud/service_usage/v1"

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

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

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

# The returned object is of type Google::Cloud::ServiceUsage::V1::Service.
p result

Overloads:

  • #get_service(request, options = nil) ⇒ ::Google::Cloud::ServiceUsage::V1::Service

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

    Parameters:

    • request (::Google::Cloud::ServiceUsage::V1::GetServiceRequest, ::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_service(name: nil) ⇒ ::Google::Cloud::ServiceUsage::V1::Service

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

    Parameters:

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

      Name of the consumer and service to get the ConsumerState for.

      An example name would be: projects/123/services/serviceusage.googleapis.com where 123 is the project number.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/google/cloud/service_usage/v1/service_usage/rest/client.rb', line 423

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceUsage::V1::GetServiceRequest

  # 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_service.metadata.to_h

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

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

#list_services(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ServiceUsage::V1::Service> #list_services(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ServiceUsage::V1::Service>

List all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the servicemanagement.services.bind permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project.

WARNING: If you need to query enabled services frequently or across an organization, you should use Cloud Asset Inventory API, which provides higher throughput and richer filtering capability.

Examples:

Basic example

require "google/cloud/service_usage/v1"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ServiceUsage::V1::Service.
  p item
end

Overloads:

  • #list_services(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ServiceUsage::V1::Service>

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

    Parameters:

    • request (::Google::Cloud::ServiceUsage::V1::ListServicesRequest, ::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_services(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ServiceUsage::V1::Service>

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

    Parameters:

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

      Parent to search for services on.

      An example name would be: projects/123 where 123 is the project number.

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

      Requested size of the next page of data. Requested page size cannot exceed 200. If not set, the default page size is 50.

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

      Token identifying which result to start with, which is returned by a previous list call.

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

      Only list services that conform to the given filter. The allowed filter strings are state:ENABLED and state:DISABLED.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/google/cloud/service_usage/v1/service_usage/rest/client.rb', line 530

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceUsage::V1::ListServicesRequest

  # 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_services.metadata.to_h

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

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @service_usage_stub.list_services request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @service_usage_stub, :list_services, "services", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


107
108
109
 
# File 'lib/google/cloud/service_usage/v1/service_usage/rest/client.rb', line 107

def universe_domain
  @service_usage_stub.universe_domain
end