Google IAM V1beta API - Class Google::Iam::V1beta::WorkloadIdentityPools::Client (v0.3.6)

Reference documentation and code samples for the Google IAM V1beta API class Google::Iam::V1beta::WorkloadIdentityPools::Client.

Client for the WorkloadIdentityPools service.

Manages WorkloadIdentityPools.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the WorkloadIdentityPools 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 WorkloadIdentityPools clients
::Google::Iam::V1beta::WorkloadIdentityPools::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the WorkloadIdentityPools 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_workload_identity_pool

def create_workload_identity_pool(request, options = nil) -> ::Gapic::Operation
def create_workload_identity_pool(parent: nil, workload_identity_pool: nil, workload_identity_pool_id: nil) -> ::Gapic::Operation

Creates a new WorkloadIdentityPool.

You cannot reuse the name of a deleted pool until 30 days after deletion.

Overloads 
def create_workload_identity_pool(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_workload_identity_pool via a request object, either of type CreateWorkloadIdentityPoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1beta::CreateWorkloadIdentityPoolRequest, ::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_workload_identity_pool(parent: nil, workload_identity_pool: nil, workload_identity_pool_id: nil) -> ::Gapic::Operation
Pass arguments to create_workload_identity_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource to create the pool in. The only supported location is global.
  • workload_identity_pool (::Google::Iam::V1beta::WorkloadIdentityPool, ::Hash) — Required. The pool to create.
  • workload_identity_pool_id (::String) — Required. The ID to use for the pool, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.
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/iam/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Iam::V1beta::WorkloadIdentityPools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1beta::CreateWorkloadIdentityPoolRequest.new

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

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

#create_workload_identity_pool_provider

def create_workload_identity_pool_provider(request, options = nil) -> ::Gapic::Operation
def create_workload_identity_pool_provider(parent: nil, workload_identity_pool_provider: nil, workload_identity_pool_provider_id: nil) -> ::Gapic::Operation

Creates a new [WorkloadIdentityPoolProvider][google.iam.v1beta.WorkloadIdentityProvider] in a WorkloadIdentityPool.

You cannot reuse the name of a deleted provider until 30 days after deletion.

Overloads 
def create_workload_identity_pool_provider(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_workload_identity_pool_provider via a request object, either of type CreateWorkloadIdentityPoolProviderRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1beta::CreateWorkloadIdentityPoolProviderRequest, ::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_workload_identity_pool_provider(parent: nil, workload_identity_pool_provider: nil, workload_identity_pool_provider_id: nil) -> ::Gapic::Operation
Pass arguments to create_workload_identity_pool_provider via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The pool to create this provider in.
  • workload_identity_pool_provider (::Google::Iam::V1beta::WorkloadIdentityPoolProvider, ::Hash) — Required. The provider to create.
  • workload_identity_pool_provider_id (::String) — Required. The ID for the provider, which becomes the final component of the resource name. This value must be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix gcp- is reserved for use by Google, and may not be specified.
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/iam/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Iam::V1beta::WorkloadIdentityPools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1beta::CreateWorkloadIdentityPoolProviderRequest.new

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

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

#delete_workload_identity_pool

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

Deletes a WorkloadIdentityPool.

You cannot use a deleted pool to exchange external credentials for Google Cloud credentials. However, deletion does not revoke credentials that have already been issued. Credentials issued for a deleted pool do not grant access to resources. If the pool is undeleted, and the credentials are not expired, they grant access again. You can undelete a pool for 30 days. After 30 days, deletion is permanent. You cannot update deleted pools. However, you can view and list them.

Overloads 
def delete_workload_identity_pool(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_workload_identity_pool via a request object, either of type DeleteWorkloadIdentityPoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1beta::DeleteWorkloadIdentityPoolRequest, ::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_workload_identity_pool(name: nil) -> ::Gapic::Operation
Pass arguments to delete_workload_identity_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the pool to delete.
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/iam/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Iam::V1beta::WorkloadIdentityPools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1beta::DeleteWorkloadIdentityPoolRequest.new

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

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

#delete_workload_identity_pool_provider

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

Deletes a [WorkloadIdentityPoolProvider][google.iam.v1beta.WorkloadIdentityProvider]. Deleting a provider does not revoke credentials that have already been issued; they continue to grant access. You can undelete a provider for 30 days. After 30 days, deletion is permanent. You cannot update deleted providers. However, you can view and list them.

Overloads 
def delete_workload_identity_pool_provider(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_workload_identity_pool_provider via a request object, either of type DeleteWorkloadIdentityPoolProviderRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1beta::DeleteWorkloadIdentityPoolProviderRequest, ::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_workload_identity_pool_provider(name: nil) -> ::Gapic::Operation
Pass arguments to delete_workload_identity_pool_provider via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the provider to delete.
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/iam/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Iam::V1beta::WorkloadIdentityPools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1beta::DeleteWorkloadIdentityPoolProviderRequest.new

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

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

#get_workload_identity_pool

def get_workload_identity_pool(request, options = nil) -> ::Google::Iam::V1beta::WorkloadIdentityPool
def get_workload_identity_pool(name: nil) -> ::Google::Iam::V1beta::WorkloadIdentityPool

Gets an individual WorkloadIdentityPool.

Overloads 
def get_workload_identity_pool(request, options = nil) -> ::Google::Iam::V1beta::WorkloadIdentityPool
Pass arguments to get_workload_identity_pool via a request object, either of type GetWorkloadIdentityPoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1beta::GetWorkloadIdentityPoolRequest, ::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_workload_identity_pool(name: nil) -> ::Google::Iam::V1beta::WorkloadIdentityPool
Pass arguments to get_workload_identity_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the pool to retrieve.
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/iam/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Iam::V1beta::WorkloadIdentityPools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1beta::GetWorkloadIdentityPoolRequest.new

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

# The returned object is of type Google::Iam::V1beta::WorkloadIdentityPool.
p result

#get_workload_identity_pool_provider

def get_workload_identity_pool_provider(request, options = nil) -> ::Google::Iam::V1beta::WorkloadIdentityPoolProvider
def get_workload_identity_pool_provider(name: nil) -> ::Google::Iam::V1beta::WorkloadIdentityPoolProvider

Gets an individual WorkloadIdentityPoolProvider.

Overloads 
def get_workload_identity_pool_provider(request, options = nil) -> ::Google::Iam::V1beta::WorkloadIdentityPoolProvider
Pass arguments to get_workload_identity_pool_provider via a request object, either of type GetWorkloadIdentityPoolProviderRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1beta::GetWorkloadIdentityPoolProviderRequest, ::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_workload_identity_pool_provider(name: nil) -> ::Google::Iam::V1beta::WorkloadIdentityPoolProvider
Pass arguments to get_workload_identity_pool_provider via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the provider to retrieve.
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/iam/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Iam::V1beta::WorkloadIdentityPools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1beta::GetWorkloadIdentityPoolProviderRequest.new

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

# The returned object is of type Google::Iam::V1beta::WorkloadIdentityPoolProvider.
p result

#initialize

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

Create a new WorkloadIdentityPools client object.

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

# Create a client using a custom configuration
client = ::Google::Iam::V1beta::WorkloadIdentityPools::Client.new do |config|
  config.timeout = 10.0
end

#list_workload_identity_pool_providers

def list_workload_identity_pool_providers(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Iam::V1beta::WorkloadIdentityPoolProvider>
def list_workload_identity_pool_providers(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) -> ::Gapic::PagedEnumerable<::Google::Iam::V1beta::WorkloadIdentityPoolProvider>

Lists all non-deleted WorkloadIdentityPoolProviders in a WorkloadIdentityPool. If show_deleted is set to true, then deleted providers are also listed.

Overloads 
def list_workload_identity_pool_providers(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Iam::V1beta::WorkloadIdentityPoolProvider>
Pass arguments to list_workload_identity_pool_providers via a request object, either of type ListWorkloadIdentityPoolProvidersRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1beta::ListWorkloadIdentityPoolProvidersRequest, ::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_workload_identity_pool_providers(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) -> ::Gapic::PagedEnumerable<::Google::Iam::V1beta::WorkloadIdentityPoolProvider>
Pass arguments to list_workload_identity_pool_providers via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The pool to list providers for.
  • page_size (::Integer) — The maximum number of providers to return. If unspecified, at most 50 providers are returned. The maximum value is 100; values above 100 are truncated to 100.
  • page_token (::String) — A page token, received from a previous ListWorkloadIdentityPoolProviders call. Provide this to retrieve the subsequent page.
  • show_deleted (::Boolean) — Whether to return soft-deleted providers.
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/iam/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Iam::V1beta::WorkloadIdentityPools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1beta::ListWorkloadIdentityPoolProvidersRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Iam::V1beta::WorkloadIdentityPoolProvider.
  p response
end

#list_workload_identity_pools

def list_workload_identity_pools(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Iam::V1beta::WorkloadIdentityPool>
def list_workload_identity_pools(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) -> ::Gapic::PagedEnumerable<::Google::Iam::V1beta::WorkloadIdentityPool>

Lists all non-deleted WorkloadIdentityPools in a project. If show_deleted is set to true, then deleted pools are also listed.

Overloads 
def list_workload_identity_pools(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Iam::V1beta::WorkloadIdentityPool>
Pass arguments to list_workload_identity_pools via a request object, either of type ListWorkloadIdentityPoolsRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1beta::ListWorkloadIdentityPoolsRequest, ::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_workload_identity_pools(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) -> ::Gapic::PagedEnumerable<::Google::Iam::V1beta::WorkloadIdentityPool>
Pass arguments to list_workload_identity_pools via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource to list pools for.
  • page_size (::Integer) — The maximum number of pools to return. If unspecified, at most 50 pools are returned. The maximum value is 1000; values above are 1000 truncated to 1000.
  • page_token (::String) — A page token, received from a previous ListWorkloadIdentityPools call. Provide this to retrieve the subsequent page.
  • show_deleted (::Boolean) — Whether to return soft-deleted pools.
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/iam/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Iam::V1beta::WorkloadIdentityPools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1beta::ListWorkloadIdentityPoolsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Iam::V1beta::WorkloadIdentityPool.
  p response
end

#operations_client

def operations_client() -> ::Google::Iam::V1beta::WorkloadIdentityPools::Operations

Get the associated client for long-running operations.

Returns

#undelete_workload_identity_pool

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

Undeletes a WorkloadIdentityPool, as long as it was deleted fewer than 30 days ago.

Overloads 
def undelete_workload_identity_pool(request, options = nil) -> ::Gapic::Operation
Pass arguments to undelete_workload_identity_pool via a request object, either of type UndeleteWorkloadIdentityPoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1beta::UndeleteWorkloadIdentityPoolRequest, ::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 undelete_workload_identity_pool(name: nil) -> ::Gapic::Operation
Pass arguments to undelete_workload_identity_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the pool to undelete.
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/iam/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Iam::V1beta::WorkloadIdentityPools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1beta::UndeleteWorkloadIdentityPoolRequest.new

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

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

#undelete_workload_identity_pool_provider

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

Undeletes a [WorkloadIdentityPoolProvider][google.iam.v1beta.WorkloadIdentityProvider], as long as it was deleted fewer than 30 days ago.

Overloads 
def undelete_workload_identity_pool_provider(request, options = nil) -> ::Gapic::Operation
Pass arguments to undelete_workload_identity_pool_provider via a request object, either of type UndeleteWorkloadIdentityPoolProviderRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1beta::UndeleteWorkloadIdentityPoolProviderRequest, ::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 undelete_workload_identity_pool_provider(name: nil) -> ::Gapic::Operation
Pass arguments to undelete_workload_identity_pool_provider via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the provider to undelete.
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/iam/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Iam::V1beta::WorkloadIdentityPools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1beta::UndeleteWorkloadIdentityPoolProviderRequest.new

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

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

#update_workload_identity_pool

def update_workload_identity_pool(request, options = nil) -> ::Gapic::Operation
def update_workload_identity_pool(workload_identity_pool: nil, update_mask: nil) -> ::Gapic::Operation

Updates an existing WorkloadIdentityPool.

Overloads 
def update_workload_identity_pool(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_workload_identity_pool via a request object, either of type UpdateWorkloadIdentityPoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1beta::UpdateWorkloadIdentityPoolRequest, ::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_workload_identity_pool(workload_identity_pool: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to update_workload_identity_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/iam/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Iam::V1beta::WorkloadIdentityPools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1beta::UpdateWorkloadIdentityPoolRequest.new

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

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

#update_workload_identity_pool_provider

def update_workload_identity_pool_provider(request, options = nil) -> ::Gapic::Operation
def update_workload_identity_pool_provider(workload_identity_pool_provider: nil, update_mask: nil) -> ::Gapic::Operation

Updates an existing [WorkloadIdentityPoolProvider][google.iam.v1beta.WorkloadIdentityProvider].

Overloads 
def update_workload_identity_pool_provider(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_workload_identity_pool_provider via a request object, either of type UpdateWorkloadIdentityPoolProviderRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1beta::UpdateWorkloadIdentityPoolProviderRequest, ::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_workload_identity_pool_provider(workload_identity_pool_provider: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to update_workload_identity_pool_provider via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/iam/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Iam::V1beta::WorkloadIdentityPools::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1beta::UpdateWorkloadIdentityPoolProviderRequest.new

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

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