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:



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
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
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 168

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

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

Instance Attribute Details

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

Get the associated client for long-running operations.



216
217
218
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 216

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:



55
56
57
58
59
60
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
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 55

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:



147
148
149
150
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 147

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.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 470

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 and x-goog-user-project 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-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?
    return 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.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 1058

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 and x-goog-user-project 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-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?
    return 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.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 670

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 and x-goog-user-project 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-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?
    return 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.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 1253

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 and x-goog-user-project 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-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?
    return 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:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 367

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 and x-goog-user-project 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-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?
    return response
  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:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 954

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 and x-goog-user-project 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-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?
    return response
  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.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 867

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 and x-goog-user-project 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-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?
    return 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.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 280

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 and x-goog-user-project 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-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?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
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.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 764

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 and x-goog-user-project 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-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?
    return 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.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 1348

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 and x-goog-user-project 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-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?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
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.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 566

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 and x-goog-user-project 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-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?
    return 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.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/google/iam/v1beta/workload_identity_pools/client.rb', line 1154

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 and x-goog-user-project 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-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?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end