Class: Google::Iam::V1beta::WorkloadIdentityPools::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/iam/v1beta/workload_identity_pools/client.rb

Overview

Client for the WorkloadIdentityPools service.

Manages WorkloadIdentityPools.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#project_path, #workload_identity_pool_path, #workload_identity_pool_provider_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new WorkloadIdentityPools client object.

Examples:


# 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

Yields:

  • (config) —

    Configure the WorkloadIdentityPools client.

Yield Parameters:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 183

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/iam/v1beta/workload_identity_pool_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @workload_identity_pools_stub = ::Gapic::ServiceStub.new(
    ::Google::Iam::V1beta::WorkloadIdentityPools::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @workload_identity_pools_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Instance Attribute Details

#operations_client ⇒ ::Google::Iam::V1beta::WorkloadIdentityPools::Operations (readonly)

Get the associated client for long-running operations.

Returns:



246
247
248
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 246

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the WorkloadIdentityPools Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all WorkloadIdentityPools clients
::Google::Iam::V1beta::WorkloadIdentityPools::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 61

def self.configure
  @configure ||= begin
    namespace = ["Google", "Iam", "V1beta"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.list_workload_identity_pools.timeout = 60.0
    default_config.rpcs.list_workload_identity_pools.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.get_workload_identity_pool.timeout = 60.0
    default_config.rpcs.get_workload_identity_pool.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.create_workload_identity_pool.timeout = 60.0
    default_config.rpcs.create_workload_identity_pool.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.update_workload_identity_pool.timeout = 60.0
    default_config.rpcs.update_workload_identity_pool.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.delete_workload_identity_pool.timeout = 60.0
    default_config.rpcs.delete_workload_identity_pool.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.undelete_workload_identity_pool.timeout = 60.0
    default_config.rpcs.undelete_workload_identity_pool.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_workload_identity_pool_providers.timeout = 60.0
    default_config.rpcs.list_workload_identity_pool_providers.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.get_workload_identity_pool_provider.timeout = 60.0
    default_config.rpcs.get_workload_identity_pool_provider.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.create_workload_identity_pool_provider.timeout = 60.0
    default_config.rpcs.create_workload_identity_pool_provider.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.update_workload_identity_pool_provider.timeout = 60.0
    default_config.rpcs.update_workload_identity_pool_provider.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.delete_workload_identity_pool_provider.timeout = 60.0
    default_config.rpcs.delete_workload_identity_pool_provider.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.undelete_workload_identity_pool_provider.timeout = 60.0
    default_config.rpcs.undelete_workload_identity_pool_provider.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



153
154
155
156
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 153

def configure
  yield @config if block_given?
  @config
end

#create_workload_identity_pool(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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 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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      Required. The parent resource to create the pool in. The only supported location is global.

    • workload_identity_pool (::Google::Iam::V1beta::WorkloadIdentityPool, ::Hash) (defaults to: nil) —

      Required. The pool to create.

    • workload_identity_pool_id (::String) (defaults to: nil) —

      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.



510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 510

def create_workload_identity_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1beta::CreateWorkloadIdentityPoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_workload_identity_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Iam::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_workload_identity_pool.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_workload_identity_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @workload_identity_pools_stub.call_rpc :create_workload_identity_pool, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_workload_identity_pool_provider(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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 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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      Required. The pool to create this provider in.

    • workload_identity_pool_provider (::Google::Iam::V1beta::WorkloadIdentityPoolProvider, ::Hash) (defaults to: nil) —

      Required. The provider to create.

    • workload_identity_pool_provider_id (::String) (defaults to: nil) —

      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.



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 1103

def create_workload_identity_pool_provider request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1beta::CreateWorkloadIdentityPoolProviderRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_workload_identity_pool_provider.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Iam::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_workload_identity_pool_provider.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_workload_identity_pool_provider.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @workload_identity_pools_stub.call_rpc :create_workload_identity_pool_provider, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_workload_identity_pool(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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 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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

      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.



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 712

def delete_workload_identity_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1beta::DeleteWorkloadIdentityPoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_workload_identity_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Iam::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_workload_identity_pool.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_workload_identity_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @workload_identity_pools_stub.call_rpc :delete_workload_identity_pool, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_workload_identity_pool_provider(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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 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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

      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.



1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 1300

def delete_workload_identity_pool_provider request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1beta::DeleteWorkloadIdentityPoolProviderRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_workload_identity_pool_provider.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Iam::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_workload_identity_pool_provider.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_workload_identity_pool_provider.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @workload_identity_pools_stub.call_rpc :delete_workload_identity_pool_provider, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_workload_identity_pool(request, options = nil) ⇒ ::Google::Iam::V1beta::WorkloadIdentityPool #get_workload_identity_pool(name: nil) ⇒ ::Google::Iam::V1beta::WorkloadIdentityPool

Gets an individual WorkloadIdentityPool.

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

      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.



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 407

def get_workload_identity_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1beta::GetWorkloadIdentityPoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_workload_identity_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Iam::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_workload_identity_pool.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_workload_identity_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @workload_identity_pools_stub.call_rpc :get_workload_identity_pool, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_workload_identity_pool_provider(request, options = nil) ⇒ ::Google::Iam::V1beta::WorkloadIdentityPoolProvider #get_workload_identity_pool_provider(name: nil) ⇒ ::Google::Iam::V1beta::WorkloadIdentityPoolProvider

Gets an individual WorkloadIdentityPoolProvider.

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

      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.



999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 999

def get_workload_identity_pool_provider request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1beta::GetWorkloadIdentityPoolProviderRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_workload_identity_pool_provider.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Iam::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_workload_identity_pool_provider.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_workload_identity_pool_provider.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @workload_identity_pools_stub.call_rpc :get_workload_identity_pool_provider, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_workload_identity_pool_providers(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V1beta::WorkloadIdentityPoolProvider> #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.

Examples:

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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Iam::V1beta::WorkloadIdentityPoolProvider.
  p item
end

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      Required. The pool to list providers for.

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      A page token, received from a previous ListWorkloadIdentityPoolProviders call. Provide this to retrieve the subsequent page.

    • show_deleted (::Boolean) (defaults to: nil) —

      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.



911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 911

def list_workload_identity_pool_providers request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1beta::ListWorkloadIdentityPoolProvidersRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_workload_identity_pool_providers.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Iam::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_workload_identity_pool_providers.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_workload_identity_pool_providers.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @workload_identity_pools_stub.call_rpc :list_workload_identity_pool_providers, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @workload_identity_pools_stub, :list_workload_identity_pool_providers, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_workload_identity_pools(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V1beta::WorkloadIdentityPool> #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.

Examples:

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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Iam::V1beta::WorkloadIdentityPool.
  p item
end

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      Required. The parent resource to list pools for.

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      A page token, received from a previous ListWorkloadIdentityPools call. Provide this to retrieve the subsequent page.

    • show_deleted (::Boolean) (defaults to: nil) —

      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.



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 319

def list_workload_identity_pools request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1beta::ListWorkloadIdentityPoolsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_workload_identity_pools.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Iam::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_workload_identity_pools.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_workload_identity_pools.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @workload_identity_pools_stub.call_rpc :list_workload_identity_pools, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @workload_identity_pools_stub, :list_workload_identity_pools, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


253
254
255
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 253

def logger
  @workload_identity_pools_stub.logger
end

#undelete_workload_identity_pool(request, options = nil) ⇒ ::Gapic::Operation #undelete_workload_identity_pool(name: nil) ⇒ ::Gapic::Operation

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

Examples:

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 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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

      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.



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 807

def undelete_workload_identity_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1beta::UndeleteWorkloadIdentityPoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.undelete_workload_identity_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Iam::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.undelete_workload_identity_pool.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.undelete_workload_identity_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @workload_identity_pools_stub.call_rpc :undelete_workload_identity_pool, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#undelete_workload_identity_pool_provider(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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 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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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).

    Parameters:

    • name (::String) (defaults to: nil) —

      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.



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 1396

def undelete_workload_identity_pool_provider request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1beta::UndeleteWorkloadIdentityPoolProviderRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.undelete_workload_identity_pool_provider.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Iam::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.undelete_workload_identity_pool_provider.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.undelete_workload_identity_pool_provider.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @workload_identity_pools_stub.call_rpc :undelete_workload_identity_pool_provider, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


163
164
165
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 163

def universe_domain
  @workload_identity_pools_stub.universe_domain
end

#update_workload_identity_pool(request, options = nil) ⇒ ::Gapic::Operation #update_workload_identity_pool(workload_identity_pool: nil, update_mask: nil) ⇒ ::Gapic::Operation

Updates an existing WorkloadIdentityPool.

Examples:

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 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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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.



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 607

def update_workload_identity_pool request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1beta::UpdateWorkloadIdentityPoolRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_workload_identity_pool.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Iam::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.workload_identity_pool&.name
    header_params["workload_identity_pool.name"] = request.workload_identity_pool.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_workload_identity_pool.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_workload_identity_pool.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @workload_identity_pools_stub.call_rpc :update_workload_identity_pool, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_workload_identity_pool_provider(request, options = nil) ⇒ ::Gapic::Operation #update_workload_identity_pool_provider(workload_identity_pool_provider: nil, update_mask: nil) ⇒ ::Gapic::Operation

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

Examples:

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 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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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.



1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 1200

def update_workload_identity_pool_provider request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1beta::UpdateWorkloadIdentityPoolProviderRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_workload_identity_pool_provider.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Iam::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.workload_identity_pool_provider&.name
    header_params["workload_identity_pool_provider.name"] = request.workload_identity_pool_provider.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_workload_identity_pool_provider.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_workload_identity_pool_provider.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @workload_identity_pools_stub.call_rpc :update_workload_identity_pool_provider, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end