Config Delivery V1 API - Class Google::Cloud::ConfigDelivery::V1::ConfigDelivery::Client (v0.3.0)

Reference documentation and code samples for the Config Delivery V1 API class Google::Cloud::ConfigDelivery::V1::ConfigDelivery::Client.

Client for the ConfigDelivery service.

ConfigDelivery service manages the deployment of kubernetes configuration to a fleet of kubernetes clusters.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the ConfigDelivery 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 ConfigDelivery clients
::Google::Cloud::ConfigDelivery::V1::ConfigDelivery::Client.configure do |config|
  config.timeout = 10.0
end

#abort_rollout

def abort_rollout(request, options = nil) -> ::Gapic::Operation
def abort_rollout(name: nil, reason: nil) -> ::Gapic::Operation

Abort a Rollout.

Overloads 
def abort_rollout(request, options = nil) -> ::Gapic::Operation
Pass arguments to abort_rollout via a request object, either of type AbortRolloutRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::AbortRolloutRequest, ::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 abort_rollout(name: nil, reason: nil) -> ::Gapic::Operation
Pass arguments to abort_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. Name of the Rollout.
  • reason (::String) — Optional. Reason for aborting.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#configure

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

Configure the ConfigDelivery 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_fleet_package

def create_fleet_package(request, options = nil) -> ::Gapic::Operation
def create_fleet_package(parent: nil, fleet_package_id: nil, fleet_package: nil, request_id: nil) -> ::Gapic::Operation

Creates a new FleetPackage in a given project and location.

Overloads 
def create_fleet_package(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_fleet_package via a request object, either of type Google::Cloud::ConfigDelivery::V1::CreateFleetPackageRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::CreateFleetPackageRequest, ::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_fleet_package(parent: nil, fleet_package_id: nil, fleet_package: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_fleet_package 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. Value for parent.
  • fleet_package_id (::String) — Required. Id of the requesting object If auto-generating Id server-side, remove this field and fleet_package_id from the method_signature of Create RPC
  • fleet_package (::Google::Cloud::ConfigDelivery::V1::FleetPackage, ::Hash) — Required. The resource being created.
  • request_id (::String) — Optional. 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
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_release

def create_release(request, options = nil) -> ::Gapic::Operation
def create_release(parent: nil, release_id: nil, release: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Release in a given project, location and resource bundle.

Overloads 
def create_release(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_release via a request object, either of type Google::Cloud::ConfigDelivery::V1::CreateReleaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::CreateReleaseRequest, ::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_release(parent: nil, release_id: nil, release: nil, request_id: nil) -> ::Gapic::Operation
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. Value for parent.
  • release_id (::String) — Required. Id of the requesting object If auto-generating Id server-side, remove this field and release_id from the method_signature of Create RPC
  • release (::Google::Cloud::ConfigDelivery::V1::Release, ::Hash) — Required. The resource being created
  • request_id (::String) — Optional. 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
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_resource_bundle

def create_resource_bundle(request, options = nil) -> ::Gapic::Operation
def create_resource_bundle(parent: nil, resource_bundle_id: nil, resource_bundle: nil, request_id: nil) -> ::Gapic::Operation

Creates a new ResourceBundle in a given project and location.

Overloads 
def create_resource_bundle(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_resource_bundle via a request object, either of type Google::Cloud::ConfigDelivery::V1::CreateResourceBundleRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::CreateResourceBundleRequest, ::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_resource_bundle(parent: nil, resource_bundle_id: nil, resource_bundle: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_resource_bundle 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. Value for parent.
  • resource_bundle_id (::String) — Required. Id of the requesting object If auto-generating Id server-side, remove this field and resource_bundle_id from the method_signature of Create RPC
  • resource_bundle (::Google::Cloud::ConfigDelivery::V1::ResourceBundle, ::Hash) — Required. The resource being created
  • request_id (::String) — Optional. 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
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_variant

def create_variant(request, options = nil) -> ::Gapic::Operation
def create_variant(parent: nil, variant_id: nil, variant: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Variant in a given project, location, resource bundle, and release.

Overloads 
def create_variant(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_variant via a request object, either of type Google::Cloud::ConfigDelivery::V1::CreateVariantRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::CreateVariantRequest, ::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_variant(parent: nil, variant_id: nil, variant: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_variant 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. Value for parent.
  • variant_id (::String) — Required. Id of the requesting object
  • variant (::Google::Cloud::ConfigDelivery::V1::Variant, ::Hash) — Required. The resource being created
  • request_id (::String) — Optional. 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
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_fleet_package

def delete_fleet_package(request, options = nil) -> ::Gapic::Operation
def delete_fleet_package(name: nil, request_id: nil, force: nil, allow_missing: nil) -> ::Gapic::Operation

Deletes a single FleetPackage.

Overloads 
def delete_fleet_package(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_fleet_package via a request object, either of type DeleteFleetPackageRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::DeleteFleetPackageRequest, ::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_fleet_package(name: nil, request_id: nil, force: nil, allow_missing: nil) -> ::Gapic::Operation
Pass arguments to delete_fleet_package 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. Name of the resource
  • request_id (::String) — Optional. 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 after 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).

  • force (::Boolean) — Optional. If set to true, any rollouts for this FleetPackage will also be deleted. (Otherwise, the request will only work if the fleet package has no rollouts.)
  • allow_missing (::Boolean) — Optional. If set to true, then deleting an already deleted or non existing FleetPackage will succeed.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_release

def delete_release(request, options = nil) -> ::Gapic::Operation
def delete_release(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation

Deletes a single Release.

Overloads 
def delete_release(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_release via a request object, either of type DeleteReleaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::DeleteReleaseRequest, ::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_release(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation
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. Name of the resource
  • request_id (::String) — Optional. 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 after 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).

  • force (::Boolean) — Optional. If set to true, any variants of this release will also be deleted. (Otherwise, the request will only work if the release has no variants.)
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_resource_bundle

def delete_resource_bundle(request, options = nil) -> ::Gapic::Operation
def delete_resource_bundle(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation

Deletes a single ResourceBundle.

Overloads 
def delete_resource_bundle(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_resource_bundle via a request object, either of type DeleteResourceBundleRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::DeleteResourceBundleRequest, ::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_resource_bundle(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_resource_bundle 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. Name of the resource
  • request_id (::String) — Optional. 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 after 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).

  • force (::Boolean) — Optional. If set to true, any releases of this resource bundle will also be deleted. (Otherwise, the request will only work if the resource bundle has no releases.)
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_variant

def delete_variant(request, options = nil) -> ::Gapic::Operation
def delete_variant(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single Variant.

Overloads 
def delete_variant(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_variant via a request object, either of type DeleteVariantRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::DeleteVariantRequest, ::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_variant(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_variant 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. Name of the resource
  • request_id (::String) — Optional. 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 after 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
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_fleet_package

def get_fleet_package(request, options = nil) -> ::Google::Cloud::ConfigDelivery::V1::FleetPackage
def get_fleet_package(name: nil) -> ::Google::Cloud::ConfigDelivery::V1::FleetPackage

Gets details of a single FleetPackage.

Overloads 
def get_fleet_package(request, options = nil) -> ::Google::Cloud::ConfigDelivery::V1::FleetPackage
Pass arguments to get_fleet_package via a request object, either of type GetFleetPackageRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::GetFleetPackageRequest, ::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_fleet_package(name: nil) -> ::Google::Cloud::ConfigDelivery::V1::FleetPackage
Pass arguments to get_fleet_package 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. Name of the resource
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/config_delivery/v1"

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

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

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

# The returned object is of type Google::Cloud::ConfigDelivery::V1::FleetPackage.
p result

#get_release

def get_release(request, options = nil) -> ::Google::Cloud::ConfigDelivery::V1::Release
def get_release(name: nil) -> ::Google::Cloud::ConfigDelivery::V1::Release

Gets details of a single Release.

Overloads 
def get_release(request, options = nil) -> ::Google::Cloud::ConfigDelivery::V1::Release
Pass arguments to get_release via a request object, either of type GetReleaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::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::ConfigDelivery::V1::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. Name of the resource
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/config_delivery/v1"

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

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

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

# The returned object is of type Google::Cloud::ConfigDelivery::V1::Release.
p result

#get_resource_bundle

def get_resource_bundle(request, options = nil) -> ::Google::Cloud::ConfigDelivery::V1::ResourceBundle
def get_resource_bundle(name: nil) -> ::Google::Cloud::ConfigDelivery::V1::ResourceBundle

Gets details of a single ResourceBundle.

Overloads 
def get_resource_bundle(request, options = nil) -> ::Google::Cloud::ConfigDelivery::V1::ResourceBundle
Pass arguments to get_resource_bundle via a request object, either of type GetResourceBundleRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::GetResourceBundleRequest, ::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_resource_bundle(name: nil) -> ::Google::Cloud::ConfigDelivery::V1::ResourceBundle
Pass arguments to get_resource_bundle 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. Name of the resource.
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/config_delivery/v1"

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

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

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

# The returned object is of type Google::Cloud::ConfigDelivery::V1::ResourceBundle.
p result

#get_rollout

def get_rollout(request, options = nil) -> ::Google::Cloud::ConfigDelivery::V1::Rollout
def get_rollout(name: nil) -> ::Google::Cloud::ConfigDelivery::V1::Rollout

Gets details of a single Rollout.

Overloads 
def get_rollout(request, options = nil) -> ::Google::Cloud::ConfigDelivery::V1::Rollout
Pass arguments to get_rollout via a request object, either of type GetRolloutRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::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::ConfigDelivery::V1::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. Name of the resource
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/config_delivery/v1"

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

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

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

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

#get_variant

def get_variant(request, options = nil) -> ::Google::Cloud::ConfigDelivery::V1::Variant
def get_variant(name: nil) -> ::Google::Cloud::ConfigDelivery::V1::Variant

Gets details of a single Variant.

Overloads 
def get_variant(request, options = nil) -> ::Google::Cloud::ConfigDelivery::V1::Variant
Pass arguments to get_variant via a request object, either of type GetVariantRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::GetVariantRequest, ::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_variant(name: nil) -> ::Google::Cloud::ConfigDelivery::V1::Variant
Pass arguments to get_variant 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. Name of the resource
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/config_delivery/v1"

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

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

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

# The returned object is of type Google::Cloud::ConfigDelivery::V1::Variant.
p result

#initialize

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

Create a new ConfigDelivery client object.

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

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

#list_fleet_packages

def list_fleet_packages(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::FleetPackage>
def list_fleet_packages(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::FleetPackage>

Lists FleetPackages in a given project and location.

Overloads 
def list_fleet_packages(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::FleetPackage>
Pass arguments to list_fleet_packages via a request object, either of type ListFleetPackagesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::ListFleetPackagesRequest, ::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_fleet_packages(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::FleetPackage>
Pass arguments to list_fleet_packages 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. Parent value for ListFleetPackagesRequest.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering results
  • order_by (::String) — Optional. Hint for how to order the results
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/config_delivery/v1"

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

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

# Call the list_fleet_packages method.
result = client.list_fleet_packages 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::ConfigDelivery::V1::FleetPackage.
  p item
end

#list_releases

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

Lists Releases in a given project and location.

Overloads 
def list_releases(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::Release>
Pass arguments to list_releases via a request object, either of type ListReleasesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::ListReleasesRequest, ::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_releases(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::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. Parent value for ListReleasesRequest.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering results.
  • order_by (::String) — Optional. Hint for how to order the results.
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/config_delivery/v1"

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

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

#list_resource_bundles

def list_resource_bundles(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::ResourceBundle>
def list_resource_bundles(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::ResourceBundle>

Lists ResourceBundles in a given project and location.

Overloads 
def list_resource_bundles(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::ResourceBundle>
Pass arguments to list_resource_bundles via a request object, either of type ListResourceBundlesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::ListResourceBundlesRequest, ::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_resource_bundles(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::ResourceBundle>
Pass arguments to list_resource_bundles 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. Parent value for ListResourceBundlesRequest.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering results.
  • order_by (::String) — Optional. Hint for how to order the results.
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/config_delivery/v1"

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

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

# Call the list_resource_bundles method.
result = client.list_resource_bundles 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::ConfigDelivery::V1::ResourceBundle.
  p item
end

#list_rollouts

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

Lists Rollouts in a given project, location, and Fleet Package.

Overloads 
def list_rollouts(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::Rollout>
Pass arguments to list_rollouts via a request object, either of type ListRolloutsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::ListRolloutsRequest, ::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_rollouts(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::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. Parent value for ListRolloutsRequest
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering results
  • order_by (::String) — Optional. Hint for how to order the results
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/config_delivery/v1"

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

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

#list_variants

def list_variants(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::Variant>
def list_variants(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::Variant>

Lists Variants in a given project and location.

Overloads 
def list_variants(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::Variant>
Pass arguments to list_variants via a request object, either of type ListVariantsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::ListVariantsRequest, ::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_variants(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ConfigDelivery::V1::Variant>
Pass arguments to list_variants 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. Parent value for ListVariantsRequest.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering results.
  • order_by (::String) — Optional. Hint for how to order the results.
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/config_delivery/v1"

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

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

# Call the list_variants method.
result = client.list_variants 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::ConfigDelivery::V1::Variant.
  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)

#operations_client

def operations_client() -> ::Google::Cloud::ConfigDelivery::V1::ConfigDelivery::Operations

Get the associated client for long-running operations.

Returns

#resume_rollout

def resume_rollout(request, options = nil) -> ::Gapic::Operation
def resume_rollout(name: nil, reason: nil) -> ::Gapic::Operation

Resume a Rollout.

Overloads 
def resume_rollout(request, options = nil) -> ::Gapic::Operation
Pass arguments to resume_rollout via a request object, either of type ResumeRolloutRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::ResumeRolloutRequest, ::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 resume_rollout(name: nil, reason: nil) -> ::Gapic::Operation
Pass arguments to resume_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. Name of the Rollout.
  • reason (::String) — Optional. Reason for resuming the rollout.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#suspend_rollout

def suspend_rollout(request, options = nil) -> ::Gapic::Operation
def suspend_rollout(name: nil, reason: nil) -> ::Gapic::Operation

Suspend a Rollout.

Overloads 
def suspend_rollout(request, options = nil) -> ::Gapic::Operation
Pass arguments to suspend_rollout via a request object, either of type SuspendRolloutRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::SuspendRolloutRequest, ::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 suspend_rollout(name: nil, reason: nil) -> ::Gapic::Operation
Pass arguments to suspend_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. Name of the Rollout.
  • reason (::String) — Optional. Reason for suspension.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_fleet_package

def update_fleet_package(request, options = nil) -> ::Gapic::Operation
def update_fleet_package(update_mask: nil, fleet_package: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single FleetPackage.

Overloads 
def update_fleet_package(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_fleet_package via a request object, either of type UpdateFleetPackageRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::UpdateFleetPackageRequest, ::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_fleet_package(update_mask: nil, fleet_package: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_fleet_package 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
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the FleetPackage 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 will be overwritten.
  • fleet_package (::Google::Cloud::ConfigDelivery::V1::FleetPackage, ::Hash) — Required. The resource being updated
  • request_id (::String) — Optional. 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
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_release

def update_release(request, options = nil) -> ::Gapic::Operation
def update_release(update_mask: nil, release: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single Release.

Overloads 
def update_release(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_release via a request object, either of type UpdateReleaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::UpdateReleaseRequest, ::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_release(update_mask: nil, release: nil, request_id: nil) -> ::Gapic::Operation
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
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. 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 will be overwritten.
  • release (::Google::Cloud::ConfigDelivery::V1::Release, ::Hash) — Required. The resource being updated
  • request_id (::String) — Optional. 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
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_resource_bundle

def update_resource_bundle(request, options = nil) -> ::Gapic::Operation
def update_resource_bundle(update_mask: nil, resource_bundle: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single ResourceBundle.

Overloads 
def update_resource_bundle(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_resource_bundle via a request object, either of type UpdateResourceBundleRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::UpdateResourceBundleRequest, ::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_resource_bundle(update_mask: nil, resource_bundle: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_resource_bundle 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
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the ResourceBundle 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 will be overwritten.
  • resource_bundle (::Google::Cloud::ConfigDelivery::V1::ResourceBundle, ::Hash) — Required. The resource being updated
  • request_id (::String) — Optional. 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
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_variant

def update_variant(request, options = nil) -> ::Gapic::Operation
def update_variant(update_mask: nil, variant: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single Variant.

Overloads 
def update_variant(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_variant via a request object, either of type UpdateVariantRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ConfigDelivery::V1::UpdateVariantRequest, ::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_variant(update_mask: nil, variant: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_variant 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
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Field mask is used to specify the fields to be overwritten in the Variant 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 will be overwritten.
  • variant (::Google::Cloud::ConfigDelivery::V1::Variant, ::Hash) — Required. The resource being updated
  • request_id (::String) — Optional. 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
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/config_delivery/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end