Class: Google::Apis::LicensingV1::LicensingService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/licensing_v1/service.rb

Overview

Enterprise License Manager API

Views and manages licenses for your domain.

Examples:

require 'google/apis/licensing_v1'

Licensing = Google::Apis::LicensingV1 # Alias the module
service = Licensing::LicensingService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ LicensingService

Returns a new instance of LicensingService



51
52
53
54
 
# File 'generated/google/apis/licensing_v1/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', 'apps/licensing/v1/product/')
  @batch_path = 'batch/licensing/v1'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
 
# File 'generated/google/apis/licensing_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.



44
45
46
 
# File 'generated/google/apis/licensing_v1/service.rb', line 44

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



49
50
51
 
# File 'generated/google/apis/licensing_v1/service.rb', line 49

def user_ip
  @user_ip
end

Instance Method Details

#delete_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Revoke License.

Parameters:

  • product_id (String) —

    Name for product

  • sku_id (String) —

    Name for sku

  • user_id (String) —

    email id or unique Id of the user

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



84
85
86
87
88
89
90
91
92
93
 
# File 'generated/google/apis/licensing_v1/service.rb', line 84

def delete_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{productId}/sku/{skuId}/user/{userId}', options)
  command.params['productId'] = product_id unless product_id.nil?
  command.params['skuId'] = sku_id unless sku_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment

Get license assignment of a particular product and sku for a user

Parameters:

  • product_id (String) —

    Name for product

  • sku_id (String) —

    Name for sku

  • user_id (String) —

    email id or unique Id of the user

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'generated/google/apis/licensing_v1/service.rb', line 123

def get_license_assignment(product_id, sku_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{productId}/sku/{skuId}/user/{userId}', options)
  command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
  command.response_class = Google::Apis::LicensingV1::LicenseAssignment
  command.params['productId'] = product_id unless product_id.nil?
  command.params['skuId'] = sku_id unless sku_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_license_assignment(product_id, sku_id, license_assignment_insert_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment

Assign License.

Parameters:

  • product_id (String) —

    Name for product

  • sku_id (String) —

    Name for sku

  • license_assignment_insert_object (Google::Apis::LicensingV1::LicenseAssignmentInsert) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'generated/google/apis/licensing_v1/service.rb', line 163

def insert_license_assignment(product_id, sku_id, license_assignment_insert_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{productId}/sku/{skuId}/user', options)
  command.request_representation = Google::Apis::LicensingV1::LicenseAssignmentInsert::Representation
  command.request_object = license_assignment_insert_object
  command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
  command.response_class = Google::Apis::LicensingV1::LicenseAssignment
  command.params['productId'] = product_id unless product_id.nil?
  command.params['skuId'] = sku_id unless sku_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_license_assignments_for_product(product_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignmentList

List license assignments for given product of the customer.

Parameters:

  • product_id (String) —

    Name for product

  • customer_id (String) —

    CustomerId represents the customer for whom licenseassignments are queried

  • max_results (Fixnum) —

    Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.

  • page_token (String) —

    Token to fetch the next page.Optional. By default server will return first page

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'generated/google/apis/licensing_v1/service.rb', line 209

def list_license_assignments_for_product(product_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{productId}/users', options)
  command.response_representation = Google::Apis::LicensingV1::LicenseAssignmentList::Representation
  command.response_class = Google::Apis::LicensingV1::LicenseAssignmentList
  command.params['productId'] = product_id unless product_id.nil?
  command.query['customerId'] = customer_id unless customer_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_license_assignments_for_product_and_sku(product_id, sku_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignmentList

List license assignments for given product and sku of the customer.

Parameters:

  • product_id (String) —

    Name for product

  • sku_id (String) —

    Name for sku

  • customer_id (String) —

    CustomerId represents the customer for whom licenseassignments are queried

  • max_results (Fixnum) —

    Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.

  • page_token (String) —

    Token to fetch the next page.Optional. By default server will return first page

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'generated/google/apis/licensing_v1/service.rb', line 257

def list_license_assignments_for_product_and_sku(product_id, sku_id, customer_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{productId}/sku/{skuId}/users', options)
  command.response_representation = Google::Apis::LicensingV1::LicenseAssignmentList::Representation
  command.response_class = Google::Apis::LicensingV1::LicenseAssignmentList
  command.params['productId'] = product_id unless product_id.nil?
  command.params['skuId'] = sku_id unless sku_id.nil?
  command.query['customerId'] = customer_id unless customer_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment

Assign License. This method supports patch semantics.

Parameters:

  • product_id (String) —

    Name for product

  • sku_id (String) —

    Name for sku for which license would be revoked

  • user_id (String) —

    email id or unique Id of the user

  • license_assignment_object (Google::Apis::LicensingV1::LicenseAssignment) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'generated/google/apis/licensing_v1/service.rb', line 301

def patch_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, '{productId}/sku/{skuId}/user/{userId}', options)
  command.request_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
  command.request_object = license_assignment_object
  command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
  command.response_class = Google::Apis::LicensingV1::LicenseAssignment
  command.params['productId'] = product_id unless product_id.nil?
  command.params['skuId'] = sku_id unless sku_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::LicensingV1::LicenseAssignment

Assign License.

Parameters:

  • product_id (String) —

    Name for product

  • sku_id (String) —

    Name for sku for which license would be revoked

  • user_id (String) —

    email id or unique Id of the user

  • license_assignment_object (Google::Apis::LicensingV1::LicenseAssignment) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'generated/google/apis/licensing_v1/service.rb', line 345

def update_license_assignment(product_id, sku_id, user_id, license_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, '{productId}/sku/{skuId}/user/{userId}', options)
  command.request_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
  command.request_object = license_assignment_object
  command.response_representation = Google::Apis::LicensingV1::LicenseAssignment::Representation
  command.response_class = Google::Apis::LicensingV1::LicenseAssignment
  command.params['productId'] = product_id unless product_id.nil?
  command.params['skuId'] = sku_id unless sku_id.nil?
  command.params['userId'] = user_id unless user_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end