Parameter Manager V1 API - Class Google::Cloud::ParameterManager::V1::ParameterManager::Client (v0.1.0)

Reference documentation and code samples for the Parameter Manager V1 API class Google::Cloud::ParameterManager::V1::ParameterManager::Client.

Client for the ParameterManager service.

Service describing handlers for resources

Inherits

Object

Includes

Google::Cloud::ParameterManager::V1::ParameterManager::Paths

Methods

.configure

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

Configure the ParameterManager Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

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

#configure

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

Configure the ParameterManager 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

config (Client::Configuration)

Returns

(Client::Configuration)

#create_parameter

def create_parameter(request, options = nil) -> ::Google::Cloud::ParameterManager::V1::Parameter
def create_parameter(parent: nil, parameter_id: nil, parameter: nil, request_id: nil) -> ::Google::Cloud::ParameterManager::V1::Parameter

Creates a new Parameter in a given project and location.

Overloads

def create_parameter(request, options = nil) -> ::Google::Cloud::ParameterManager::V1::Parameter

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

Parameters

request (::Google::Cloud::ParameterManager::V1::CreateParameterRequest, ::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_parameter(parent: nil, parameter_id: nil, parameter: nil, request_id: nil) -> ::Google::Cloud::ParameterManager::V1::Parameter

Pass arguments to create_parameter 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 in the format projects/*/locations/*.
parameter_id (::String) — Required. Id of the Parameter resource
parameter (::Google::Cloud::ParameterManager::V1::Parameter, ::Hash) — Required. The Parameter 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 (::Google::Cloud::ParameterManager::V1::Parameter)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ParameterManager::V1::Parameter)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/parameter_manager/v1"

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

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

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

# The returned object is of type Google::Cloud::ParameterManager::V1::Parameter.
p result

#create_parameter_version

def create_parameter_version(request, options = nil) -> ::Google::Cloud::ParameterManager::V1::ParameterVersion
def create_parameter_version(parent: nil, parameter_version_id: nil, parameter_version: nil, request_id: nil) -> ::Google::Cloud::ParameterManager::V1::ParameterVersion

Creates a new ParameterVersion in a given project, location, and parameter.

Overloads

def create_parameter_version(request, options = nil) -> ::Google::Cloud::ParameterManager::V1::ParameterVersion

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

Parameters

request (::Google::Cloud::ParameterManager::V1::CreateParameterVersionRequest, ::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_parameter_version(parent: nil, parameter_version_id: nil, parameter_version: nil, request_id: nil) -> ::Google::Cloud::ParameterManager::V1::ParameterVersion

Pass arguments to create_parameter_version 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 in the format projects/*/locations/*/parameters/*.
parameter_version_id (::String) — Required. Id of the ParameterVersion resource
parameter_version (::Google::Cloud::ParameterManager::V1::ParameterVersion, ::Hash) — Required. The ParameterVersion 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 (::Google::Cloud::ParameterManager::V1::ParameterVersion)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ParameterManager::V1::ParameterVersion)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/parameter_manager/v1"

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

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

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

# The returned object is of type Google::Cloud::ParameterManager::V1::ParameterVersion.
p result

#delete_parameter

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

Deletes a single Parameter.

Overloads

def delete_parameter(request, options = nil) -> ::Google::Protobuf::Empty

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

Parameters

request (::Google::Cloud::ParameterManager::V1::DeleteParameterRequest, ::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_parameter(name: nil, request_id: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_parameter 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 in the format projects/*/locations/*/parameters/*.
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 (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/parameter_manager/v1"

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

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

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

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

#delete_parameter_version

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

Deletes a single ParameterVersion.

Overloads

def delete_parameter_version(request, options = nil) -> ::Google::Protobuf::Empty

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

Parameters

request (::Google::Cloud::ParameterManager::V1::DeleteParameterVersionRequest, ::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_parameter_version(name: nil, request_id: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_parameter_version 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 in the format projects/*/locations/*/parameters/*/versions/*.
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 (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/parameter_manager/v1"

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

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

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

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

#get_parameter

def get_parameter(request, options = nil) -> ::Google::Cloud::ParameterManager::V1::Parameter
def get_parameter(name: nil) -> ::Google::Cloud::ParameterManager::V1::Parameter

Gets details of a single Parameter.

Overloads

def get_parameter(request, options = nil) -> ::Google::Cloud::ParameterManager::V1::Parameter

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

Parameters

request (::Google::Cloud::ParameterManager::V1::GetParameterRequest, ::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_parameter(name: nil) -> ::Google::Cloud::ParameterManager::V1::Parameter

Pass arguments to get_parameter 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 in the format projects/*/locations/*/parameters/*.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ParameterManager::V1::Parameter)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ParameterManager::V1::Parameter)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/parameter_manager/v1"

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

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

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

# The returned object is of type Google::Cloud::ParameterManager::V1::Parameter.
p result

#get_parameter_version

def get_parameter_version(request, options = nil) -> ::Google::Cloud::ParameterManager::V1::ParameterVersion
def get_parameter_version(name: nil, view: nil) -> ::Google::Cloud::ParameterManager::V1::ParameterVersion

Gets details of a single ParameterVersion.

Overloads

def get_parameter_version(request, options = nil) -> ::Google::Cloud::ParameterManager::V1::ParameterVersion

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

Parameters

request (::Google::Cloud::ParameterManager::V1::GetParameterVersionRequest, ::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_parameter_version(name: nil, view: nil) -> ::Google::Cloud::ParameterManager::V1::ParameterVersion

Pass arguments to get_parameter_version 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 in the format projects/*/locations/*/parameters/*/versions/*.
view (::Google::Cloud::ParameterManager::V1::View) — Optional. View of the ParameterVersion. In the default FULL view, all metadata & payload associated with the ParameterVersion will be returned.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::ParameterManager::V1::ParameterVersion)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ParameterManager::V1::ParameterVersion)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/parameter_manager/v1"

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

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

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

# The returned object is of type Google::Cloud::ParameterManager::V1::ParameterVersion.
p result

#initialize

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

Create a new ParameterManager client object.

Yields

(config) — Configure the ParameterManager client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

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

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

#list_parameter_versions

def list_parameter_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ParameterManager::V1::ParameterVersion>
def list_parameter_versions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ParameterManager::V1::ParameterVersion>

Lists ParameterVersions in a given project, location, and parameter.

Overloads

def list_parameter_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ParameterManager::V1::ParameterVersion>

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

Parameters

request (::Google::Cloud::ParameterManager::V1::ListParameterVersionsRequest, ::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_parameter_versions(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ParameterManager::V1::ParameterVersion>

Pass arguments to list_parameter_versions 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 ListParameterVersionsRequest in the format projects/*/locations/*/parameters/*.
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

response (::Gapic::PagedEnumerable<::Google::Cloud::ParameterManager::V1::ParameterVersion>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::ParameterManager::V1::ParameterVersion>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/parameter_manager/v1"

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

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

# Call the list_parameter_versions method.
result = client.list_parameter_versions 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::ParameterManager::V1::ParameterVersion.
  p item
end

#list_parameters

def list_parameters(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ParameterManager::V1::Parameter>
def list_parameters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ParameterManager::V1::Parameter>

Lists Parameters in a given project and location.

Overloads

def list_parameters(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ParameterManager::V1::Parameter>

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

Parameters

request (::Google::Cloud::ParameterManager::V1::ListParametersRequest, ::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_parameters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ParameterManager::V1::Parameter>

Pass arguments to list_parameters 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 ListParametersRequest in the format projects/*/locations/*.
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

response (::Gapic::PagedEnumerable<::Google::Cloud::ParameterManager::V1::Parameter>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::ParameterManager::V1::Parameter>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/parameter_manager/v1"

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

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

# Call the list_parameters method.
result = client.list_parameters 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::ParameterManager::V1::Parameter.
  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)

#render_parameter_version

def render_parameter_version(request, options = nil) -> ::Google::Cloud::ParameterManager::V1::RenderParameterVersionResponse
def render_parameter_version(name: nil) -> ::Google::Cloud::ParameterManager::V1::RenderParameterVersionResponse

Gets rendered version of a ParameterVersion.

Overloads

def render_parameter_version(request, options = nil) -> ::Google::Cloud::ParameterManager::V1::RenderParameterVersionResponse

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

Parameters

request (::Google::Cloud::ParameterManager::V1::RenderParameterVersionRequest, ::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 render_parameter_version(name: nil) -> ::Google::Cloud::ParameterManager::V1::RenderParameterVersionResponse

Pass arguments to render_parameter_version 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

response (::Google::Cloud::ParameterManager::V1::RenderParameterVersionResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ParameterManager::V1::RenderParameterVersionResponse)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/parameter_manager/v1"

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

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

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

# The returned object is of type Google::Cloud::ParameterManager::V1::RenderParameterVersionResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_parameter

def update_parameter(request, options = nil) -> ::Google::Cloud::ParameterManager::V1::Parameter
def update_parameter(update_mask: nil, parameter: nil, request_id: nil) -> ::Google::Cloud::ParameterManager::V1::Parameter

Updates a single Parameter.

Overloads

def update_parameter(request, options = nil) -> ::Google::Cloud::ParameterManager::V1::Parameter

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

Parameters

request (::Google::Cloud::ParameterManager::V1::UpdateParameterRequest, ::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_parameter(update_mask: nil, parameter: nil, request_id: nil) -> ::Google::Cloud::ParameterManager::V1::Parameter

Pass arguments to update_parameter 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 Parameter resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request will be overwritten.
parameter (::Google::Cloud::ParameterManager::V1::Parameter, ::Hash) — Required. The Parameter 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 (::Google::Cloud::ParameterManager::V1::Parameter)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ParameterManager::V1::Parameter)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/parameter_manager/v1"

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

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

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

# The returned object is of type Google::Cloud::ParameterManager::V1::Parameter.
p result

#update_parameter_version

def update_parameter_version(request, options = nil) -> ::Google::Cloud::ParameterManager::V1::ParameterVersion
def update_parameter_version(update_mask: nil, parameter_version: nil, request_id: nil) -> ::Google::Cloud::ParameterManager::V1::ParameterVersion

Updates a single ParameterVersion.

Overloads

def update_parameter_version(request, options = nil) -> ::Google::Cloud::ParameterManager::V1::ParameterVersion

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

Parameters

request (::Google::Cloud::ParameterManager::V1::UpdateParameterVersionRequest, ::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_parameter_version(update_mask: nil, parameter_version: nil, request_id: nil) -> ::Google::Cloud::ParameterManager::V1::ParameterVersion

Pass arguments to update_parameter_version 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 ParameterVersion resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request will be overwritten.
parameter_version (::Google::Cloud::ParameterManager::V1::ParameterVersion, ::Hash) — Required. The ParameterVersion 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 (::Google::Cloud::ParameterManager::V1::ParameterVersion)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::ParameterManager::V1::ParameterVersion)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/parameter_manager/v1"

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

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

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

# The returned object is of type Google::Cloud::ParameterManager::V1::ParameterVersion.
p result