Class: Google::Cloud::ServiceManagement::V1::ServiceManager::Client

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

Overview

Client for the ServiceManager service.

Google Service Management 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 ServiceManager client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the ServiceManager client.

Yield Parameters:



126
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 126

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/api/servicemanagement/v1/servicemanager_services_pb"

  # 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 = 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_manager_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::ServiceManagement::V1::ServiceManager::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @service_manager_stub.stub_logger&.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

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @service_manager_stub.endpoint
    config.universe_domain = @service_manager_stub.universe_domain
    config.logger = @service_manager_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Client (readonly)

Get the associated client for mix-in of the IAMPolicy.

Returns:

  • (Google::Iam::V1::IAMPolicy::Client) 


204
205
206
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 204

def iam_policy_client
  @iam_policy_client
end

#operations_client ⇒ ::Google::Cloud::ServiceManagement::V1::ServiceManager::Operations (readonly)

Get the associated client for long-running operations.

Returns:



197
198
199
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 197

def operations_client
  @operations_client
end

Class Method Details

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

Configure the ServiceManager Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all ServiceManager clients
::Google::Cloud::ServiceManagement::V1::ServiceManager::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 62

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

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

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



96
97
98
99
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#create_service(request, options = nil) ⇒ ::Gapic::Operation #create_service(service: nil) ⇒ ::Gapic::Operation

Creates a new managed service.

A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion.

One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project.

Operation

Examples:

Basic example

require "google/cloud/service_management/v1"

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

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

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

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

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

    Parameters:

    • request (::Google::Cloud::ServiceManagement::V1::CreateServiceRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_service(service: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_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:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 464

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceManagement::V1::CreateServiceRequest

  # 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
  metadata = @config.rpcs.create_service.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::ServiceManagement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @service_manager_stub.call_rpc :create_service, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_service_config(request, options = nil) ⇒ ::Google::Api::Service #create_service_config(service_name: nil, service_config: nil) ⇒ ::Google::Api::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.

Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.

Examples:

Basic example

require "google/cloud/service_management/v1"

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

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

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

# The returned object is of type Google::Api::Service.
p result

Overloads:

  • #create_service_config(request, options = nil) ⇒ ::Google::Api::Service

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

    Parameters:

    • request (::Google::Cloud::ServiceManagement::V1::CreateServiceConfigRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_service_config(service_name: nil, service_config: nil) ⇒ ::Google::Api::Service

    Pass arguments to create_service_config 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:

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

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

    • service_config (::Google::Api::Service, ::Hash) (defaults to: nil) —

      Required. The service configuration resource.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 955

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceManagement::V1::CreateServiceConfigRequest

  # 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
  metadata = @config.rpcs.create_service_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::ServiceManagement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.service_name
    header_params["service_name"] = request.service_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @service_manager_stub.call_rpc :create_service_config, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_service_rollout(request, options = nil) ⇒ ::Gapic::Operation #create_service_rollout(service_name: nil, rollout: nil) ⇒ ::Gapic::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.

Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually.

Operation

Examples:

Basic example

require "google/cloud/service_management/v1"

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

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

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

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

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

    Parameters:

    • request (::Google::Cloud::ServiceManagement::V1::CreateServiceRolloutRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_service_rollout(service_name: nil, rollout: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_service_rollout 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:

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

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

    • rollout (::Google::Cloud::ServiceManagement::V1::Rollout, ::Hash) (defaults to: nil) —

      Required. The rollout resource. The service_name field is output only.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 1382

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceManagement::V1::CreateServiceRolloutRequest

  # 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
  metadata = @config.rpcs.create_service_rollout.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::ServiceManagement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.service_name
    header_params["service_name"] = request.service_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @service_manager_stub.call_rpc :create_service_rollout, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_service(request, options = nil) ⇒ ::Gapic::Operation #delete_service(service_name: nil) ⇒ ::Gapic::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

Examples:

Basic example

require "google/cloud/service_management/v1"

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

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

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

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

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

    Parameters:

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

  • #delete_service(service_name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_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:

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC 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
595
596
597
598
599
600
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 559

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceManagement::V1::DeleteServiceRequest

  # 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
  metadata = @config.rpcs.delete_service.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::ServiceManagement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.service_name
    header_params["service_name"] = request.service_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @service_manager_stub.call_rpc :delete_service, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#generate_config_report(request, options = nil) ⇒ ::Google::Cloud::ServiceManagement::V1::GenerateConfigReportResponse #generate_config_report(new_config: nil, old_config: nil) ⇒ ::Google::Cloud::ServiceManagement::V1::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.

Examples:

Basic example

require "google/cloud/service_management/v1"

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

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

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

# The returned object is of type Google::Cloud::ServiceManagement::V1::GenerateConfigReportResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 1489

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceManagement::V1::GenerateConfigReportRequest

  # 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
  metadata = @config.rpcs.generate_config_report.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::ServiceManagement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @service_manager_stub.call_rpc :generate_config_report, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_service(request, options = nil) ⇒ ::Google::Cloud::ServiceManagement::V1::ManagedService #get_service(service_name: nil) ⇒ ::Google::Cloud::ServiceManagement::V1::ManagedService

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

Examples:

Basic example

require "google/cloud/service_management/v1"

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

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

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

# The returned object is of type Google::Cloud::ServiceManagement::V1::ManagedService.
p result

Overloads:

  • #get_service(request, options = nil) ⇒ ::Google::Cloud::ServiceManagement::V1::ManagedService

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

    Parameters:

    • request (::Google::Cloud::ServiceManagement::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(service_name: nil) ⇒ ::Google::Cloud::ServiceManagement::V1::ManagedService

    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:

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 362

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceManagement::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
  metadata = @config.rpcs.get_service.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::ServiceManagement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.service_name
    header_params["service_name"] = request.service_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @service_manager_stub.call_rpc :get_service, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_service_config(request, options = nil) ⇒ ::Google::Api::Service #get_service_config(service_name: nil, config_id: nil, view: nil) ⇒ ::Google::Api::Service

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

Examples:

Basic example

require "google/cloud/service_management/v1"

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

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

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

# The returned object is of type Google::Api::Service.
p result

Overloads:

  • #get_service_config(request, options = nil) ⇒ ::Google::Api::Service

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

    Parameters:

    • request (::Google::Cloud::ServiceManagement::V1::GetServiceConfigRequest, ::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_config(service_name: nil, config_id: nil, view: nil) ⇒ ::Google::Api::Service

    Pass arguments to get_service_config 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:

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

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

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

      Required. The id of the service configuration resource.

      This field must be specified for the server to return all fields, including SourceInfo.

    • view (::Google::Cloud::ServiceManagement::V1::GetServiceConfigRequest::ConfigView) (defaults to: nil) —

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 856

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceManagement::V1::GetServiceConfigRequest

  # 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
  metadata = @config.rpcs.get_service_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::ServiceManagement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.service_name
    header_params["service_name"] = request.service_name
  end
  if request.config_id
    header_params["config_id"] = request.config_id
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @service_manager_stub.call_rpc :get_service_config, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_service_rollout(request, options = nil) ⇒ ::Google::Cloud::ServiceManagement::V1::Rollout #get_service_rollout(service_name: nil, rollout_id: nil) ⇒ ::Google::Cloud::ServiceManagement::V1::Rollout

Gets a service configuration rollout.

Examples:

Basic example

require "google/cloud/service_management/v1"

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

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

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

# The returned object is of type Google::Cloud::ServiceManagement::V1::Rollout.
p result

Overloads:

  • #get_service_rollout(request, options = nil) ⇒ ::Google::Cloud::ServiceManagement::V1::Rollout

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

    Parameters:

    • request (::Google::Cloud::ServiceManagement::V1::GetServiceRolloutRequest, ::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_rollout(service_name: nil, rollout_id: nil) ⇒ ::Google::Cloud::ServiceManagement::V1::Rollout

    Pass arguments to get_service_rollout 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:

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

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

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

      Required. The id of the rollout resource.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 1270

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceManagement::V1::GetServiceRolloutRequest

  # 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
  metadata = @config.rpcs.get_service_rollout.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::ServiceManagement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.service_name
    header_params["service_name"] = request.service_name
  end
  if request.rollout_id
    header_params["rollout_id"] = request.rollout_id
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @service_manager_stub.call_rpc :get_service_rollout, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_service_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::Service> #list_service_configs(service_name: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::Service>

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

Examples:

Basic example

require "google/cloud/service_management/v1"

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

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

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

Overloads:

  • #list_service_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::Service>

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

    Parameters:

    • request (::Google::Cloud::ServiceManagement::V1::ListServiceConfigsRequest, ::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_service_configs(service_name: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::Service>

    Pass arguments to list_service_configs 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:

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

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

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

      The token of the page to retrieve.

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

      The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 100.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 759

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceManagement::V1::ListServiceConfigsRequest

  # 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
  metadata = @config.rpcs.list_service_configs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::ServiceManagement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.service_name
    header_params["service_name"] = request.service_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @service_manager_stub.call_rpc :list_service_configs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @service_manager_stub, :list_service_configs, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_service_rollouts(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ServiceManagement::V1::Rollout> #list_service_rollouts(service_name: nil, page_token: nil, page_size: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ServiceManagement::V1::Rollout>

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

Examples:

Basic example

require "google/cloud/service_management/v1"

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

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

# Call the list_service_rollouts method.
result = client.list_service_rollouts 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::ServiceManagement::V1::Rollout.
  p item
end

Overloads:

  • #list_service_rollouts(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ServiceManagement::V1::Rollout>

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

    Parameters:

    • request (::Google::Cloud::ServiceManagement::V1::ListServiceRolloutsRequest, ::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_service_rollouts(service_name: nil, page_token: nil, page_size: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ServiceManagement::V1::Rollout>

    Pass arguments to list_service_rollouts 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:

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

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

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

      The token of the page to retrieve.

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

      The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 100.

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

      Required. Use filter to return subset of rollouts. The following filters are supported:

      -- By [status] [google.api.servicemanagement.v1.Rollout.RolloutStatus]. For example, filter='status=SUCCESS'

      -- By [strategy] [google.api.servicemanagement.v1.Rollout.strategy]. For example, filter='strategy=TrafficPercentStrategy'

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 1178

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceManagement::V1::ListServiceRolloutsRequest

  # 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
  metadata = @config.rpcs.list_service_rollouts.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::ServiceManagement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.service_name
    header_params["service_name"] = request.service_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @service_manager_stub.call_rpc :list_service_rollouts, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @service_manager_stub, :list_service_rollouts, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_services(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ServiceManagement::V1::ManagedService> #list_services(producer_project_id: nil, page_size: nil, page_token: nil, consumer_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ServiceManagement::V1::ManagedService>

Lists managed services.

Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for.

Examples:

Basic example

require "google/cloud/service_management/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ServiceManagement::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::ServiceManagement::V1::ManagedService.
  p item
end

Overloads:

  • #list_services(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ServiceManagement::V1::ManagedService>

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

    Parameters:

    • request (::Google::Cloud::ServiceManagement::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(producer_project_id: nil, page_size: nil, page_token: nil, consumer_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ServiceManagement::V1::ManagedService>

    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:

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

      Include services produced by the specified project.

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

      The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 500.

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

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

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

      Include services consumed by the specified consumer.

      The Google Service Management implementation accepts the following forms:

      • project:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 281

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceManagement::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
  metadata = @config.rpcs.list_services.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::ServiceManagement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @service_manager_stub.call_rpc :list_services, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @service_manager_stub, :list_services, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


211
212
213
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 211

def logger
  @service_manager_stub.logger
end

#submit_config_source(request, options = nil) ⇒ ::Gapic::Operation #submit_config_source(service_name: nil, config_source: nil, validate_only: nil) ⇒ ::Gapic::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.

Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually.

Operation

Examples:

Basic example

require "google/cloud/service_management/v1"

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

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

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

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

    Pass arguments to submit_config_source via a request object, either of type Google::Cloud::ServiceManagement::V1::SubmitConfigSourceRequest or an equivalent Hash.

    Parameters:

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

  • #submit_config_source(service_name: nil, config_source: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to submit_config_source 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:

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

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

    • config_source (::Google::Cloud::ServiceManagement::V1::ConfigSource, ::Hash) (defaults to: nil) —

      Required. The source configuration for the service.

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

      Optional. If set, this will result in the generation of a google.api.Service configuration based on the ConfigSource provided, but the generated config and the sources will NOT be persisted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 1068

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceManagement::V1::SubmitConfigSourceRequest

  # 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
  metadata = @config.rpcs.submit_config_source.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::ServiceManagement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.service_name
    header_params["service_name"] = request.service_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @service_manager_stub.call_rpc :submit_config_source, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#undelete_service(request, options = nil) ⇒ ::Gapic::Operation #undelete_service(service_name: nil) ⇒ ::Gapic::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

Examples:

Basic example

require "google/cloud/service_management/v1"

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

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

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

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

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

    Parameters:

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

  • #undelete_service(service_name: nil) ⇒ ::Gapic::Operation

    Pass arguments to undelete_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:

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 660

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceManagement::V1::UndeleteServiceRequest

  # 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
  metadata = @config.rpcs.undelete_service.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::ServiceManagement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.service_name
    header_params["service_name"] = request.service_name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @service_manager_stub.call_rpc :undelete_service, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


106
107
108
 
# File 'lib/google/cloud/service_management/v1/service_manager/client.rb', line 106

def universe_domain
  @service_manager_stub.universe_domain
end