Class: Google::Cloud::Commerce::Consumer::Procurement::V1::LicenseManagementService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/commerce/consumer/procurement/v1/license_management_service/rest/client.rb

Overview

REST client for the LicenseManagementService service.

Service for managing licenses.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#license_pool_path

Constructor Details

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

Create a new LicenseManagementService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Commerce::Consumer::Procurement::V1::LicenseManagementService::Rest::Client.new

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

Yields:

  • (config) —

    Configure the LicenseManagementService client.

Yield Parameters:



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
164
165
166
167
168
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/license_management_service/rest/client.rb', line 128

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

  @license_management_service_stub = ::Google::Cloud::Commerce::Consumer::Procurement::V1::LicenseManagementService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @license_management_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
end

Class Method Details

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

Configure the LicenseManagementService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all LicenseManagementService clients
::Google::Cloud::Commerce::Consumer::Procurement::V1::LicenseManagementService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/license_management_service/rest/client.rb', line 66

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Commerce", "Consumer", "Procurement", "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
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#assign(request, options = nil) ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::AssignResponse #assign(parent: nil, usernames: nil) ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::AssignResponse

Assigns a license to a user.

Examples:

Basic example

require "google/cloud/commerce/consumer/procurement/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Commerce::Consumer::Procurement::V1::AssignRequest.new

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

# The returned object is of type Google::Cloud::Commerce::Consumer::Procurement::V1::AssignResponse.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/license_management_service/rest/client.rb', line 390

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Commerce::Consumer::Procurement::V1::AssignRequest

  # 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.assign.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::Commerce::Consumer::Procurement::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.assign.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.assign.retry_policy

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

  @license_management_service_stub.assign 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

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

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



98
99
100
101
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/license_management_service/rest/client.rb', line 98

def configure
  yield @config if block_given?
  @config
end

#enumerate_licensed_users(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Commerce::Consumer::Procurement::V1::LicensedUser> #enumerate_licensed_users(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Commerce::Consumer::Procurement::V1::LicensedUser>

Enumerates all users assigned a license.

Examples:

Basic example

require "google/cloud/commerce/consumer/procurement/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Commerce::Consumer::Procurement::V1::EnumerateLicensedUsersRequest.new

# Call the enumerate_licensed_users method.
result = client.enumerate_licensed_users 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::Commerce::Consumer::Procurement::V1::LicensedUser.
  p item
end

Overloads:

  • #enumerate_licensed_users(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Commerce::Consumer::Procurement::V1::LicensedUser>

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

    Parameters:

  • #enumerate_licensed_users(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Commerce::Consumer::Procurement::V1::LicensedUser>

    Pass arguments to enumerate_licensed_users 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. License pool name.

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

      Optional. The maximum number of users to return. The service may return fewer than this value.

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Commerce::Consumer::Procurement::V1::EnumerateLicensedUsersRequest

  # 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.enumerate_licensed_users.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::Commerce::Consumer::Procurement::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.enumerate_licensed_users.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.enumerate_licensed_users.retry_policy

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

  @license_management_service_stub.enumerate_licensed_users request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @license_management_service_stub, :enumerate_licensed_users, "licensed_users", 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

#get_license_pool(request, options = nil) ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::LicensePool #get_license_pool(name: nil) ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::LicensePool

Gets the license pool.

Examples:

Basic example

require "google/cloud/commerce/consumer/procurement/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Commerce::Consumer::Procurement::V1::GetLicensePoolRequest.new

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

# The returned object is of type Google::Cloud::Commerce::Consumer::Procurement::V1::LicensePool.
p result

Overloads:

  • #get_license_pool(request, options = nil) ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::LicensePool

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

    Parameters:

    • request (::Google::Cloud::Commerce::Consumer::Procurement::V1::GetLicensePoolRequest, ::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_license_pool(name: nil) ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::LicensePool

    Pass arguments to get_license_pool 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 license pool to get. Format: billingAccounts/{billing_account}/orders/{order}/licensePool

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



225
226
227
228
229
230
231
232
233
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
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/license_management_service/rest/client.rb', line 225

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Commerce::Consumer::Procurement::V1::GetLicensePoolRequest

  # 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_license_pool.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::Commerce::Consumer::Procurement::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_license_pool.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_license_pool.retry_policy

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

  @license_management_service_stub.get_license_pool 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

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


175
176
177
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/license_management_service/rest/client.rb', line 175

def logger
  @license_management_service_stub.logger
end

#unassign(request, options = nil) ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::UnassignResponse #unassign(parent: nil, usernames: nil) ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::UnassignResponse

Unassigns a license from a user.

Examples:

Basic example

require "google/cloud/commerce/consumer/procurement/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Commerce::Consumer::Procurement::V1::UnassignRequest.new

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

# The returned object is of type Google::Cloud::Commerce::Consumer::Procurement::V1::UnassignResponse.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
497
498
499
500
501
502
503
504
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/license_management_service/rest/client.rb', line 471

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Commerce::Consumer::Procurement::V1::UnassignRequest

  # 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.unassign.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::Commerce::Consumer::Procurement::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.unassign.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.unassign.retry_policy

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

  @license_management_service_stub.unassign 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) 


108
109
110
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/license_management_service/rest/client.rb', line 108

def universe_domain
  @license_management_service_stub.universe_domain
end

#update_license_pool(request, options = nil) ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::LicensePool #update_license_pool(license_pool: nil, update_mask: nil) ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::LicensePool

Updates the license pool if one exists for this Order.

Examples:

Basic example

require "google/cloud/commerce/consumer/procurement/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Commerce::Consumer::Procurement::V1::UpdateLicensePoolRequest.new

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

# The returned object is of type Google::Cloud::Commerce::Consumer::Procurement::V1::LicensePool.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/license_management_service/rest/client.rb', line 309

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Commerce::Consumer::Procurement::V1::UpdateLicensePoolRequest

  # 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.update_license_pool.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::Commerce::Consumer::Procurement::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.update_license_pool.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_license_pool.retry_policy

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

  @license_management_service_stub.update_license_pool 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