Class AuthProviderServiceClient (3.8.0-rc)

Service describing handlers for resources.

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

AuthProviderServiceClient(AuthProviderServiceClient const &)

Copy and move support

Parameter
Name Description
AuthProviderServiceClient const &

AuthProviderServiceClient(AuthProviderServiceClient &&)

Copy and move support

Parameter
Name Description
AuthProviderServiceClient &&

AuthProviderServiceClient(std::shared_ptr< AuthProviderServiceConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< AuthProviderServiceConnection >
opts Options

Operators

operator=(AuthProviderServiceClient const &)

Copy and move support

Parameter
Name Description
AuthProviderServiceClient const &
Returns
Type Description
AuthProviderServiceClient &

operator=(AuthProviderServiceClient &&)

Copy and move support

Parameter
Name Description
AuthProviderServiceClient &&
Returns
Type Description
AuthProviderServiceClient &

Functions

ListAuthProviders(std::string const &, Options)

Lists AuthProviders in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::agentidentity::v1::AuthProvider >

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.agentidentity.v1.AuthProvider, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAuthProviders(google::cloud::agentidentity::v1::ListAuthProvidersRequest, Options)

Lists AuthProviders in a given project and location.

Parameters
Name Description
request google::cloud::agentidentity::v1::ListAuthProvidersRequest

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.agentidentity.v1.ListAuthProvidersRequest. 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::agentidentity::v1::AuthProvider >

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.agentidentity.v1.AuthProvider, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetAuthProvider(std::string const &, Options)

Gets details of a single AuthProvider.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::agentidentity::v1::AuthProvider >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.AuthProvider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAuthProvider(google::cloud::agentidentity::v1::GetAuthProviderRequest const &, Options)

Gets details of a single AuthProvider.

Parameters
Name Description
request google::cloud::agentidentity::v1::GetAuthProviderRequest 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.agentidentity.v1.GetAuthProviderRequest. 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::agentidentity::v1::AuthProvider >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.AuthProvider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateAuthProvider(std::string const &, google::cloud::agentidentity::v1::AuthProvider const &, std::string const &, Options)

Creates a new AuthProvider in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource where the AuthProvider is created. Format: projects/{project}/locations/{location}

auth_provider google::cloud::agentidentity::v1::AuthProvider const &

Required. The AuthProvider to create.

auth_provider_id std::string const &

Required. The ID to use for the AuthProvider, which will become the final segment of the AuthProvider's resource name. This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::agentidentity::v1::AuthProvider >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.AuthProvider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateAuthProvider(google::cloud::agentidentity::v1::CreateAuthProviderRequest const &, Options)

Creates a new AuthProvider in a given project and location.

Parameters
Name Description
request google::cloud::agentidentity::v1::CreateAuthProviderRequest 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.agentidentity.v1.CreateAuthProviderRequest. 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::agentidentity::v1::AuthProvider >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.AuthProvider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateAuthProvider(google::cloud::agentidentity::v1::AuthProvider const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single AuthProvider.

Parameters
Name Description
auth_provider google::cloud::agentidentity::v1::AuthProvider const &

Required. The AuthProvider resource which replaces the resource on the server.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the AuthProvider resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::agentidentity::v1::AuthProvider >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.AuthProvider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateAuthProvider(google::cloud::agentidentity::v1::UpdateAuthProviderRequest const &, Options)

Updates the parameters of a single AuthProvider.

Parameters
Name Description
request google::cloud::agentidentity::v1::UpdateAuthProviderRequest 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.agentidentity.v1.UpdateAuthProviderRequest. 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::agentidentity::v1::AuthProvider >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.AuthProvider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteAuthProvider(std::string const &, Options)

Deletes a single AuthProvider.

Parameters
Name Description
name std::string const &

Required. Name of the resource

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.

DeleteAuthProvider(google::cloud::agentidentity::v1::DeleteAuthProviderRequest const &, Options)

Deletes a single AuthProvider.

Parameters
Name Description
request google::cloud::agentidentity::v1::DeleteAuthProviderRequest 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.agentidentity.v1.DeleteAuthProviderRequest. 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.

UndeleteAuthProvider(std::string const &, Options)

Undeletes a single AuthProvider.

Parameters
Name Description
name std::string const &

Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::agentidentity::v1::AuthProvider >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.AuthProvider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UndeleteAuthProvider(google::cloud::agentidentity::v1::UndeleteAuthProviderRequest const &, Options)

Undeletes a single AuthProvider.

Parameters
Name Description
request google::cloud::agentidentity::v1::UndeleteAuthProviderRequest 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.agentidentity.v1.UndeleteAuthProviderRequest. 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::agentidentity::v1::AuthProvider >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.AuthProvider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

QueryAuthProviders(std::string const &, std::string const &, Options)

Queries what all auth_providers are used by a given workload_id.

Parameters
Name Description
parent std::string const &

Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}

workload_id std::string const &

Required. The workload identifier to filter by.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< std::string >

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 a std::string.

QueryAuthProviders(google::cloud::agentidentity::v1::QueryAuthProvidersRequest, Options)

Queries what all auth_providers are used by a given workload_id.

Parameters
Name Description
request google::cloud::agentidentity::v1::QueryAuthProvidersRequest

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.agentidentity.v1.QueryAuthProvidersRequest. 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< std::string >

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 a std::string.

QueryWorkloads(std::string const &, Options)

Queries what all workloads are using a given auth_provider.

Parameters
Name Description
name std::string const &

Required. The name of the auth_provider to query. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< std::string >

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 a std::string.

QueryWorkloads(google::cloud::agentidentity::v1::QueryWorkloadsRequest, Options)

Queries what all workloads are using a given auth_provider.

Parameters
Name Description
request google::cloud::agentidentity::v1::QueryWorkloadsRequest

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.agentidentity.v1.QueryWorkloadsRequest. 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< std::string >

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 a std::string.

ListAuthorizations(std::string const &, Options)

Lists Authorizations in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::agentidentity::v1::Authorization >

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.agentidentity.v1.Authorization, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAuthorizations(google::cloud::agentidentity::v1::ListAuthorizationsRequest, Options)

Lists Authorizations in a given project and location.

Parameters
Name Description
request google::cloud::agentidentity::v1::ListAuthorizationsRequest

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.agentidentity.v1.ListAuthorizationsRequest. 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::agentidentity::v1::Authorization >

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.agentidentity.v1.Authorization, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetAuthorization(std::string const &, Options)

Gets details of a single Authorization.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::agentidentity::v1::Authorization >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.Authorization) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAuthorization(google::cloud::agentidentity::v1::GetAuthorizationRequest const &, Options)

Gets details of a single Authorization.

Parameters
Name Description
request google::cloud::agentidentity::v1::GetAuthorizationRequest 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.agentidentity.v1.GetAuthorizationRequest. 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::agentidentity::v1::Authorization >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.Authorization) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteAuthorization(std::string const &, Options)

Deletes a single Authorization.

Parameters
Name Description
name std::string const &

Required. The name of the Authorization to delete. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization}

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.

DeleteAuthorization(google::cloud::agentidentity::v1::DeleteAuthorizationRequest const &, Options)

Deletes a single Authorization.

Parameters
Name Description
request google::cloud::agentidentity::v1::DeleteAuthorizationRequest 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.agentidentity.v1.DeleteAuthorizationRequest. 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.

ListAccessSummaries(std::string const &, Options)

Lists AccessSummaries in a given project and location.

Supported Filters:

  • workload_id: Filter by the SPIFFE ID of the agent. Example: workload_id="spiffe://example.com/ns/default/sa/my-agent"
Parameters
Name Description
parent std::string const &

Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::agentidentity::v1::AccessSummary >

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.agentidentity.v1.AccessSummary, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAccessSummaries(google::cloud::agentidentity::v1::ListAccessSummariesRequest, Options)

Lists AccessSummaries in a given project and location.

Supported Filters:

  • workload_id: Filter by the SPIFFE ID of the agent. Example: workload_id="spiffe://example.com/ns/default/sa/my-agent"
Parameters
Name Description
request google::cloud::agentidentity::v1::ListAccessSummariesRequest

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.agentidentity.v1.ListAccessSummariesRequest. 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::agentidentity::v1::AccessSummary >

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.agentidentity.v1.AccessSummary, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetAccessSummary(std::string const &, Options)

Gets details of a single AccessSummary.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::agentidentity::v1::AccessSummary >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.AccessSummary) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAccessSummary(google::cloud::agentidentity::v1::GetAccessSummaryRequest const &, Options)

Gets details of a single AccessSummary.

Parameters
Name Description
request google::cloud::agentidentity::v1::GetAccessSummaryRequest 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.agentidentity.v1.GetAccessSummaryRequest. 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::agentidentity::v1::AccessSummary >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.AccessSummary) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

RevokeAuthorization(std::string const &, std::string const &, Options)

Revokes all authorizations for a specific user on an AuthProvider.

This deletes all authorization records associated with the user and AuthProvider, effectively revoking access across all agents.

Parameters
Name Description
name std::string const &

Required. The resource name of the AuthProvider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}

user_id std::string const &

Required. The identity of the user to revoke authorization for.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::agentidentity::v1::RevokeAuthorizationResponse >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.RevokeAuthorizationResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

RevokeAuthorization(google::cloud::agentidentity::v1::RevokeAuthorizationRequest const &, Options)

Revokes all authorizations for a specific user on an AuthProvider.

This deletes all authorization records associated with the user and AuthProvider, effectively revoking access across all agents.

Parameters
Name Description
request google::cloud::agentidentity::v1::RevokeAuthorizationRequest 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.agentidentity.v1.RevokeAuthorizationRequest. 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::agentidentity::v1::RevokeAuthorizationResponse >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.RevokeAuthorizationResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

EnableAuthProvider(std::string const &, Options)

Enables a single AuthProvider.

Parameters
Name Description
name std::string const &

Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::agentidentity::v1::AuthProvider >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.AuthProvider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

EnableAuthProvider(google::cloud::agentidentity::v1::EnableAuthProviderRequest const &, Options)

Enables a single AuthProvider.

Parameters
Name Description
request google::cloud::agentidentity::v1::EnableAuthProviderRequest 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.agentidentity.v1.EnableAuthProviderRequest. 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::agentidentity::v1::AuthProvider >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.AuthProvider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DisableAuthProvider(std::string const &, Options)

Disables a single AuthProvider.

Parameters
Name Description
name std::string const &

Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::agentidentity::v1::AuthProvider >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.AuthProvider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DisableAuthProvider(google::cloud::agentidentity::v1::DisableAuthProviderRequest const &, Options)

Disables a single AuthProvider.

Parameters
Name Description
request google::cloud::agentidentity::v1::DisableAuthProviderRequest 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.agentidentity.v1.DisableAuthProviderRequest. 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::agentidentity::v1::AuthProvider >

the result of the RPC. The response message type (google.cloud.agentidentity.v1.AuthProvider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

Parameters
Name Description
request google::cloud::location::ListLocationsRequest

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.location.ListLocationsRequest. 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::location::Location >

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.location.Location, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetLocation(google::cloud::location::GetLocationRequest const &, Options)

Gets information about a location.

Parameters
Name Description
request google::cloud::location::GetLocationRequest 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.location.GetLocationRequest. 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::location::Location >

the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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

Sets the access control policy on the specified resource.

Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

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 a resource.

Returns an empty policy if the resource exists and does not have a policy set.

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 specified resource.

If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

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.