Access Context Manager API - Module Google::Identity::AccessContextManager (v1.5.0)

Reference documentation and code samples for the Access Context Manager API module Google::Identity::AccessContextManager.

Methods

.access_context_manager

def self.access_context_manager(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for AccessContextManager.

By default, this returns an instance of Google::Identity::AccessContextManager::V1::AccessContextManager::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the AccessContextManager service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the AccessContextManager service. You can determine whether the method will succeed by calling AccessContextManager.access_context_manager_available?.

About AccessContextManager

API for setting [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] and [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter] for Google Cloud projects. Each organization has one [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] that contains the [access levels] [google.identity.accesscontextmanager.v1.AccessLevel] and [service perimeters] [google.identity.accesscontextmanager.v1.ServicePerimeter]. This [access policy] [google.identity.accesscontextmanager.v1.AccessPolicy] is applicable to all resources in the organization. AccessPolicies

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.access_context_manager_available?

def self.access_context_manager_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the AccessContextManager service is supported by the current client. If true, you can retrieve a client object by calling AccessContextManager.access_context_manager. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the AccessContextManager service, or if the versioned client gem needs an update to support the AccessContextManager service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "1.5.0"