Identity-Aware Proxy V1 API - Class Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::Client (v0.2.0)

Reference documentation and code samples for the Identity-Aware Proxy V1 API class Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::Client.

Client for the IdentityAwareProxyAdminService service.

APIs for Identity-Aware Proxy Admin configurations.

Inherits

Object

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the IdentityAwareProxyAdminService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all IdentityAwareProxyAdminService clients
::Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the IdentityAwareProxyAdminService 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#get_iam_policy

def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy

Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Overloads

def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy

Pass arguments to get_iam_policy via a request object, either of type Iam::V1::GetIamPolicyRequest or an equivalent Hash.

Parameters

request (::Google::Iam::V1::GetIamPolicyRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy

Pass arguments to get_iam_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

resource (::String) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options (::Google::Iam::V1::GetPolicyOptions, ::Hash) — OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Iam::V1::Policy)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Iam::V1::Policy)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/iap/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::Client.new

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

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

# The returned object is of type Google::Iam::V1::Policy.
p result

#get_iap_settings

def get_iap_settings(request, options = nil) -> ::Google::Cloud::Iap::V1::IapSettings
def get_iap_settings(name: nil) -> ::Google::Cloud::Iap::V1::IapSettings

Gets the IAP settings on a particular IAP protected resource.

Overloads

def get_iap_settings(request, options = nil) -> ::Google::Cloud::Iap::V1::IapSettings

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

Parameters

request (::Google::Cloud::Iap::V1::GetIapSettingsRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_iap_settings(name: nil) -> ::Google::Cloud::Iap::V1::IapSettings

Pass arguments to get_iap_settings 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).

Parameter

name (::String) — Required. The resource name for which to retrieve the settings. Authorization: Requires the getSettings permission for the associated resource.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Iap::V1::IapSettings)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Iap::V1::IapSettings)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/iap/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Iap::V1::GetIapSettingsRequest.new

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

# The returned object is of type Google::Cloud::Iap::V1::IapSettings.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new IdentityAwareProxyAdminService client object.

Yields

(config) — Configure the IdentityAwareProxyAdminService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::Client.new do |config|
  config.timeout = 10.0
end

#set_iam_policy

def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy

Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Overloads

def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy

Pass arguments to set_iam_policy via a request object, either of type Iam::V1::SetIamPolicyRequest or an equivalent Hash.

Parameters

request (::Google::Iam::V1::SetIamPolicyRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy

Pass arguments to set_iam_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

resource (::String) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy (::Google::Iam::V1::Policy, ::Hash) — REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

paths: "bindings, etag"

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Iam::V1::Policy)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Iam::V1::Policy)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/iap/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::Client.new

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

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

# The returned object is of type Google::Iam::V1::Policy.
p result

#test_iam_permissions

def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api

Overloads

def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

Pass arguments to test_iam_permissions via a request object, either of type Iam::V1::TestIamPermissionsRequest or an equivalent Hash.

Parameters

request (::Google::Iam::V1::TestIamPermissionsRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

Pass arguments to test_iam_permissions 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

resource (::String) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions (::Array<::String>) — The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Iam::V1::TestIamPermissionsResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Iam::V1::TestIamPermissionsResponse)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/iap/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::Client.new

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

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

# The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
p result

#update_iap_settings

def update_iap_settings(request, options = nil) -> ::Google::Cloud::Iap::V1::IapSettings
def update_iap_settings(iap_settings: nil, update_mask: nil) -> ::Google::Cloud::Iap::V1::IapSettings

Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the update_mask is set.

Overloads

def update_iap_settings(request, options = nil) -> ::Google::Cloud::Iap::V1::IapSettings

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

Parameters

request (::Google::Cloud::Iap::V1::UpdateIapSettingsRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_iap_settings(iap_settings: nil, update_mask: nil) -> ::Google::Cloud::Iap::V1::IapSettings

Pass arguments to update_iap_settings 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

iap_settings (::Google::Cloud::Iap::V1::IapSettings, ::Hash) — Required. The new values for the IAP settings to be updated. Authorization: Requires the updateSettings permission for the associated resource.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — The field mask specifying which IAP settings should be updated. If omitted, the all of the settings are updated. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Iap::V1::IapSettings)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Iap::V1::IapSettings)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/iap/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Iap::V1::UpdateIapSettingsRequest.new

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

# The returned object is of type Google::Cloud::Iap::V1::IapSettings.
p result