Class IdentityAwareProxyAdminServiceClient (2.32.0)

APIs for Identity-Aware Proxy Admin configurations.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

IdentityAwareProxyAdminServiceClient(IdentityAwareProxyAdminServiceClient const &)

Copy and move support

Parameter
Name	Description
	`IdentityAwareProxyAdminServiceClient const &`

IdentityAwareProxyAdminServiceClient(IdentityAwareProxyAdminServiceClient &&)

Copy and move support

Parameter
Name	Description
	`IdentityAwareProxyAdminServiceClient &&`

IdentityAwareProxyAdminServiceClient(std::shared_ptr< IdentityAwareProxyAdminServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< IdentityAwareProxyAdminServiceConnection >`
`opts`	`Options`

Operators

operator=(IdentityAwareProxyAdminServiceClient const &)

Copy and move support

Parameter
Name	Description
	`IdentityAwareProxyAdminServiceClient const &`

Returns
Type	Description
`IdentityAwareProxyAdminServiceClient &`

operator=(IdentityAwareProxyAdminServiceClient &&)

Copy and move support

Parameter
Name	Description
	`IdentityAwareProxyAdminServiceClient &&`

Returns
Type	Description
`IdentityAwareProxyAdminServiceClient &`

Functions

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

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

Parameters
Name	Description
`request`	`google::iam::v1::SetIamPolicyRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)

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

Parameters
Name	Description
`request`	`google::iam::v1::GetIamPolicyRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)

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

Parameters
Name	Description
`request`	`google::iam::v1::TestIamPermissionsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.TestIamPermissionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::TestIamPermissionsResponse >`	the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetIapSettings(google::cloud::iap::v1::GetIapSettingsRequest const &, Options)

Gets the IAP settings on a particular IAP protected resource.

Parameters
Name	Description
`request`	`google::cloud::iap::v1::GetIapSettingsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.iap.v1.GetIapSettingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::iap::v1::IapSettings >`	the result of the RPC. The response message type (google.cloud.iap.v1.IapSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateIapSettings(google::cloud::iap::v1::UpdateIapSettingsRequest const &, Options)

Updates the IAP settings on a particular IAP protected resource.

It replaces all fields unless the update_mask is set.

Parameters
Name	Description
`request`	`google::cloud::iap::v1::UpdateIapSettingsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.iap.v1.UpdateIapSettingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::iap::v1::IapSettings >`	the result of the RPC. The response message type (google.cloud.iap.v1.IapSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListTunnelDestGroups(std::string const &, Options)

Lists the existing TunnelDestGroups.

To group across all locations, use a - as the location ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups

Parameters
Name	Description
`parent`	`std::string const &` Required. Google Cloud Project ID and location. In the following format: `projects/{project_number/id}/iap_tunnel/locations/{location}`. A `-` can be used for the location to group across all locations.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::iap::v1::TunnelDestGroup >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.iap.v1.TunnelDestGroup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTunnelDestGroups(google::cloud::iap::v1::ListTunnelDestGroupsRequest, Options)

Lists the existing TunnelDestGroups.

To group across all locations, use a - as the location ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups

Parameters
Name	Description
`request`	`google::cloud::iap::v1::ListTunnelDestGroupsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.iap.v1.ListTunnelDestGroupsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::iap::v1::TunnelDestGroup >

CreateTunnelDestGroup(std::string const &, google::cloud::iap::v1::TunnelDestGroup const &, std::string const &, Options)

Creates a new TunnelDestGroup.

Parameters
Name	Description
`parent`	`std::string const &` Required. Google Cloud Project ID and location. In the following format: `projects/{project_number/id}/iap_tunnel/locations/{location}`.
`tunnel_dest_group`	`google::cloud::iap::v1::TunnelDestGroup const &` Required. The TunnelDestGroup to create.
`tunnel_dest_group_id`	`std::string const &` Required. The ID to use for the TunnelDestGroup, which becomes the final component of the resource name. This value must be 4-63 characters, and valid characters are `[a-z]-`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::iap::v1::TunnelDestGroup >`	the result of the RPC. The response message type (google.cloud.iap.v1.TunnelDestGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateTunnelDestGroup(google::cloud::iap::v1::CreateTunnelDestGroupRequest const &, Options)

Creates a new TunnelDestGroup.

Parameters
Name	Description
`request`	`google::cloud::iap::v1::CreateTunnelDestGroupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.iap.v1.CreateTunnelDestGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::iap::v1::TunnelDestGroup >`	the result of the RPC. The response message type (google.cloud.iap.v1.TunnelDestGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetTunnelDestGroup(std::string const &, Options)

Retrieves an existing TunnelDestGroup.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the TunnelDestGroup to be fetched. In the following format: `projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::iap::v1::TunnelDestGroup >`	the result of the RPC. The response message type (google.cloud.iap.v1.TunnelDestGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetTunnelDestGroup(google::cloud::iap::v1::GetTunnelDestGroupRequest const &, Options)

Retrieves an existing TunnelDestGroup.

Parameters
Name	Description
`request`	`google::cloud::iap::v1::GetTunnelDestGroupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.iap.v1.GetTunnelDestGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::iap::v1::TunnelDestGroup >`	the result of the RPC. The response message type (google.cloud.iap.v1.TunnelDestGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteTunnelDestGroup(std::string const &, Options)

Deletes a TunnelDestGroup.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the TunnelDestGroup to delete. In the following format: `projects/{project_number/id}/iap_tunnel/locations/{location}/destGroups/{dest_group}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteTunnelDestGroup(google::cloud::iap::v1::DeleteTunnelDestGroupRequest const &, Options)

Deletes a TunnelDestGroup.

Parameters
Name	Description
`request`	`google::cloud::iap::v1::DeleteTunnelDestGroupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.iap.v1.DeleteTunnelDestGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

UpdateTunnelDestGroup(google::cloud::iap::v1::TunnelDestGroup const &, google::protobuf::FieldMask const &, Options)

Updates a TunnelDestGroup.

Parameters
Name	Description
`tunnel_dest_group`	`google::cloud::iap::v1::TunnelDestGroup const &` Required. The new values for the TunnelDestGroup.
`update_mask`	`google::protobuf::FieldMask const &` A field mask that specifies which IAP settings to update. If omitted, then all of the settings are updated. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::iap::v1::TunnelDestGroup >`	the result of the RPC. The response message type (google.cloud.iap.v1.TunnelDestGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTunnelDestGroup(google::cloud::iap::v1::UpdateTunnelDestGroupRequest const &, Options)

Updates a TunnelDestGroup.

Parameters
Name	Description
`request`	`google::cloud::iap::v1::UpdateTunnelDestGroupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.iap.v1.UpdateTunnelDestGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::iap::v1::TunnelDestGroup >`	the result of the RPC. The response message type (google.cloud.iap.v1.TunnelDestGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.