Class SSERealmServiceClient (0.96.0)

GitHub RepositoryProduct Reference

Service Description: Service describing handlers for resources

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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   SACRealmName name = SACRealmName.of("[PROJECT]", "[LOCATION]", "[SAC_REALM]");
   SACRealm response = sSERealmServiceClient.getSACRealm(name);
 }
 

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

Methods
Method Description Method Variants

ListSACRealms

Lists SACRealms in a given project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listSACRealms(ListSACRealmsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listSACRealms(LocationName parent)

  • listSACRealms(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listSACRealmsPagedCallable()

  • listSACRealmsCallable()

GetSACRealm

Returns the specified realm.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getSACRealm(GetSACRealmRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getSACRealm(SACRealmName name)

  • getSACRealm(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getSACRealmCallable()

CreateSACRealm

Creates a new SACRealm in a given project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createSACRealmAsync(CreateSACRealmRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createSACRealmAsync(LocationName parent, SACRealm sacRealm, String sacRealmId)

  • createSACRealmAsync(String parent, SACRealm sacRealm, String sacRealmId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createSACRealmOperationCallable()

  • createSACRealmCallable()

DeleteSACRealm

Deletes the specified realm.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteSACRealmAsync(DeleteSACRealmRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteSACRealmAsync(SACRealmName name)

  • deleteSACRealmAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteSACRealmOperationCallable()

  • deleteSACRealmCallable()

ListSACAttachments

Lists SACAttachments in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listSACAttachments(ListSACAttachmentsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listSACAttachments(LocationName parent)

  • listSACAttachments(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listSACAttachmentsPagedCallable()

  • listSACAttachmentsCallable()

GetSACAttachment

Returns the specified attachment.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getSACAttachment(GetSACAttachmentRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getSACAttachment(SACAttachmentName name)

  • getSACAttachment(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getSACAttachmentCallable()

CreateSACAttachment

Creates a new SACAttachment in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createSACAttachmentAsync(CreateSACAttachmentRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createSACAttachmentAsync(LocationName parent, SACAttachment sacAttachment, String sacAttachmentId)

  • createSACAttachmentAsync(String parent, SACAttachment sacAttachment, String sacAttachmentId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createSACAttachmentOperationCallable()

  • createSACAttachmentCallable()

DeleteSACAttachment

Deletes the specified attachment.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteSACAttachmentAsync(DeleteSACAttachmentRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteSACAttachmentAsync(SACAttachmentName name)

  • deleteSACAttachmentAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteSACAttachmentOperationCallable()

  • deleteSACAttachmentCallable()

ListLocations

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided inthe ListLocationsRequest.name field: ***Global locations**: If name is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If name follows the formatprojects/{project}, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.

For gRPC and client library implementations, the resource name ispassed as the name field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setIamPolicy(SetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setIamPolicyCallable()

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIamPolicy(GetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIamPolicyCallable()

TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • testIamPermissions(TestIamPermissionsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testIamPermissionsCallable()

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 SSERealmServiceSettings 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
 SSERealmServiceSettings sSERealmServiceSettings =
     SSERealmServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SSERealmServiceClient sSERealmServiceClient =
     SSERealmServiceClient.create(sSERealmServiceSettings);
 

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
 SSERealmServiceSettings sSERealmServiceSettings =
     SSERealmServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SSERealmServiceClient sSERealmServiceClient =
     SSERealmServiceClient.create(sSERealmServiceSettings);
 

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

Inheritance

java.lang.Object > SSERealmServiceClient

Static Methods

create()

public static final SSERealmServiceClient create()

Constructs an instance of SSERealmServiceClient with default settings.

Returns
Type Description
SSERealmServiceClient
Exceptions
Type Description
IOException

create(SSERealmServiceSettings settings)

public static final SSERealmServiceClient create(SSERealmServiceSettings settings)

Constructs an instance of SSERealmServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings SSERealmServiceSettings
Returns
Type Description
SSERealmServiceClient
Exceptions
Type Description
IOException

create(SSERealmServiceStub stub)

public static final SSERealmServiceClient create(SSERealmServiceStub stub)

Constructs an instance of SSERealmServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SSERealmServiceSettings).

Parameter
Name Description
stub SSERealmServiceStub
Returns
Type Description
SSERealmServiceClient

Constructors

SSERealmServiceClient(SSERealmServiceSettings settings)

protected SSERealmServiceClient(SSERealmServiceSettings settings)

Constructs an instance of SSERealmServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings SSERealmServiceSettings

SSERealmServiceClient(SSERealmServiceStub stub)

protected SSERealmServiceClient(SSERealmServiceStub stub)
Parameter
Name Description
stub SSERealmServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createSACAttachmentAsync(CreateSACAttachmentRequest request)

public final OperationFuture<SACAttachment,OperationMetadata> createSACAttachmentAsync(CreateSACAttachmentRequest request)

Creates a new SACAttachment in a given project and location.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   CreateSACAttachmentRequest request =
       CreateSACAttachmentRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSacAttachmentId("sacAttachmentId-476668397")
           .setSacAttachment(SACAttachment.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   SACAttachment response = sSERealmServiceClient.createSACAttachmentAsync(request).get();
 }
 
Parameter
Name Description
request CreateSACAttachmentRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<SACAttachment,OperationMetadata>

createSACAttachmentAsync(LocationName parent, SACAttachment sacAttachment, String sacAttachmentId)

public final OperationFuture<SACAttachment,OperationMetadata> createSACAttachmentAsync(LocationName parent, SACAttachment sacAttachment, String sacAttachmentId)

Creates a new SACAttachment in a given project and location.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   SACAttachment sacAttachment = SACAttachment.newBuilder().build();
   String sacAttachmentId = "sacAttachmentId-476668397";
   SACAttachment response =
       sSERealmServiceClient
           .createSACAttachmentAsync(parent, sacAttachment, sacAttachmentId)
           .get();
 }
 
Parameters
Name Description
parent LocationName

Required. The parent, in the form projects/{project}/locations/{location}.

sacAttachment SACAttachment

Required. The resource being created.

sacAttachmentId String

Required. ID of the created attachment. The ID must be 1-63 characters long, and comply with <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>. Specifically, it must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type Description
OperationFuture<SACAttachment,OperationMetadata>

createSACAttachmentAsync(String parent, SACAttachment sacAttachment, String sacAttachmentId)

public final OperationFuture<SACAttachment,OperationMetadata> createSACAttachmentAsync(String parent, SACAttachment sacAttachment, String sacAttachmentId)

Creates a new SACAttachment in a given project and location.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   SACAttachment sacAttachment = SACAttachment.newBuilder().build();
   String sacAttachmentId = "sacAttachmentId-476668397";
   SACAttachment response =
       sSERealmServiceClient
           .createSACAttachmentAsync(parent, sacAttachment, sacAttachmentId)
           .get();
 }
 
Parameters
Name Description
parent String

Required. The parent, in the form projects/{project}/locations/{location}.

sacAttachment SACAttachment

Required. The resource being created.

sacAttachmentId String

Required. ID of the created attachment. The ID must be 1-63 characters long, and comply with <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>. Specifically, it must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type Description
OperationFuture<SACAttachment,OperationMetadata>

createSACAttachmentCallable()

public final UnaryCallable<CreateSACAttachmentRequest,Operation> createSACAttachmentCallable()

Creates a new SACAttachment in a given project and location.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   CreateSACAttachmentRequest request =
       CreateSACAttachmentRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSacAttachmentId("sacAttachmentId-476668397")
           .setSacAttachment(SACAttachment.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       sSERealmServiceClient.createSACAttachmentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateSACAttachmentRequest,Operation>

createSACAttachmentOperationCallable()

public final OperationCallable<CreateSACAttachmentRequest,SACAttachment,OperationMetadata> createSACAttachmentOperationCallable()

Creates a new SACAttachment in a given project and location.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   CreateSACAttachmentRequest request =
       CreateSACAttachmentRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSacAttachmentId("sacAttachmentId-476668397")
           .setSacAttachment(SACAttachment.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<SACAttachment, OperationMetadata> future =
       sSERealmServiceClient.createSACAttachmentOperationCallable().futureCall(request);
   // Do something.
   SACAttachment response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateSACAttachmentRequest,SACAttachment,OperationMetadata>

createSACRealmAsync(CreateSACRealmRequest request)

public final OperationFuture<SACRealm,OperationMetadata> createSACRealmAsync(CreateSACRealmRequest request)

Creates a new SACRealm in a given project.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   CreateSACRealmRequest request =
       CreateSACRealmRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSacRealmId("sacRealmId-1163768203")
           .setSacRealm(SACRealm.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   SACRealm response = sSERealmServiceClient.createSACRealmAsync(request).get();
 }
 
Parameter
Name Description
request CreateSACRealmRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<SACRealm,OperationMetadata>

createSACRealmAsync(LocationName parent, SACRealm sacRealm, String sacRealmId)

public final OperationFuture<SACRealm,OperationMetadata> createSACRealmAsync(LocationName parent, SACRealm sacRealm, String sacRealmId)

Creates a new SACRealm in a given project.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   SACRealm sacRealm = SACRealm.newBuilder().build();
   String sacRealmId = "sacRealmId-1163768203";
   SACRealm response =
       sSERealmServiceClient.createSACRealmAsync(parent, sacRealm, sacRealmId).get();
 }
 
Parameters
Name Description
parent LocationName

Required. The parent, in the form projects/{project}/locations/global.

sacRealm SACRealm

Required. The resource being created.

sacRealmId String

Required. ID of the created realm. The ID must be 1-63 characters long, and comply with <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>. Specifically, it must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type Description
OperationFuture<SACRealm,OperationMetadata>

createSACRealmAsync(String parent, SACRealm sacRealm, String sacRealmId)

public final OperationFuture<SACRealm,OperationMetadata> createSACRealmAsync(String parent, SACRealm sacRealm, String sacRealmId)

Creates a new SACRealm in a given project.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   SACRealm sacRealm = SACRealm.newBuilder().build();
   String sacRealmId = "sacRealmId-1163768203";
   SACRealm response =
       sSERealmServiceClient.createSACRealmAsync(parent, sacRealm, sacRealmId).get();
 }
 
Parameters
Name Description
parent String

Required. The parent, in the form projects/{project}/locations/global.

sacRealm SACRealm

Required. The resource being created.

sacRealmId String

Required. ID of the created realm. The ID must be 1-63 characters long, and comply with <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>. Specifically, it must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type Description
OperationFuture<SACRealm,OperationMetadata>

createSACRealmCallable()

public final UnaryCallable<CreateSACRealmRequest,Operation> createSACRealmCallable()

Creates a new SACRealm in a given project.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   CreateSACRealmRequest request =
       CreateSACRealmRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSacRealmId("sacRealmId-1163768203")
           .setSacRealm(SACRealm.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       sSERealmServiceClient.createSACRealmCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateSACRealmRequest,Operation>

createSACRealmOperationCallable()

public final OperationCallable<CreateSACRealmRequest,SACRealm,OperationMetadata> createSACRealmOperationCallable()

Creates a new SACRealm in a given project.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   CreateSACRealmRequest request =
       CreateSACRealmRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSacRealmId("sacRealmId-1163768203")
           .setSacRealm(SACRealm.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<SACRealm, OperationMetadata> future =
       sSERealmServiceClient.createSACRealmOperationCallable().futureCall(request);
   // Do something.
   SACRealm response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateSACRealmRequest,SACRealm,OperationMetadata>

deleteSACAttachmentAsync(DeleteSACAttachmentRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteSACAttachmentAsync(DeleteSACAttachmentRequest request)

Deletes the specified attachment.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   DeleteSACAttachmentRequest request =
       DeleteSACAttachmentRequest.newBuilder()
           .setName(
               SACAttachmentName.of("[PROJECT]", "[LOCATION]", "[SAC_ATTACHMENT]").toString())
           .setRequestId("requestId693933066")
           .build();
   sSERealmServiceClient.deleteSACAttachmentAsync(request).get();
 }
 
Parameter
Name Description
request DeleteSACAttachmentRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSACAttachmentAsync(SACAttachmentName name)

public final OperationFuture<Empty,OperationMetadata> deleteSACAttachmentAsync(SACAttachmentName name)

Deletes the specified attachment.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   SACAttachmentName name = SACAttachmentName.of("[PROJECT]", "[LOCATION]", "[SAC_ATTACHMENT]");
   sSERealmServiceClient.deleteSACAttachmentAsync(name).get();
 }
 
Parameter
Name Description
name SACAttachmentName

Required. Name of the resource, in the form projects/{project}/locations/{location}/sacAttachments/{sac_attachment}.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSACAttachmentAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteSACAttachmentAsync(String name)

Deletes the specified attachment.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   String name = SACAttachmentName.of("[PROJECT]", "[LOCATION]", "[SAC_ATTACHMENT]").toString();
   sSERealmServiceClient.deleteSACAttachmentAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. Name of the resource, in the form projects/{project}/locations/{location}/sacAttachments/{sac_attachment}.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSACAttachmentCallable()

public final UnaryCallable<DeleteSACAttachmentRequest,Operation> deleteSACAttachmentCallable()

Deletes the specified attachment.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   DeleteSACAttachmentRequest request =
       DeleteSACAttachmentRequest.newBuilder()
           .setName(
               SACAttachmentName.of("[PROJECT]", "[LOCATION]", "[SAC_ATTACHMENT]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       sSERealmServiceClient.deleteSACAttachmentCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteSACAttachmentRequest,Operation>

deleteSACAttachmentOperationCallable()

public final OperationCallable<DeleteSACAttachmentRequest,Empty,OperationMetadata> deleteSACAttachmentOperationCallable()

Deletes the specified attachment.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   DeleteSACAttachmentRequest request =
       DeleteSACAttachmentRequest.newBuilder()
           .setName(
               SACAttachmentName.of("[PROJECT]", "[LOCATION]", "[SAC_ATTACHMENT]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       sSERealmServiceClient.deleteSACAttachmentOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteSACAttachmentRequest,Empty,OperationMetadata>

deleteSACRealmAsync(DeleteSACRealmRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteSACRealmAsync(DeleteSACRealmRequest request)

Deletes the specified realm.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   DeleteSACRealmRequest request =
       DeleteSACRealmRequest.newBuilder()
           .setName(SACRealmName.of("[PROJECT]", "[LOCATION]", "[SAC_REALM]").toString())
           .setRequestId("requestId693933066")
           .build();
   sSERealmServiceClient.deleteSACRealmAsync(request).get();
 }
 
Parameter
Name Description
request DeleteSACRealmRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSACRealmAsync(SACRealmName name)

public final OperationFuture<Empty,OperationMetadata> deleteSACRealmAsync(SACRealmName name)

Deletes the specified realm.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   SACRealmName name = SACRealmName.of("[PROJECT]", "[LOCATION]", "[SAC_REALM]");
   sSERealmServiceClient.deleteSACRealmAsync(name).get();
 }
 
Parameter
Name Description
name SACRealmName

Required. Name of the resource, in the form projects/{project}/locations/global/sacRealms/{sacRealm}.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSACRealmAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteSACRealmAsync(String name)

Deletes the specified realm.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   String name = SACRealmName.of("[PROJECT]", "[LOCATION]", "[SAC_REALM]").toString();
   sSERealmServiceClient.deleteSACRealmAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. Name of the resource, in the form projects/{project}/locations/global/sacRealms/{sacRealm}.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSACRealmCallable()

public final UnaryCallable<DeleteSACRealmRequest,Operation> deleteSACRealmCallable()

Deletes the specified realm.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   DeleteSACRealmRequest request =
       DeleteSACRealmRequest.newBuilder()
           .setName(SACRealmName.of("[PROJECT]", "[LOCATION]", "[SAC_REALM]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       sSERealmServiceClient.deleteSACRealmCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteSACRealmRequest,Operation>

deleteSACRealmOperationCallable()

public final OperationCallable<DeleteSACRealmRequest,Empty,OperationMetadata> deleteSACRealmOperationCallable()

Deletes the specified realm.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   DeleteSACRealmRequest request =
       DeleteSACRealmRequest.newBuilder()
           .setName(SACRealmName.of("[PROJECT]", "[LOCATION]", "[SAC_REALM]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       sSERealmServiceClient.deleteSACRealmOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteSACRealmRequest,Empty,OperationMetadata>

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               AddressGroupName.ofProjectLocationAddressGroupName(
                       "[PROJECT]", "[LOCATION]", "[ADDRESS_GROUP]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = sSERealmServiceClient.getIamPolicy(request);
 }
 
Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               AddressGroupName.ofProjectLocationAddressGroupName(
                       "[PROJECT]", "[LOCATION]", "[ADDRESS_GROUP]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = sSERealmServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = sSERealmServiceClient.getLocation(request);
 }
 
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = sSERealmServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getSACAttachment(GetSACAttachmentRequest request)

public final SACAttachment getSACAttachment(GetSACAttachmentRequest request)

Returns the specified attachment.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   GetSACAttachmentRequest request =
       GetSACAttachmentRequest.newBuilder()
           .setName(
               SACAttachmentName.of("[PROJECT]", "[LOCATION]", "[SAC_ATTACHMENT]").toString())
           .build();
   SACAttachment response = sSERealmServiceClient.getSACAttachment(request);
 }
 
Parameter
Name Description
request GetSACAttachmentRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SACAttachment

getSACAttachment(SACAttachmentName name)

public final SACAttachment getSACAttachment(SACAttachmentName name)

Returns the specified attachment.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   SACAttachmentName name = SACAttachmentName.of("[PROJECT]", "[LOCATION]", "[SAC_ATTACHMENT]");
   SACAttachment response = sSERealmServiceClient.getSACAttachment(name);
 }
 
Parameter
Name Description
name SACAttachmentName

Required. Name of the resource, in the form projects/{project}/locations/{location}/sacAttachments/{sac_attachment}.

Returns
Type Description
SACAttachment

getSACAttachment(String name)

public final SACAttachment getSACAttachment(String name)

Returns the specified attachment.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   String name = SACAttachmentName.of("[PROJECT]", "[LOCATION]", "[SAC_ATTACHMENT]").toString();
   SACAttachment response = sSERealmServiceClient.getSACAttachment(name);
 }
 
Parameter
Name Description
name String

Required. Name of the resource, in the form projects/{project}/locations/{location}/sacAttachments/{sac_attachment}.

Returns
Type Description
SACAttachment

getSACAttachmentCallable()

public final UnaryCallable<GetSACAttachmentRequest,SACAttachment> getSACAttachmentCallable()

Returns the specified attachment.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   GetSACAttachmentRequest request =
       GetSACAttachmentRequest.newBuilder()
           .setName(
               SACAttachmentName.of("[PROJECT]", "[LOCATION]", "[SAC_ATTACHMENT]").toString())
           .build();
   ApiFuture<SACAttachment> future =
       sSERealmServiceClient.getSACAttachmentCallable().futureCall(request);
   // Do something.
   SACAttachment response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetSACAttachmentRequest,SACAttachment>

getSACRealm(GetSACRealmRequest request)

public final SACRealm getSACRealm(GetSACRealmRequest request)

Returns the specified realm.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   GetSACRealmRequest request =
       GetSACRealmRequest.newBuilder()
           .setName(SACRealmName.of("[PROJECT]", "[LOCATION]", "[SAC_REALM]").toString())
           .build();
   SACRealm response = sSERealmServiceClient.getSACRealm(request);
 }
 
Parameter
Name Description
request GetSACRealmRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SACRealm

getSACRealm(SACRealmName name)

public final SACRealm getSACRealm(SACRealmName name)

Returns the specified realm.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   SACRealmName name = SACRealmName.of("[PROJECT]", "[LOCATION]", "[SAC_REALM]");
   SACRealm response = sSERealmServiceClient.getSACRealm(name);
 }
 
Parameter
Name Description
name SACRealmName

Required. Name of the resource, in the form projects/{project}/locations/global/sacRealms/{sacRealm}.

Returns
Type Description
SACRealm

getSACRealm(String name)

public final SACRealm getSACRealm(String name)

Returns the specified realm.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   String name = SACRealmName.of("[PROJECT]", "[LOCATION]", "[SAC_REALM]").toString();
   SACRealm response = sSERealmServiceClient.getSACRealm(name);
 }
 
Parameter
Name Description
name String

Required. Name of the resource, in the form projects/{project}/locations/global/sacRealms/{sacRealm}.

Returns
Type Description
SACRealm

getSACRealmCallable()

public final UnaryCallable<GetSACRealmRequest,SACRealm> getSACRealmCallable()

Returns the specified realm.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   GetSACRealmRequest request =
       GetSACRealmRequest.newBuilder()
           .setName(SACRealmName.of("[PROJECT]", "[LOCATION]", "[SAC_REALM]").toString())
           .build();
   ApiFuture<SACRealm> future = sSERealmServiceClient.getSACRealmCallable().futureCall(request);
   // Do something.
   SACRealm response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetSACRealmRequest,SACRealm>

getSettings()

public final SSERealmServiceSettings getSettings()
Returns
Type Description
SSERealmServiceSettings

getStub()

public SSERealmServiceStub getStub()
Returns
Type Description
SSERealmServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final SSERealmServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided inthe ListLocationsRequest.name field: ***Global locations**: If name is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If name follows the formatprojects/{project}, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.

For gRPC and client library implementations, the resource name ispassed as the name field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : sSERealmServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SSERealmServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided inthe ListLocationsRequest.name field: ***Global locations**: If name is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If name follows the formatprojects/{project}, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.

For gRPC and client library implementations, the resource name ispassed as the name field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         sSERealmServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,SSERealmServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided inthe ListLocationsRequest.name field: ***Global locations**: If name is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If name follows the formatprojects/{project}, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.

For gRPC and client library implementations, the resource name ispassed as the name field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       sSERealmServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listSACAttachments(ListSACAttachmentsRequest request)

public final SSERealmServiceClient.ListSACAttachmentsPagedResponse listSACAttachments(ListSACAttachmentsRequest request)

Lists SACAttachments in a given project and location.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   ListSACAttachmentsRequest request =
       ListSACAttachmentsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (SACAttachment element : sSERealmServiceClient.listSACAttachments(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListSACAttachmentsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SSERealmServiceClient.ListSACAttachmentsPagedResponse

listSACAttachments(LocationName parent)

public final SSERealmServiceClient.ListSACAttachmentsPagedResponse listSACAttachments(LocationName parent)

Lists SACAttachments in a given project and location.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (SACAttachment element : sSERealmServiceClient.listSACAttachments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. The parent, in the form projects/{project}/locations/{location}.

Returns
Type Description
SSERealmServiceClient.ListSACAttachmentsPagedResponse

listSACAttachments(String parent)

public final SSERealmServiceClient.ListSACAttachmentsPagedResponse listSACAttachments(String parent)

Lists SACAttachments in a given project and location.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (SACAttachment element : sSERealmServiceClient.listSACAttachments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent, in the form projects/{project}/locations/{location}.

Returns
Type Description
SSERealmServiceClient.ListSACAttachmentsPagedResponse

listSACAttachmentsCallable()

public final UnaryCallable<ListSACAttachmentsRequest,ListSACAttachmentsResponse> listSACAttachmentsCallable()

Lists SACAttachments in a given project and location.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   ListSACAttachmentsRequest request =
       ListSACAttachmentsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListSACAttachmentsResponse response =
         sSERealmServiceClient.listSACAttachmentsCallable().call(request);
     for (SACAttachment element : response.getSacAttachmentsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListSACAttachmentsRequest,ListSACAttachmentsResponse>

listSACAttachmentsPagedCallable()

public final UnaryCallable<ListSACAttachmentsRequest,SSERealmServiceClient.ListSACAttachmentsPagedResponse> listSACAttachmentsPagedCallable()

Lists SACAttachments in a given project and location.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   ListSACAttachmentsRequest request =
       ListSACAttachmentsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<SACAttachment> future =
       sSERealmServiceClient.listSACAttachmentsPagedCallable().futureCall(request);
   // Do something.
   for (SACAttachment element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListSACAttachmentsRequest,ListSACAttachmentsPagedResponse>

listSACRealms(ListSACRealmsRequest request)

public final SSERealmServiceClient.ListSACRealmsPagedResponse listSACRealms(ListSACRealmsRequest request)

Lists SACRealms in a given project.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   ListSACRealmsRequest request =
       ListSACRealmsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (SACRealm element : sSERealmServiceClient.listSACRealms(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListSACRealmsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SSERealmServiceClient.ListSACRealmsPagedResponse

listSACRealms(LocationName parent)

public final SSERealmServiceClient.ListSACRealmsPagedResponse listSACRealms(LocationName parent)

Lists SACRealms in a given project.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (SACRealm element : sSERealmServiceClient.listSACRealms(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. The parent, in the form projects/{project}/locations/global.

Returns
Type Description
SSERealmServiceClient.ListSACRealmsPagedResponse

listSACRealms(String parent)

public final SSERealmServiceClient.ListSACRealmsPagedResponse listSACRealms(String parent)

Lists SACRealms in a given project.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (SACRealm element : sSERealmServiceClient.listSACRealms(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent, in the form projects/{project}/locations/global.

Returns
Type Description
SSERealmServiceClient.ListSACRealmsPagedResponse

listSACRealmsCallable()

public final UnaryCallable<ListSACRealmsRequest,ListSACRealmsResponse> listSACRealmsCallable()

Lists SACRealms in a given project.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   ListSACRealmsRequest request =
       ListSACRealmsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListSACRealmsResponse response =
         sSERealmServiceClient.listSACRealmsCallable().call(request);
     for (SACRealm element : response.getSacRealmsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListSACRealmsRequest,ListSACRealmsResponse>

listSACRealmsPagedCallable()

public final UnaryCallable<ListSACRealmsRequest,SSERealmServiceClient.ListSACRealmsPagedResponse> listSACRealmsPagedCallable()

Lists SACRealms in a given project.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   ListSACRealmsRequest request =
       ListSACRealmsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<SACRealm> future =
       sSERealmServiceClient.listSACRealmsPagedCallable().futureCall(request);
   // Do something.
   for (SACRealm element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListSACRealmsRequest,ListSACRealmsPagedResponse>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               AddressGroupName.ofProjectLocationAddressGroupName(
                       "[PROJECT]", "[LOCATION]", "[ADDRESS_GROUP]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = sSERealmServiceClient.setIamPolicy(request);
 }
 
Parameter
Name Description
request com.google.iam.v1.SetIamPolicyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               AddressGroupName.ofProjectLocationAddressGroupName(
                       "[PROJECT]", "[LOCATION]", "[ADDRESS_GROUP]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = sSERealmServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

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

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               AddressGroupName.ofProjectLocationAddressGroupName(
                       "[PROJECT]", "[LOCATION]", "[ADDRESS_GROUP]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = sSERealmServiceClient.testIamPermissions(request);
 }
 
Parameter
Name Description
request com.google.iam.v1.TestIamPermissionsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

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

Sample code:


 // 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 (SSERealmServiceClient sSERealmServiceClient = SSERealmServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               AddressGroupName.ofProjectLocationAddressGroupName(
                       "[PROJECT]", "[LOCATION]", "[ADDRESS_GROUP]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       sSERealmServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>