Class: Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/policy_troubleshooter/v1/iam_checker/client.rb

Overview

Client for the IamChecker service.

IAM Policy Troubleshooter service.

This service helps you troubleshoot access issues for Google Cloud resources.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new IamChecker client object.

Examples

To create a new IamChecker client with the default configuration:

client = ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.new

To create a new IamChecker client with a custom configuration:

client = ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the IamChecker client.

Yield Parameters:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/google/cloud/policy_troubleshooter/v1/iam_checker/client.rb', line 121

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/cloud/policytroubleshooter/v1/checker_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 scope and endpoint are unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.scope == Client.configure.scope &&
                           @config.endpoint == Client.configure.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

  @iam_checker_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Class Method Details

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

Configure the IamChecker Client class.

See Configuration for a description of the configuration fields.

Example

To modify the configuration for all IamChecker clients:

::Google::Cloud::PolicyTroubleshooter::V1::IamChecker::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/cloud/policy_troubleshooter/v1/iam_checker/client.rb', line 57

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "PolicyTroubleshooter", "V1"]
    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.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.troubleshoot_iam_policy.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

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



96
97
98
99
 
# File 'lib/google/cloud/policy_troubleshooter/v1/iam_checker/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#troubleshoot_iam_policy(request, options = nil) ⇒ ::Google::Cloud::PolicyTroubleshooter::V1::TroubleshootIamPolicyResponse #troubleshoot_iam_policy(access_tuple: nil) ⇒ ::Google::Cloud::PolicyTroubleshooter::V1::TroubleshootIamPolicyResponse

Checks whether a member has a specific permission for a specific resource, and explains why the member does or does not have that permission.

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/google/cloud/policy_troubleshooter/v1/iam_checker/client.rb', line 191

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PolicyTroubleshooter::V1::TroubleshootIamPolicyRequest

  # 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.troubleshoot_iam_policy.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::Cloud::PolicyTroubleshooter::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

  @iam_checker_stub.call_rpc :troubleshoot_iam_policy, 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