Package com.google.iam.v2 (1.6.23)

A client to Identity and Access Management (IAM) API

The interfaces provided are listed below, along with usage samples.

PoliciesClient

Service Description: An interface for managing Identity and Access Management (IAM) policies.

Sample for PoliciesClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PoliciesClient policiesClient = PoliciesClient.create()) {
   String name = "name3373707";
   Policy response = policiesClient.getPolicy(name);
 }

Classes

CreatePolicyRequest

Request message for CreatePolicy.

Protobuf type google.iam.v2.CreatePolicyRequest

CreatePolicyRequest.Builder

Request message for CreatePolicy.

Protobuf type google.iam.v2.CreatePolicyRequest

DeletePolicyRequest

Request message for DeletePolicy.

Protobuf type google.iam.v2.DeletePolicyRequest

DeletePolicyRequest.Builder

Request message for DeletePolicy.

Protobuf type google.iam.v2.DeletePolicyRequest

DenyRule

A deny rule in an IAM deny policy.

Protobuf type google.iam.v2.DenyRule

DenyRule.Builder

A deny rule in an IAM deny policy.

Protobuf type google.iam.v2.DenyRule

GetPolicyRequest

Request message for GetPolicy.

Protobuf type google.iam.v2.GetPolicyRequest

GetPolicyRequest.Builder

Request message for GetPolicy.

Protobuf type google.iam.v2.GetPolicyRequest

ListPoliciesRequest

Request message for ListPolicies.

Protobuf type google.iam.v2.ListPoliciesRequest

ListPoliciesRequest.Builder

Request message for ListPolicies.

Protobuf type google.iam.v2.ListPoliciesRequest

ListPoliciesResponse

Response message for ListPolicies.

Protobuf type google.iam.v2.ListPoliciesResponse

ListPoliciesResponse.Builder

Response message for ListPolicies.

Protobuf type google.iam.v2.ListPoliciesResponse

PoliciesClient

Service Description: An interface for managing Identity and Access Management (IAM) policies.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PoliciesClient policiesClient = PoliciesClient.create()) {
   String name = "name3373707";
   Policy response = policiesClient.getPolicy(name);
 }

Note: close() needs to be called on the PoliciesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of PoliciesSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PoliciesSettings policiesSettings =
     PoliciesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PoliciesClient policiesClient = PoliciesClient.create(policiesSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PoliciesSettings policiesSettings =
     PoliciesSettings.newBuilder().setEndpoint(myEndpoint).build();
 PoliciesClient policiesClient = PoliciesClient.create(policiesSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PoliciesSettings policiesSettings = PoliciesSettings.newHttpJsonBuilder().build();
 PoliciesClient policiesClient = PoliciesClient.create(policiesSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

The default service address (iam.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getPolicy to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 PoliciesSettings.Builder policiesSettingsBuilder = PoliciesSettings.newBuilder();
 policiesSettingsBuilder
     .getPolicySettings()
     .setRetrySettings(
         policiesSettingsBuilder.getPolicySettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PoliciesSettings policiesSettings = policiesSettingsBuilder.build();

Package com.google.iam.v2 (1.6.23)

PoliciesClient

Classes

Interfaces

Enums