Class: Google::Iam::V3beta::PolicyBindings::Client

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

Overview

Client for the PolicyBindings service.

An interface for managing Identity and Access Management (IAM) policy bindings.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#folder_location_path, #location_path, #organization_location_path, #policy_binding_path

Constructor Details

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

Create a new PolicyBindings client object.

Examples:


# Create a client using the default configuration
client = ::Google::Iam::V3beta::PolicyBindings::Client.new

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

Yields:

  • (config) —

    Configure the PolicyBindings client.

Yield Parameters:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
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
210
 
# File 'lib/google/iam/v3beta/policy_bindings/client.rb', line 146

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/v3beta/policy_bindings_service_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

  @policy_bindings_stub = ::Gapic::ServiceStub.new(
    ::Google::Iam::V3beta::PolicyBindings::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
  )

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

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @policy_bindings_stub.endpoint
    config.universe_domain = @policy_bindings_stub.universe_domain
    config.logger = @policy_bindings_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

Get the associated client for mix-in of the Locations.

Returns:

  • (Google::Cloud::Location::Locations::Client) 


224
225
226
 
# File 'lib/google/iam/v3beta/policy_bindings/client.rb', line 224

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Iam::V3beta::PolicyBindings::Operations (readonly)

Get the associated client for long-running operations.

Returns:



217
218
219
 
# File 'lib/google/iam/v3beta/policy_bindings/client.rb', line 217

def operations_client
  @operations_client
end

Class Method Details

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

Configure the PolicyBindings Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
 
# File 'lib/google/iam/v3beta/policy_bindings/client.rb', line 63

def self.configure
  @configure ||= begin
    namespace = ["Google", "Iam", "V3beta"]
    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.create_policy_binding.timeout = 30.0

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

    default_config.rpcs.update_policy_binding.timeout = 30.0

    default_config.rpcs.delete_policy_binding.timeout = 30.0

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

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

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the PolicyBindings 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:



116
117
118
119
 
# File 'lib/google/iam/v3beta/policy_bindings/client.rb', line 116

def configure
  yield @config if block_given?
  @config
end

#create_policy_binding(request, options = nil) ⇒ ::Gapic::Operation #create_policy_binding(parent: nil, policy_binding_id: nil, policy_binding: nil, validate_only: nil) ⇒ ::Gapic::Operation

Creates a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. Once the binding is created, the policy is applied to the target.

Examples:

Basic example

require "google/iam/v3beta"

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

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

# Call the create_policy_binding method.
result = client.create_policy_binding 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_policy_binding(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Iam::V3beta::CreatePolicyBindingRequest, ::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_policy_binding(parent: nil, policy_binding_id: nil, policy_binding: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_policy_binding 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 where this policy binding will be created. The binding parent is the closest Resource Manager resource (project, folder or organization) to the binding target.

      Format:

      • projects/{project_id}/locations/{location}
      • projects/{project_number}/locations/{location}
      • folders/{folder_id}/locations/{location}
      • organizations/{organization_id}/locations/{location}
    • policy_binding_id (::String) (defaults to: nil) —

      Required. The ID to use for the policy binding, which will become the final component of the policy binding's resource name.

      This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /[a-z][a-z0-9-.]{2,62}/.

    • policy_binding (::Google::Iam::V3beta::PolicyBinding, ::Hash) (defaults to: nil) —

      Required. The policy binding to create.

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

      Optional. If set, validate the request and preview the creation, but do not actually post it.

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.



311
312
313
314
315
316
317
318
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
 
# File 'lib/google/iam/v3beta/policy_bindings/client.rb', line 311

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V3beta::CreatePolicyBindingRequest

  # 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_policy_binding.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::V3beta::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_policy_binding.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_policy_binding.retry_policy

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

  @policy_bindings_stub.call_rpc :create_policy_binding, 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_policy_binding(request, options = nil) ⇒ ::Gapic::Operation #delete_policy_binding(name: nil, etag: nil, validate_only: nil) ⇒ ::Gapic::Operation

Deletes a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. Once the binding is deleted, the policy no longer applies to the target.

Examples:

Basic example

require "google/iam/v3beta"

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

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

# Call the delete_policy_binding method.
result = client.delete_policy_binding 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_policy_binding(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Iam::V3beta::DeletePolicyBindingRequest, ::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_policy_binding(name: nil, etag: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_policy_binding 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 policy binding to delete.

      Format:

      • projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}
      • projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}
      • folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}
      • organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}
    • etag (::String) (defaults to: nil) —

      Optional. The etag of the policy binding. If this is provided, it must match the server's etag.

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

      Optional. If set, validate the request and preview the deletion, but do not actually post it.

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.



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
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/google/iam/v3beta/policy_bindings/client.rb', line 618

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V3beta::DeletePolicyBindingRequest

  # 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_policy_binding.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::V3beta::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_policy_binding.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_policy_binding.retry_policy

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

  @policy_bindings_stub.call_rpc :delete_policy_binding, 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_policy_binding(request, options = nil) ⇒ ::Google::Iam::V3beta::PolicyBinding #get_policy_binding(name: nil) ⇒ ::Google::Iam::V3beta::PolicyBinding

Gets a policy binding.

Examples:

Basic example

require "google/iam/v3beta"

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

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

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

# The returned object is of type Google::Iam::V3beta::PolicyBinding.
p result

Overloads:

  • #get_policy_binding(request, options = nil) ⇒ ::Google::Iam::V3beta::PolicyBinding

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

    Parameters:

    • request (::Google::Iam::V3beta::GetPolicyBindingRequest, ::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_policy_binding(name: nil) ⇒ ::Google::Iam::V3beta::PolicyBinding

    Pass arguments to get_policy_binding 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 policy binding to retrieve.

      Format:

      • projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}
      • projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}
      • folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}
      • organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



405
406
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
 
# File 'lib/google/iam/v3beta/policy_bindings/client.rb', line 405

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V3beta::GetPolicyBindingRequest

  # 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_policy_binding.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::V3beta::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_policy_binding.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_policy_binding.retry_policy

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

  @policy_bindings_stub.call_rpc :get_policy_binding, 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_policy_bindings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V3beta::PolicyBinding> #list_policy_bindings(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V3beta::PolicyBinding>

Lists policy bindings.

Examples:

Basic example

require "google/iam/v3beta"

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

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

# Call the list_policy_bindings method.
result = client.list_policy_bindings 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::V3beta::PolicyBinding.
  p item
end

Overloads:

  • #list_policy_bindings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V3beta::PolicyBinding>

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

    Parameters:

    • request (::Google::Iam::V3beta::ListPolicyBindingsRequest, ::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_policy_bindings(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V3beta::PolicyBinding>

    Pass arguments to list_policy_bindings 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, which owns the collection of policy bindings.

      Format:

      • projects/{project_id}/locations/{location}
      • projects/{project_number}/locations/{location}
      • folders/{folder_id}/locations/{location}
      • organizations/{organization_id}/locations/{location}
    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of policy bindings to return. The service may return fewer than this value.

      If unspecified, at most 50 policy bindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

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

      When paginating, all other parameters provided to ListPolicyBindings must match the call that provided the page token.

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

      Optional. An expression for filtering the results of the request. Filter rules are case insensitive. Some eligible fields for filtering are:

      • target
      • policy

      Some examples of filter queries:

      • target:ex*: The binding target's name starts with "ex".
      • target:example: The binding target's name is example.
      • policy:example: The binding policy's name is example.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/google/iam/v3beta/policy_bindings/client.rb', line 741

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V3beta::ListPolicyBindingsRequest

  # 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_policy_bindings.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::V3beta::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_policy_bindings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_policy_bindings.retry_policy

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

  @policy_bindings_stub.call_rpc :list_policy_bindings, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @policy_bindings_stub, :list_policy_bindings, 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) 


231
232
233
 
# File 'lib/google/iam/v3beta/policy_bindings/client.rb', line 231

def logger
  @policy_bindings_stub.logger
end

#search_target_policy_bindings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V3beta::PolicyBinding> #search_target_policy_bindings(target: nil, page_size: nil, page_token: nil, parent: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V3beta::PolicyBinding>

Search policy bindings by target. Returns all policy binding objects bound directly to target.

Examples:

Basic example

require "google/iam/v3beta"

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

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

# Call the search_target_policy_bindings method.
result = client.search_target_policy_bindings 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::V3beta::PolicyBinding.
  p item
end

Overloads:

  • #search_target_policy_bindings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V3beta::PolicyBinding>

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

    Parameters:

    • request (::Google::Iam::V3beta::SearchTargetPolicyBindingsRequest, ::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.

  • #search_target_policy_bindings(target: nil, page_size: nil, page_token: nil, parent: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V3beta::PolicyBinding>

    Pass arguments to search_target_policy_bindings 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:

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

      Required. The target resource, which is bound to the policy in the binding.

      Format:

      • //iam.googleapis.com/locations/global/workforcePools/POOL_ID
      • //iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID
      • //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID
      • //cloudresourcemanager.googleapis.com/projects/{project_number}
      • //cloudresourcemanager.googleapis.com/folders/{folder_id}
      • //cloudresourcemanager.googleapis.com/organizations/{organization_id}
    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of policy bindings to return. The service may return fewer than this value.

      If unspecified, at most 50 policy bindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

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

      When paginating, all other parameters provided to SearchTargetPolicyBindingsRequest must match the call that provided the page token.

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

      Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.

      Format:

      • projects/{project_id}/locations/{location}
      • projects/{project_number}/locations/{location}
      • folders/{folder_id}/locations/{location}
      • organizations/{organization_id}/locations/{location}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

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
908
 
# File 'lib/google/iam/v3beta/policy_bindings/client.rb', line 867

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V3beta::SearchTargetPolicyBindingsRequest

  # 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.search_target_policy_bindings.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::V3beta::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.search_target_policy_bindings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_target_policy_bindings.retry_policy

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

  @policy_bindings_stub.call_rpc :search_target_policy_bindings, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @policy_bindings_stub, :search_target_policy_bindings, 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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


126
127
128
 
# File 'lib/google/iam/v3beta/policy_bindings/client.rb', line 126

def universe_domain
  @policy_bindings_stub.universe_domain
end

#update_policy_binding(request, options = nil) ⇒ ::Gapic::Operation #update_policy_binding(policy_binding: nil, validate_only: nil, update_mask: nil) ⇒ ::Gapic::Operation

Updates a policy binding and returns a long-running operation. Callers will need the IAM permissions on the policy and target in the binding to update, and the IAM permission to remove the existing policy from the binding. Target is immutable and cannot be updated. Once the binding is updated, the new policy is applied to the target.

Examples:

Basic example

require "google/iam/v3beta"

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

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

# Call the update_policy_binding method.
result = client.update_policy_binding 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_policy_binding(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Iam::V3beta::UpdatePolicyBindingRequest, ::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_policy_binding(policy_binding: nil, validate_only: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_policy_binding 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:

    • policy_binding (::Google::Iam::V3beta::PolicyBinding, ::Hash) (defaults to: nil) —

      Required. The policy binding to update.

      The policy binding's name field is used to identify the policy binding to update.

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

      Optional. If set, validate the request and preview the update, but do not actually post it.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. The list of fields to update

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.



509
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
 
# File 'lib/google/iam/v3beta/policy_bindings/client.rb', line 509

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V3beta::UpdatePolicyBindingRequest

  # 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_policy_binding.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::V3beta::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.policy_binding&.name
    header_params["policy_binding.name"] = request.policy_binding.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_policy_binding.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_policy_binding.retry_policy

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

  @policy_bindings_stub.call_rpc :update_policy_binding, 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