SaaS Runtime V1BETA1 API - Class Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client (v0.1.0)

Reference documentation and code samples for the SaaS Runtime V1BETA1 API class Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client.

Client for the SaasRollouts service.

Manages the rollout of SaaS services.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the SaasRollouts Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all SaasRollouts clients
::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the SaasRollouts 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_rollout

def create_rollout(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout
def create_rollout(parent: nil, rollout_id: nil, rollout: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout

Create a new rollout.

Overloads 
def create_rollout(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout
Pass arguments to create_rollout via a request object, either of type CreateRolloutRequest or an equivalent Hash.
Parameters 
def create_rollout(parent: nil, rollout_id: nil, rollout: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout
Pass arguments to create_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
  • parent (::String) — Required. The parent of the rollout.
  • rollout_id (::String) — Required. The ID value for the new rollout.
  • rollout (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout, ::Hash) — Required. The desired state for the rollout.
  • validate_only (::Boolean) — If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
  • request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/saas_platform/saas_service_mgmt/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::CreateRolloutRequest.new

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

# The returned object is of type Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout.
p result

#create_rollout_kind

def create_rollout_kind(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind
def create_rollout_kind(parent: nil, rollout_kind_id: nil, rollout_kind: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind

Create a new rollout kind.

Overloads 
def create_rollout_kind(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind
Pass arguments to create_rollout_kind via a request object, either of type CreateRolloutKindRequest or an equivalent Hash.
Parameters 
def create_rollout_kind(parent: nil, rollout_kind_id: nil, rollout_kind: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind
Pass arguments to create_rollout_kind via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent of the rollout kind.
  • rollout_kind_id (::String) — Required. The ID value for the new rollout kind.
  • rollout_kind (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind, ::Hash) — Required. The desired state for the rollout kind.
  • validate_only (::Boolean) — If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
  • request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/saas_platform/saas_service_mgmt/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::CreateRolloutKindRequest.new

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

# The returned object is of type Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind.
p result

#delete_rollout

def delete_rollout(request, options = nil) -> ::Google::Protobuf::Empty
def delete_rollout(name: nil, etag: nil, validate_only: nil, request_id: nil) -> ::Google::Protobuf::Empty

Delete a single rollout.

Overloads 
def delete_rollout(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_rollout via a request object, either of type DeleteRolloutRequest or an equivalent Hash.
Parameters 
def delete_rollout(name: nil, etag: nil, validate_only: nil, request_id: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_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
  • name (::String) — Required. The resource name of the resource within a service.
  • etag (::String) — The etag known to the client for the expected state of the rollout. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource.

    An etag wildcard provide optimistic concurrency based on the expected existence of the rollout. The Any wildcard (*) requires that the resource must already exists, and the Not Any wildcard (!*) requires that it must not.

  • validate_only (::Boolean) — If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
  • request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/saas_platform/saas_service_mgmt/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::DeleteRolloutRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_rollout_kind

def delete_rollout_kind(request, options = nil) -> ::Google::Protobuf::Empty
def delete_rollout_kind(name: nil, etag: nil, validate_only: nil, request_id: nil) -> ::Google::Protobuf::Empty

Delete a single rollout kind.

Overloads 
def delete_rollout_kind(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_rollout_kind via a request object, either of type DeleteRolloutKindRequest or an equivalent Hash.
Parameters 
def delete_rollout_kind(name: nil, etag: nil, validate_only: nil, request_id: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_rollout_kind via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The resource name of the resource within a service.
  • etag (::String) — The etag known to the client for the expected state of the rollout kind. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource.

    An etag wildcard provide optimistic concurrency based on the expected existence of the rollout kind. The Any wildcard (*) requires that the resource must already exists, and the Not Any wildcard (!*) requires that it must not.

  • validate_only (::Boolean) — If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
  • request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/saas_platform/saas_service_mgmt/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::DeleteRolloutKindRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

#get_rollout

def get_rollout(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout
def get_rollout(name: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout

Retrieve a single rollout.

Overloads 
def get_rollout(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout
Pass arguments to get_rollout via a request object, either of type GetRolloutRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::GetRolloutRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_rollout(name: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout
Pass arguments to get_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).
Parameter
  • name (::String) — Required. The resource name of the resource within a service.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/saas_platform/saas_service_mgmt/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::GetRolloutRequest.new

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

# The returned object is of type Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout.
p result

#get_rollout_kind

def get_rollout_kind(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind
def get_rollout_kind(name: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind

Retrieve a single rollout kind.

Overloads 
def get_rollout_kind(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind
Pass arguments to get_rollout_kind via a request object, either of type GetRolloutKindRequest or an equivalent Hash.
Parameters 
def get_rollout_kind(name: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind
Pass arguments to get_rollout_kind 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).
Parameter
  • name (::String) — Required. The resource name of the resource within a service.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/saas_platform/saas_service_mgmt/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::GetRolloutKindRequest.new

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

# The returned object is of type Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new SaasRollouts client object.

Yields
  • (config) — Configure the SaasRollouts client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client.new do |config|
  config.timeout = 10.0
end

#list_rollout_kinds

def list_rollout_kinds(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind>
def list_rollout_kinds(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind>

Retrieve a collection of rollout kinds.

Overloads 
def list_rollout_kinds(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind>
Pass arguments to list_rollout_kinds via a request object, either of type ListRolloutKindsRequest or an equivalent Hash.
Parameters 
def list_rollout_kinds(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind>
Pass arguments to list_rollout_kinds via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent of the rollout kind.
  • page_size (::Integer) — The maximum number of rollout kinds to send per page.
  • page_token (::String) — The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.
  • filter (::String) — Filter the list as specified in https://google.aip.dev/160.
  • order_by (::String) — Order results as specified in https://google.aip.dev/132.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/saas_platform/saas_service_mgmt/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::ListRolloutKindsRequest.new

# Call the list_rollout_kinds method.
result = client.list_rollout_kinds 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::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind.
  p item
end

#list_rollouts

def list_rollouts(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout>
def list_rollouts(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout>

Retrieve a collection of rollouts.

Overloads 
def list_rollouts(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout>
Pass arguments to list_rollouts via a request object, either of type ListRolloutsRequest or an equivalent Hash.
Parameters 
def list_rollouts(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout>
Pass arguments to list_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
  • parent (::String) — Required. The parent of the rollout.
  • page_size (::Integer) — The maximum number of rollouts to send per page.
  • page_token (::String) — The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.
  • filter (::String) — Filter the list as specified in https://google.aip.dev/160.
  • order_by (::String) — Order results as specified in https://google.aip.dev/132.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/saas_platform/saas_service_mgmt/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::ListRolloutsRequest.new

# Call the list_rollouts method.
result = client.list_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::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

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

Returns
  • (Google::Cloud::Location::Locations::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_rollout

def update_rollout(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout
def update_rollout(rollout: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout

Update a single rollout.

Overloads 
def update_rollout(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout
Pass arguments to update_rollout via a request object, either of type UpdateRolloutRequest or an equivalent Hash.
Parameters 
def update_rollout(rollout: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout
Pass arguments to update_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
  • rollout (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout, ::Hash) — Required. The desired state for the rollout.
  • validate_only (::Boolean) — If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
  • request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Field mask is used to specify the fields to be overwritten in the Rollout resource by the update.

    The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

    If the user does not provide a mask then all fields in the Rollout will be overwritten.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/saas_platform/saas_service_mgmt/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UpdateRolloutRequest.new

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

# The returned object is of type Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Rollout.
p result

#update_rollout_kind

def update_rollout_kind(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind
def update_rollout_kind(rollout_kind: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind

Update a single rollout kind.

Overloads 
def update_rollout_kind(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind
Pass arguments to update_rollout_kind via a request object, either of type UpdateRolloutKindRequest or an equivalent Hash.
Parameters 
def update_rollout_kind(rollout_kind: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind
Pass arguments to update_rollout_kind 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
  • rollout_kind (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind, ::Hash) — Required. The desired state for the rollout kind.
  • validate_only (::Boolean) — If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
  • request_id (::String) — An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Field mask is used to specify the fields to be overwritten in the RolloutKind resource by the update.

    The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

    If the user does not provide a mask then all fields in the RolloutKind will be overwritten.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/saas_platform/saas_service_mgmt/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasRollouts::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UpdateRolloutKindRequest.new

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

# The returned object is of type Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::RolloutKind.
p result