Class: Google::Iam::V3beta::PrincipalAccessBoundaryPolicies::Client

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

Overview

Client for the PrincipalAccessBoundaryPolicies service.

Manages Identity and Access Management (IAM) principal access boundary policies.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#organization_location_path, #principal_access_boundary_policy_path

Constructor Details

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

Create a new PrincipalAccessBoundaryPolicies client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the PrincipalAccessBoundaryPolicies 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/principal_access_boundary_policies/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/principal_access_boundary_policies_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

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

  @principal_access_boundary_policies_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 = @principal_access_boundary_policies_stub.endpoint
    config.universe_domain = @principal_access_boundary_policies_stub.universe_domain
    config.logger = @principal_access_boundary_policies_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/principal_access_boundary_policies/client.rb', line 224

def location_client
  @location_client
end

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

Get the associated client for long-running operations.

Returns:



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

def operations_client
  @operations_client
end

Class Method Details

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

Configure the PrincipalAccessBoundaryPolicies Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all PrincipalAccessBoundaryPolicies clients
::Google::Iam::V3beta::PrincipalAccessBoundaryPolicies::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/principal_access_boundary_policies/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_principal_access_boundary_policy.timeout = 30.0

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

    default_config.rpcs.update_principal_access_boundary_policy.timeout = 30.0

    default_config.rpcs.delete_principal_access_boundary_policy.timeout = 30.0

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

    default_config.rpcs.search_principal_access_boundary_policy_bindings.timeout = 60.0
    default_config.rpcs.search_principal_access_boundary_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 PrincipalAccessBoundaryPolicies 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/principal_access_boundary_policies/client.rb', line 116

def configure
  yield @config if block_given?
  @config
end

#create_principal_access_boundary_policy(request, options = nil) ⇒ ::Gapic::Operation #create_principal_access_boundary_policy(parent: nil, principal_access_boundary_policy_id: nil, principal_access_boundary_policy: nil, validate_only: nil) ⇒ ::Gapic::Operation

Creates a principal access boundary policy, and returns a long running operation.

Examples:

Basic example

require "google/iam/v3beta"

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

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

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

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

    Parameters:

    • request (::Google::Iam::V3beta::CreatePrincipalAccessBoundaryPolicyRequest, ::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_principal_access_boundary_policy(parent: nil, principal_access_boundary_policy_id: nil, principal_access_boundary_policy: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_principal_access_boundary_policy 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 principal access boundary policy will be created. Only organizations are supported.

      Format: organizations/{organization_id}/locations/{location}

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

      Required. The ID to use for the principal access boundary policy, which will become the final component of the principal access boundary policy'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}/.

    • principal_access_boundary_policy (::Google::Iam::V3beta::PrincipalAccessBoundaryPolicy, ::Hash) (defaults to: nil) —

      Required. The principal access boundary policy 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.



306
307
308
309
310
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
 
# File 'lib/google/iam/v3beta/principal_access_boundary_policies/client.rb', line 306

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

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

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

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

  @principal_access_boundary_policies_stub.call_rpc :create_principal_access_boundary_policy, 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_principal_access_boundary_policy(request, options = nil) ⇒ ::Gapic::Operation #delete_principal_access_boundary_policy(name: nil, etag: nil, validate_only: nil, force: nil) ⇒ ::Gapic::Operation

Deletes a principal access boundary policy.

Examples:

Basic example

require "google/iam/v3beta"

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

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

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

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

    Parameters:

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

    Pass arguments to delete_principal_access_boundary_policy 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 principal access boundary policy to delete.

      Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}

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

      Optional. The etag of the principal access boundary policy. 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.

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

      Optional. If set to true, the request will force the deletion of the policy even if the policy is referenced in policy bindings.

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.



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
 
# File 'lib/google/iam/v3beta/principal_access_boundary_policies/client.rb', line 602

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

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

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

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

  @principal_access_boundary_policies_stub.call_rpc :delete_principal_access_boundary_policy, 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_principal_access_boundary_policy(request, options = nil) ⇒ ::Google::Iam::V3beta::PrincipalAccessBoundaryPolicy #get_principal_access_boundary_policy(name: nil) ⇒ ::Google::Iam::V3beta::PrincipalAccessBoundaryPolicy

Gets a principal access boundary policy.

Examples:

Basic example

require "google/iam/v3beta"

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

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

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

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

Overloads:

  • #get_principal_access_boundary_policy(request, options = nil) ⇒ ::Google::Iam::V3beta::PrincipalAccessBoundaryPolicy

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

    Parameters:

    • request (::Google::Iam::V3beta::GetPrincipalAccessBoundaryPolicyRequest, ::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_principal_access_boundary_policy(name: nil) ⇒ ::Google::Iam::V3beta::PrincipalAccessBoundaryPolicy

    Pass arguments to get_principal_access_boundary_policy 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 principal access boundary policy to retrieve.

      Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



396
397
398
399
400
401
402
403
404
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
 
# File 'lib/google/iam/v3beta/principal_access_boundary_policies/client.rb', line 396

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

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

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

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

  @principal_access_boundary_policies_stub.call_rpc :get_principal_access_boundary_policy, 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_principal_access_boundary_policies(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V3beta::PrincipalAccessBoundaryPolicy> #list_principal_access_boundary_policies(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V3beta::PrincipalAccessBoundaryPolicy>

Lists principal access boundary policies.

Examples:

Basic example

require "google/iam/v3beta"

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Iam::V3beta::ListPrincipalAccessBoundaryPoliciesRequest, ::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_principal_access_boundary_policies(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V3beta::PrincipalAccessBoundaryPolicy>

    Pass arguments to list_principal_access_boundary_policies 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 principal access boundary policies.

      Format: organizations/{organization_id}/locations/{location}

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

      Optional. The maximum number of principal access boundary policies to return. The service may return fewer than this value.

      If unspecified, at most 50 principal access boundary policies 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 ListPrincipalAccessBoundaryPolicies call. Provide this to retrieve the subsequent page.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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

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

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

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

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

  @principal_access_boundary_policies_stub.call_rpc :list_principal_access_boundary_policies, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @principal_access_boundary_policies_stub, :list_principal_access_boundary_policies, 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/principal_access_boundary_policies/client.rb', line 231

def logger
  @principal_access_boundary_policies_stub.logger
end

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

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.

Examples:

Basic example

require "google/iam/v3beta"

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

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

# Call the search_principal_access_boundary_policy_bindings method.
result = client.search_principal_access_boundary_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_principal_access_boundary_policy_bindings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V3beta::PolicyBinding>

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

    Parameters:

    • request (::Google::Iam::V3beta::SearchPrincipalAccessBoundaryPolicyBindingsRequest, ::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_principal_access_boundary_policy_bindings(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Iam::V3beta::PolicyBinding>

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

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

      Required. The name of the principal access boundary policy. Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_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 SearchPrincipalAccessBoundaryPolicyBindingsRequest call. Provide this to retrieve the subsequent page.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
 
# File 'lib/google/iam/v3beta/principal_access_boundary_policies/client.rb', line 820

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

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

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

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

  @principal_access_boundary_policies_stub.call_rpc :search_principal_access_boundary_policy_bindings, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @principal_access_boundary_policies_stub, :search_principal_access_boundary_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/principal_access_boundary_policies/client.rb', line 126

def universe_domain
  @principal_access_boundary_policies_stub.universe_domain
end

#update_principal_access_boundary_policy(request, options = nil) ⇒ ::Gapic::Operation #update_principal_access_boundary_policy(principal_access_boundary_policy: nil, validate_only: nil, update_mask: nil) ⇒ ::Gapic::Operation

Updates a principal access boundary policy.

Examples:

Basic example

require "google/iam/v3beta"

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

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

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

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

    Parameters:

    • request (::Google::Iam::V3beta::UpdatePrincipalAccessBoundaryPolicyRequest, ::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_principal_access_boundary_policy(principal_access_boundary_policy: nil, validate_only: nil, update_mask: nil) ⇒ ::Gapic::Operation

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

    • principal_access_boundary_policy (::Google::Iam::V3beta::PrincipalAccessBoundaryPolicy, ::Hash) (defaults to: nil) —

      Required. The principal access boundary policy to update.

      The principal access boundary policy's name field is used to identify the policy 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.



496
497
498
499
500
501
502
503
504
505
506
507
508
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
 
# File 'lib/google/iam/v3beta/principal_access_boundary_policies/client.rb', line 496

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

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

  # 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_principal_access_boundary_policy.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.principal_access_boundary_policy&.name
    header_params["principal_access_boundary_policy.name"] = request.principal_access_boundary_policy.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_principal_access_boundary_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_principal_access_boundary_policy.retry_policy

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

  @principal_access_boundary_policies_stub.call_rpc :update_principal_access_boundary_policy, 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