Class: Google::Apis::ServicemanagementV1::ServiceManagementService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/servicemanagement_v1/service.rb

Overview

Google Service Management API

Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.

Examples:

require 'google/apis/servicemanagement_v1'

Servicemanagement = Google::Apis::ServicemanagementV1 # Alias the module
service = Servicemanagement::ServiceManagementService.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 ⇒ ServiceManagementService

Returns a new instance of ServiceManagementService



47
48
49
50
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 47

def initialize
  super('https://servicemanagement.googleapis.com/', '')
  @batch_path = 'batch'
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.



40
41
42
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 40

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.

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.



45
46
47
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#create_service(managed_service_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Operation

Creates a new managed service. Please note one producer project can own no more than 20 services. Operation

Parameters:

  • managed_service_object (Google::Apis::ServicemanagementV1::ManagedService) (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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def create_service(managed_service_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/services', options)
  command.request_representation = Google::Apis::ServicemanagementV1::ManagedService::Representation
  command.request_object = managed_service_object
  command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Operation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_service_config(service_name, service_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Service

Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call CreateServiceRollout.

Parameters:

  • service_name (String) —

    The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

  • service_object (Google::Apis::ServicemanagementV1::Service) (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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



919
920
921
922
923
924
925
926
927
928
929
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 919

def create_service_config(service_name, service_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/services/{serviceName}/configs', options)
  command.request_representation = Google::Apis::ServicemanagementV1::Service::Representation
  command.request_object = service_object
  command.response_representation = Google::Apis::ServicemanagementV1::Service::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Service
  command.params['serviceName'] = service_name unless service_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_service_rollout(service_name, rollout_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Operation

Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging. Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts. Operation

Parameters:

  • service_name (String) —

    The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

  • rollout_object (Google::Apis::ServicemanagementV1::Rollout) (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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



806
807
808
809
810
811
812
813
814
815
816
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 806

def create_service_rollout(service_name, rollout_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/services/{serviceName}/rollouts', options)
  command.request_representation = Google::Apis::ServicemanagementV1::Rollout::Representation
  command.request_object = rollout_object
  command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Operation
  command.params['serviceName'] = service_name unless service_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_service(service_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Operation

Deletes a managed service. This method will change the service to the Soft-Delete state for 30 days. Within this period, service producers may call UndeleteService to restore the service. After 30 days, the service will be permanently deleted. Operation

Parameters:

  • service_name (String) —

    The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

  • 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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



432
433
434
435
436
437
438
439
440
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 432

def delete_service(service_name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/services/{serviceName}', options)
  command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Operation
  command.params['serviceName'] = service_name unless service_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#disable_service(service_name, disable_service_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Operation

Disables a service for a project, so it can no longer be be used for the project. It prevents accidental usage that may cause unexpected billing charges or security leaks. Operation

Parameters:

  • service_name (String) —

    Name of the service to disable. Specifying an unknown service name will cause the request to fail.

  • disable_service_request_object (Google::Apis::ServicemanagementV1::DisableServiceRequest) (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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



502
503
504
505
506
507
508
509
510
511
512
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 502

def disable_service(service_name, disable_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/services/{serviceName}:disable', options)
  command.request_representation = Google::Apis::ServicemanagementV1::DisableServiceRequest::Representation
  command.request_object = disable_service_request_object
  command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Operation
  command.params['serviceName'] = service_name unless service_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#enable_service(service_name, enable_service_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Operation

Enables a service for a project, so it can be used for the project. See Cloud Auth Guide for more information. Operation

Parameters:

  • service_name (String) —

    Name of the service to enable. Specifying an unknown service name will cause the request to fail.

  • enable_service_request_object (Google::Apis::ServicemanagementV1::EnableServiceRequest) (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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



395
396
397
398
399
400
401
402
403
404
405
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 395

def enable_service(service_name, enable_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/services/{serviceName}:enable', options)
  command.request_representation = Google::Apis::ServicemanagementV1::EnableServiceRequest::Representation
  command.request_object = enable_service_request_object
  command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Operation
  command.params['serviceName'] = service_name unless service_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_service_config_report(generate_config_report_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::GenerateConfigReportResponse

Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value If GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration.

Parameters:

  • generate_config_report_request_object (Google::Apis::ServicemanagementV1::GenerateConfigReportRequest) (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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



249
250
251
252
253
254
255
256
257
258
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 249

def generate_service_config_report(generate_config_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/services:generateConfigReport', options)
  command.request_representation = Google::Apis::ServicemanagementV1::GenerateConfigReportRequest::Representation
  command.request_object = generate_config_report_request_object
  command.response_representation = Google::Apis::ServicemanagementV1::GenerateConfigReportResponse::Representation
  command.response_class = Google::Apis::ServicemanagementV1::GenerateConfigReportResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_consumer_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::ServicemanagementV1::GetIamPolicyRequest) (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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



609
610
611
612
613
614
615
616
617
618
619
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 609

def get_consumer_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::ServicemanagementV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::ServicemanagementV1::Policy::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • 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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



130
131
132
133
134
135
136
137
138
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 130

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_service(service_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::ManagedService

Gets a managed service. Authentication is required unless the service is public.

Parameters:

  • service_name (String) —

    The name of the service. See the ServiceManager overview for naming requirements. For example: example.googleapis.com.

  • 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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



282
283
284
285
286
287
288
289
290
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 282

def get_service(service_name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/services/{serviceName}', options)
  command.response_representation = Google::Apis::ServicemanagementV1::ManagedService::Representation
  command.response_class = Google::Apis::ServicemanagementV1::ManagedService
  command.params['serviceName'] = service_name unless service_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_service_config(service_name, config_id, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Service

Gets a service configuration (version) for a managed service.

Parameters:

  • service_name (String) —

    The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

  • config_id (String) —

    The id of the service configuration resource.

  • view (String) —

    Specifies which parts of the Service Config should be returned in the response.

  • 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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



882
883
884
885
886
887
888
889
890
891
892
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 882

def get_service_config(service_name, config_id, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/services/{serviceName}/configs/{configId}', options)
  command.response_representation = Google::Apis::ServicemanagementV1::Service::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Service
  command.params['serviceName'] = service_name unless service_name.nil?
  command.params['configId'] = config_id unless config_id.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_service_configuration(service_name, config_id: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Service

Gets a service configuration (version) for a managed service.

Parameters:

  • service_name (String) —

    The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

  • config_id (String) —

    The id of the service configuration resource.

  • view (String) —

    Specifies which parts of the Service Config should be returned in the response.

  • 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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



357
358
359
360
361
362
363
364
365
366
367
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 357

def get_service_configuration(service_name, config_id: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/services/{serviceName}/config', options)
  command.response_representation = Google::Apis::ServicemanagementV1::Service::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Service
  command.params['serviceName'] = service_name unless service_name.nil?
  command.query['configId'] = config_id unless config_id.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_service_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::ServicemanagementV1::GetIamPolicyRequest) (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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



538
539
540
541
542
543
544
545
546
547
548
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 538

def get_service_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::ServicemanagementV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::ServicemanagementV1::Policy::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_service_rollout(service_name, rollout_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Rollout

Gets a service configuration rollout.

Parameters:

  • service_name (String) —

    The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

  • rollout_id (String) —

    The id of the rollout resource.

  • 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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



766
767
768
769
770
771
772
773
774
775
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 766

def get_service_rollout(service_name, rollout_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/services/{serviceName}/rollouts/{rolloutId}', options)
  command.response_representation = Google::Apis::ServicemanagementV1::Rollout::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Rollout
  command.params['serviceName'] = service_name unless service_name.nil?
  command.params['rolloutId'] = rollout_id unless rollout_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_operations(name: nil, page_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::ListOperationsResponse

Lists service operations that match the specified filter in the request.

Parameters:

  • name (String) —

    Not used.

  • page_token (String) —

    The standard list page token.

  • page_size (Fixnum) —

    The maximum number of operations to return. If unspecified, defaults to

    1. The maximum value is 100.
  • filter (String) —

    A string for filtering Operations. The following filter fields are supported:

    • serviceName: Required. Only = operator is allowed.
    • startTime: The time this job was started, in ISO 8601 format. Allowed operators are >=, >, <=, and <.
    • status: Can be done, in_progress, or failed. Allowed operators are =, and !=. Filter expression supports conjunction (AND) and disjunction (OR) logical operators. However, the serviceName restriction must be at the top-level and can only be combined with other restrictions via the AND logical operator. Examples:
    • serviceName=some-service.googleapis.com
    • serviceName=some-service.googleapis.com AND startTime>="2017-02-01"
    • serviceName=some-service.googleapis.com AND status=done
    • serviceName=some-service.googleapis.com AND (status=done OR startTime>=" 2017-02-01")
  • 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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 95

def list_operations(name: nil, page_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/operations', options)
  command.response_representation = Google::Apis::ServicemanagementV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::ServicemanagementV1::ListOperationsResponse
  command.query['name'] = name unless name.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_service_configs(service_name, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::ListServiceConfigsResponse

Lists the history of the service configuration for a managed service, from the newest to the oldest.

Parameters:

  • service_name (String) —

    The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

  • page_token (String) —

    The token of the page to retrieve.

  • page_size (Fixnum) —

    The max number of items to include in the response list.

  • 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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



844
845
846
847
848
849
850
851
852
853
854
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 844

def list_service_configs(service_name, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/services/{serviceName}/configs', options)
  command.response_representation = Google::Apis::ServicemanagementV1::ListServiceConfigsResponse::Representation
  command.response_class = Google::Apis::ServicemanagementV1::ListServiceConfigsResponse
  command.params['serviceName'] = service_name unless service_name.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_service_rollouts(service_name, page_size: nil, filter: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::ListServiceRolloutsResponse

Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.

Parameters:

  • service_name (String) —

    The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

  • page_size (Fixnum) —

    The max number of items to include in the response list.

  • filter (String) —

    Use filter to return subset of rollouts. The following filters are supported: -- To limit the results to only those in status 'SUCCESS', use filter='status=SUCCESS' -- To limit the results to those in status 'CANCELLED' or 'FAILED', use filter='status=CANCELLED OR status=FAILED'

  • page_token (String) —

    The token of the page to retrieve.

  • 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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 730

def list_service_rollouts(service_name, page_size: nil, filter: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/services/{serviceName}/rollouts', options)
  command.response_representation = Google::Apis::ServicemanagementV1::ListServiceRolloutsResponse::Representation
  command.response_class = Google::Apis::ServicemanagementV1::ListServiceRolloutsResponse
  command.params['serviceName'] = service_name unless service_name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['filter'] = filter unless filter.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?
  execute_or_queue_command(command, &block)
end

#list_services(consumer_id: nil, page_token: nil, page_size: nil, producer_project_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::ListServicesResponse

Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for. BETA: If the caller specifies the consumer_id, it returns only the services enabled on the consumer. The consumer_id must have the format of "project:PROJECT-ID".

Parameters:

  • consumer_id (String) —

    Include services consumed by the specified consumer. The Google Service Management implementation accepts the following forms:

    • project:
  • page_token (String) —

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

  • page_size (Fixnum) —

    Requested size of the next page of data.

  • producer_project_id (String) —

    Include services produced by the specified project.

  • 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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 176

def list_services(consumer_id: nil, page_token: nil, page_size: nil, producer_project_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/services', options)
  command.response_representation = Google::Apis::ServicemanagementV1::ListServicesResponse::Representation
  command.response_class = Google::Apis::ServicemanagementV1::ListServicesResponse
  command.query['consumerId'] = consumer_id unless consumer_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['producerProjectId'] = producer_project_id unless producer_project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_consumer_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::ServicemanagementV1::SetIamPolicyRequest) (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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



644
645
646
647
648
649
650
651
652
653
654
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 644

def set_consumer_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::ServicemanagementV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::ServicemanagementV1::Policy::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_service_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::ServicemanagementV1::SetIamPolicyRequest) (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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



465
466
467
468
469
470
471
472
473
474
475
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 465

def set_service_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::ServicemanagementV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::ServicemanagementV1::Policy::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#submit_config_source(service_name, submit_config_source_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Operation

Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call CreateServiceRollout. Operation

Parameters:

  • service_name (String) —

    The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

  • submit_config_source_request_object (Google::Apis::ServicemanagementV1::SubmitConfigSourceRequest) (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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



960
961
962
963
964
965
966
967
968
969
970
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 960

def submit_config_source(service_name, submit_config_source_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/services/{serviceName}/configs:submit', options)
  command.request_representation = Google::Apis::ServicemanagementV1::SubmitConfigSourceRequest::Representation
  command.request_object = submit_config_source_request_object
  command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Operation
  command.params['serviceName'] = service_name unless service_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_consumer_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::ServicemanagementV1::TestIamPermissionsRequest) (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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



683
684
685
686
687
688
689
690
691
692
693
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 683

def test_consumer_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::ServicemanagementV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::ServicemanagementV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::ServicemanagementV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_service_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::ServicemanagementV1::TestIamPermissionsRequest) (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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



319
320
321
322
323
324
325
326
327
328
329
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 319

def test_service_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::ServicemanagementV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::ServicemanagementV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::ServicemanagementV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#undelete_service(service_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicemanagementV1::Operation

Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days. Operation

Parameters:

  • service_name (String) —

    The name of the service. See the overview for naming requirements. For example: example.googleapis.com.

  • 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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



575
576
577
578
579
580
581
582
583
 
# File 'generated/google/apis/servicemanagement_v1/service.rb', line 575

def undelete_service(service_name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/services/{serviceName}:undelete', options)
  command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
  command.response_class = Google::Apis::ServicemanagementV1::Operation
  command.params['serviceName'] = service_name unless service_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end