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

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

Client for the SaasDeployments service.

Manages the deployment of SaaS services.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the SaasDeployments 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 SaasDeployments clients
::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::SaasDeployments::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the SaasDeployments 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_release

def create_release(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Release
def create_release(parent: nil, release_id: nil, release: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Release

Create a new release.

Overloads 
def create_release(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Release
Pass arguments to create_release via a request object, either of type CreateReleaseRequest or an equivalent Hash.
Parameters 
def create_release(parent: nil, release_id: nil, release: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Release
Pass arguments to create_release 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 release.
  • release_id (::String) — Required. The ID value for the new release.
  • release (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Release, ::Hash) — Required. The desired state for the release.
  • 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::SaasDeployments::Client.new

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

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

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

#create_saas

def create_saas(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Saas
def create_saas(parent: nil, saas_id: nil, saas: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Saas

Create a new saas.

Overloads 
def create_saas(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Saas
Pass arguments to create_saas via a request object, either of type CreateSaasRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::CreateSaasRequest, ::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 create_saas(parent: nil, saas_id: nil, saas: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Saas
Pass arguments to create_saas 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 saas.
  • saas_id (::String) — Required. The ID value for the new saas.
  • saas (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Saas, ::Hash) — Required. The desired state for the saas.
  • 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::SaasDeployments::Client.new

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

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

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

#create_tenant

def create_tenant(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Tenant
def create_tenant(parent: nil, tenant_id: nil, tenant: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Tenant

Create a new tenant.

Overloads 
def create_tenant(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Tenant
Pass arguments to create_tenant via a request object, either of type CreateTenantRequest or an equivalent Hash.
Parameters 
def create_tenant(parent: nil, tenant_id: nil, tenant: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Tenant
Pass arguments to create_tenant 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 tenant.
  • tenant_id (::String) — Required. The ID value for the new tenant.
  • tenant (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Tenant, ::Hash) — Required. The desired state for the tenant.
  • 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::SaasDeployments::Client.new

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

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

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

#create_unit

def create_unit(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit
def create_unit(parent: nil, unit_id: nil, unit: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit

Create a new unit.

Overloads 
def create_unit(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit
Pass arguments to create_unit via a request object, either of type CreateUnitRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::CreateUnitRequest, ::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 create_unit(parent: nil, unit_id: nil, unit: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit
Pass arguments to create_unit 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 unit.
  • unit_id (::String) — Required. The ID value for the new unit.
  • unit (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit, ::Hash) — Required. The desired state for the unit.
  • 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::SaasDeployments::Client.new

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

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

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

#create_unit_kind

def create_unit_kind(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitKind
def create_unit_kind(parent: nil, unit_kind_id: nil, unit_kind: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitKind

Create a new unit kind.

Overloads 
def create_unit_kind(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitKind
Pass arguments to create_unit_kind via a request object, either of type CreateUnitKindRequest or an equivalent Hash.
Parameters 
def create_unit_kind(parent: nil, unit_kind_id: nil, unit_kind: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitKind
Pass arguments to create_unit_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 unit kind.
  • unit_kind_id (::String) — Required. The ID value for the new unit kind.
  • unit_kind (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitKind, ::Hash) — Required. The desired state for the unit 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::SaasDeployments::Client.new

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

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

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

#create_unit_operation

def create_unit_operation(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation
def create_unit_operation(parent: nil, unit_operation_id: nil, unit_operation: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation

Create a new unit operation.

Overloads 
def create_unit_operation(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation
Pass arguments to create_unit_operation via a request object, either of type CreateUnitOperationRequest or an equivalent Hash.
Parameters 
def create_unit_operation(parent: nil, unit_operation_id: nil, unit_operation: nil, validate_only: nil, request_id: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation
Pass arguments to create_unit_operation 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 unit operation.
  • unit_operation_id (::String) — Required. The ID value for the new unit operation.
  • unit_operation (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation, ::Hash) — Required. The desired state for the unit operation.
  • 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::SaasDeployments::Client.new

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

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

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

#delete_release

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

Delete a single release.

Overloads 
def delete_release(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_release via a request object, either of type DeleteReleaseRequest or an equivalent Hash.
Parameters 
def delete_release(name: nil, etag: nil, validate_only: nil, request_id: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_release 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 release. 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 release. 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::SaasDeployments::Client.new

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

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

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

#delete_saas

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

Delete a single saas.

Overloads 
def delete_saas(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_saas via a request object, either of type DeleteSaasRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::DeleteSaasRequest, ::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 delete_saas(name: nil, etag: nil, validate_only: nil, request_id: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_saas 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 saas. 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 saas. 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::SaasDeployments::Client.new

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

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

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

#delete_tenant

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

Delete a single tenant.

Overloads 
def delete_tenant(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_tenant via a request object, either of type DeleteTenantRequest or an equivalent Hash.
Parameters 
def delete_tenant(name: nil, etag: nil, validate_only: nil, request_id: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_tenant 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 tenant. 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 tenant. 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::SaasDeployments::Client.new

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

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

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

#delete_unit

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

Delete a single unit.

Overloads 
def delete_unit(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_unit via a request object, either of type DeleteUnitRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::DeleteUnitRequest, ::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 delete_unit(name: nil, etag: nil, validate_only: nil, request_id: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_unit 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 unit. 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 unit. 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::SaasDeployments::Client.new

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

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

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

#delete_unit_kind

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

Delete a single unit kind.

Overloads 
def delete_unit_kind(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_unit_kind via a request object, either of type DeleteUnitKindRequest or an equivalent Hash.
Parameters 
def delete_unit_kind(name: nil, etag: nil, validate_only: nil, request_id: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_unit_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 unit 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 unit 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::SaasDeployments::Client.new

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

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

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

#delete_unit_operation

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

Delete a single unit operation.

Overloads 
def delete_unit_operation(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_unit_operation via a request object, either of type DeleteUnitOperationRequest or an equivalent Hash.
Parameters 
def delete_unit_operation(name: nil, etag: nil, validate_only: nil, request_id: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_unit_operation 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 unit operation. 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 unit operation. 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::SaasDeployments::Client.new

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

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

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

#get_release

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

Retrieve a single release.

Overloads 
def get_release(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Release
Pass arguments to get_release via a request object, either of type GetReleaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::GetReleaseRequest, ::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_release(name: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Release
Pass arguments to get_release 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::SaasDeployments::Client.new

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

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

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

#get_saas

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

Retrieve a single saas.

Overloads 
def get_saas(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Saas
Pass arguments to get_saas via a request object, either of type GetSaasRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::GetSaasRequest, ::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_saas(name: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Saas
Pass arguments to get_saas 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::SaasDeployments::Client.new

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

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

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

#get_tenant

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

Retrieve a single tenant.

Overloads 
def get_tenant(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Tenant
Pass arguments to get_tenant via a request object, either of type GetTenantRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::GetTenantRequest, ::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_tenant(name: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Tenant
Pass arguments to get_tenant 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::SaasDeployments::Client.new

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

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

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

#get_unit

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

Retrieve a single unit.

Overloads 
def get_unit(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit
Pass arguments to get_unit via a request object, either of type GetUnitRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::GetUnitRequest, ::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_unit(name: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit
Pass arguments to get_unit 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::SaasDeployments::Client.new

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

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

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

#get_unit_kind

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

Retrieve a single unit kind.

Overloads 
def get_unit_kind(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitKind
Pass arguments to get_unit_kind via a request object, either of type GetUnitKindRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::GetUnitKindRequest, ::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_unit_kind(name: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitKind
Pass arguments to get_unit_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::SaasDeployments::Client.new

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

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

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

#get_unit_operation

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

Retrieve a single unit operation.

Overloads 
def get_unit_operation(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation
Pass arguments to get_unit_operation via a request object, either of type GetUnitOperationRequest or an equivalent Hash.
Parameters 
def get_unit_operation(name: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation
Pass arguments to get_unit_operation 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::SaasDeployments::Client.new

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

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

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

#initialize

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

Create a new SaasDeployments client object.

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

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

#list_releases

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

Retrieve a collection of releases.

Overloads 
def list_releases(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Release>
Pass arguments to list_releases via a request object, either of type ListReleasesRequest or an equivalent Hash.
Parameters 
def list_releases(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Release>
Pass arguments to list_releases 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 release.
  • page_size (::Integer) — The maximum number of releases 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::SaasDeployments::Client.new

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

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

#list_saas

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

Retrieve a collection of saas.

Overloads 
def list_saas(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Saas>
Pass arguments to list_saas via a request object, either of type ListSaasRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::ListSaasRequest, ::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 list_saas(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Saas>
Pass arguments to list_saas 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 saas.
  • page_size (::Integer) — The maximum number of saas 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::SaasDeployments::Client.new

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

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

#list_tenants

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

Retrieve a collection of tenants.

Overloads 
def list_tenants(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Tenant>
Pass arguments to list_tenants via a request object, either of type ListTenantsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::ListTenantsRequest, ::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 list_tenants(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Tenant>
Pass arguments to list_tenants 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 tenant.
  • page_size (::Integer) — The maximum number of tenants 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::SaasDeployments::Client.new

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

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

#list_unit_kinds

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

Retrieve a collection of unit kinds.

Overloads 
def list_unit_kinds(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitKind>
Pass arguments to list_unit_kinds via a request object, either of type ListUnitKindsRequest or an equivalent Hash.
Parameters 
def list_unit_kinds(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitKind>
Pass arguments to list_unit_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 unit kind.
  • page_size (::Integer) — The maximum number of unit 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::SaasDeployments::Client.new

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

# Call the list_unit_kinds method.
result = client.list_unit_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::UnitKind.
  p item
end

#list_unit_operations

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

Retrieve a collection of unit operations.

Overloads 
def list_unit_operations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation>
Pass arguments to list_unit_operations via a request object, either of type ListUnitOperationsRequest or an equivalent Hash.
Parameters 
def list_unit_operations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation>
Pass arguments to list_unit_operations 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 unit operation.
  • page_size (::Integer) — The maximum number of unit operations 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::SaasDeployments::Client.new

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

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

#list_units

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

Retrieve a collection of units.

Overloads 
def list_units(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit>
Pass arguments to list_units via a request object, either of type ListUnitsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::ListUnitsRequest, ::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 list_units(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit>
Pass arguments to list_units 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 unit.
  • page_size (::Integer) — The maximum number of units 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::SaasDeployments::Client.new

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

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

def update_release(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Release
def update_release(release: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Release

Update a single release.

Overloads 
def update_release(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Release
Pass arguments to update_release via a request object, either of type UpdateReleaseRequest or an equivalent Hash.
Parameters 
def update_release(release: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Release
Pass arguments to update_release 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
  • release (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Release, ::Hash) — Required. The desired state for the release.
  • 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 Release 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 Release 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::SaasDeployments::Client.new

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

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

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

#update_saas

def update_saas(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Saas
def update_saas(saas: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Saas

Update a single saas.

Overloads 
def update_saas(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Saas
Pass arguments to update_saas via a request object, either of type UpdateSaasRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UpdateSaasRequest, ::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 update_saas(saas: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Saas
Pass arguments to update_saas 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
  • saas (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Saas, ::Hash) — Required. The desired state for the saas.
  • 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 Saas 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 Saas 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::SaasDeployments::Client.new

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

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

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

#update_tenant

def update_tenant(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Tenant
def update_tenant(tenant: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Tenant

Update a single tenant.

Overloads 
def update_tenant(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Tenant
Pass arguments to update_tenant via a request object, either of type UpdateTenantRequest or an equivalent Hash.
Parameters 
def update_tenant(tenant: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Tenant
Pass arguments to update_tenant 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
  • tenant (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Tenant, ::Hash) — Required. The desired state for the tenant.
  • 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 Tenant 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 Tenant 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::SaasDeployments::Client.new

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

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

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

#update_unit

def update_unit(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit
def update_unit(unit: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit

Update a single unit.

Overloads 
def update_unit(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit
Pass arguments to update_unit via a request object, either of type UpdateUnitRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UpdateUnitRequest, ::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 update_unit(unit: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit
Pass arguments to update_unit 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
  • unit (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::Unit, ::Hash) — Required. The desired state for the unit.
  • 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 Unit 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 Unit 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::SaasDeployments::Client.new

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

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

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

#update_unit_kind

def update_unit_kind(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitKind
def update_unit_kind(unit_kind: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitKind

Update a single unit kind.

Overloads 
def update_unit_kind(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitKind
Pass arguments to update_unit_kind via a request object, either of type UpdateUnitKindRequest or an equivalent Hash.
Parameters 
def update_unit_kind(unit_kind: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitKind
Pass arguments to update_unit_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
  • unit_kind (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitKind, ::Hash) — Required. The desired state for the unit 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 UnitKind 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 UnitKind 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::SaasDeployments::Client.new

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

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

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

#update_unit_operation

def update_unit_operation(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation
def update_unit_operation(unit_operation: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation

Update a single unit operation.

Overloads 
def update_unit_operation(request, options = nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation
Pass arguments to update_unit_operation via a request object, either of type UpdateUnitOperationRequest or an equivalent Hash.
Parameters 
def update_unit_operation(unit_operation: nil, validate_only: nil, request_id: nil, update_mask: nil) -> ::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation
Pass arguments to update_unit_operation 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
  • unit_operation (::Google::Cloud::SaasPlatform::SaasServiceMgmt::V1beta1::UnitOperation, ::Hash) — Required. The desired state for the unit operation.
  • 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 UnitOperation 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 UnitOperation 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::SaasDeployments::Client.new

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

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

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