Class AppGatewaysServiceClient (0.14.0)

public class AppGatewaysServiceClient implements BackgroundResource

Service Description: API Overview:

The beyondcorp.googleapis.com service implements the Google Cloud BeyondCorp API.

Data Model:

The AppGatewaysService exposes the following resources:

  • AppGateways, named as follows: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}.

The AppGatewaysService service provides methods to manage (create/read/update/delete) BeyondCorp AppGateways.

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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   AppGatewayName name = AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]");
   AppGateway response = appGatewaysServiceClient.getAppGateway(name);
 }
 

Note: close() needs to be called on the AppGatewaysServiceClient 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:

  1. 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.
  2. 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.
  3. 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 AppGatewaysServiceSettings 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
 AppGatewaysServiceSettings appGatewaysServiceSettings =
     AppGatewaysServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AppGatewaysServiceClient appGatewaysServiceClient =
     AppGatewaysServiceClient.create(appGatewaysServiceSettings);
 

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
 AppGatewaysServiceSettings appGatewaysServiceSettings =
     AppGatewaysServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AppGatewaysServiceClient appGatewaysServiceClient =
     AppGatewaysServiceClient.create(appGatewaysServiceSettings);
 

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

Inheritance

java.lang.Object > AppGatewaysServiceClient

Implements

BackgroundResource

Static Methods

create()

public static final AppGatewaysServiceClient create()

Constructs an instance of AppGatewaysServiceClient with default settings.

Returns
TypeDescription
AppGatewaysServiceClient
Exceptions
TypeDescription
IOException

create(AppGatewaysServiceSettings settings)

public static final AppGatewaysServiceClient create(AppGatewaysServiceSettings settings)

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

Parameter
NameDescription
settingsAppGatewaysServiceSettings
Returns
TypeDescription
AppGatewaysServiceClient
Exceptions
TypeDescription
IOException

create(AppGatewaysServiceStub stub)

public static final AppGatewaysServiceClient create(AppGatewaysServiceStub stub)

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

Parameter
NameDescription
stubAppGatewaysServiceStub
Returns
TypeDescription
AppGatewaysServiceClient

Constructors

AppGatewaysServiceClient(AppGatewaysServiceSettings settings)

protected AppGatewaysServiceClient(AppGatewaysServiceSettings settings)

Constructs an instance of AppGatewaysServiceClient, 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
NameDescription
settingsAppGatewaysServiceSettings

AppGatewaysServiceClient(AppGatewaysServiceStub stub)

protected AppGatewaysServiceClient(AppGatewaysServiceStub stub)
Parameter
NameDescription
stubAppGatewaysServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

createAppGatewayAsync(CreateAppGatewayRequest request)

public final OperationFuture<AppGateway,AppGatewayOperationMetadata> createAppGatewayAsync(CreateAppGatewayRequest request)

Creates a new AppGateway 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   CreateAppGatewayRequest request =
       CreateAppGatewayRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAppGatewayId("appGatewayId355682654")
           .setAppGateway(AppGateway.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   AppGateway response = appGatewaysServiceClient.createAppGatewayAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateAppGatewayRequest

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

Returns
TypeDescription
OperationFuture<AppGateway,AppGatewayOperationMetadata>

createAppGatewayAsync(LocationName parent, AppGateway appGateway, String appGatewayId)

public final OperationFuture<AppGateway,AppGatewayOperationMetadata> createAppGatewayAsync(LocationName parent, AppGateway appGateway, String appGatewayId)

Creates a new AppGateway 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   AppGateway appGateway = AppGateway.newBuilder().build();
   String appGatewayId = "appGatewayId355682654";
   AppGateway response =
       appGatewaysServiceClient.createAppGatewayAsync(parent, appGateway, appGatewayId).get();
 }
 
Parameters
NameDescription
parentLocationName

Required. The resource project name of the AppGateway location using the form: projects/{project_id}/locations/{location_id}

appGatewayAppGateway

Required. A BeyondCorp AppGateway resource.

appGatewayIdString

Optional. User-settable AppGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.

Returns
TypeDescription
OperationFuture<AppGateway,AppGatewayOperationMetadata>

createAppGatewayAsync(String parent, AppGateway appGateway, String appGatewayId)

public final OperationFuture<AppGateway,AppGatewayOperationMetadata> createAppGatewayAsync(String parent, AppGateway appGateway, String appGatewayId)

Creates a new AppGateway 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   AppGateway appGateway = AppGateway.newBuilder().build();
   String appGatewayId = "appGatewayId355682654";
   AppGateway response =
       appGatewaysServiceClient.createAppGatewayAsync(parent, appGateway, appGatewayId).get();
 }
 
Parameters
NameDescription
parentString

Required. The resource project name of the AppGateway location using the form: projects/{project_id}/locations/{location_id}

appGatewayAppGateway

Required. A BeyondCorp AppGateway resource.

appGatewayIdString

Optional. User-settable AppGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter.

Returns
TypeDescription
OperationFuture<AppGateway,AppGatewayOperationMetadata>

createAppGatewayCallable()

public final UnaryCallable<CreateAppGatewayRequest,Operation> createAppGatewayCallable()

Creates a new AppGateway 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   CreateAppGatewayRequest request =
       CreateAppGatewayRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAppGatewayId("appGatewayId355682654")
           .setAppGateway(AppGateway.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       appGatewaysServiceClient.createAppGatewayCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateAppGatewayRequest,Operation>

createAppGatewayOperationCallable()

public final OperationCallable<CreateAppGatewayRequest,AppGateway,AppGatewayOperationMetadata> createAppGatewayOperationCallable()

Creates a new AppGateway 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   CreateAppGatewayRequest request =
       CreateAppGatewayRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAppGatewayId("appGatewayId355682654")
           .setAppGateway(AppGateway.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<AppGateway, AppGatewayOperationMetadata> future =
       appGatewaysServiceClient.createAppGatewayOperationCallable().futureCall(request);
   // Do something.
   AppGateway response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateAppGatewayRequest,AppGateway,AppGatewayOperationMetadata>

deleteAppGatewayAsync(AppGatewayName name)

public final OperationFuture<Empty,AppGatewayOperationMetadata> deleteAppGatewayAsync(AppGatewayName name)

Deletes a single AppGateway.

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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   AppGatewayName name = AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]");
   appGatewaysServiceClient.deleteAppGatewayAsync(name).get();
 }
 
Parameter
NameDescription
nameAppGatewayName

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}

Returns
TypeDescription
OperationFuture<Empty,AppGatewayOperationMetadata>

deleteAppGatewayAsync(DeleteAppGatewayRequest request)

public final OperationFuture<Empty,AppGatewayOperationMetadata> deleteAppGatewayAsync(DeleteAppGatewayRequest request)

Deletes a single AppGateway.

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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   DeleteAppGatewayRequest request =
       DeleteAppGatewayRequest.newBuilder()
           .setName(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   appGatewaysServiceClient.deleteAppGatewayAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteAppGatewayRequest

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

Returns
TypeDescription
OperationFuture<Empty,AppGatewayOperationMetadata>

deleteAppGatewayAsync(String name)

public final OperationFuture<Empty,AppGatewayOperationMetadata> deleteAppGatewayAsync(String name)

Deletes a single AppGateway.

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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   String name = AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString();
   appGatewaysServiceClient.deleteAppGatewayAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}

Returns
TypeDescription
OperationFuture<Empty,AppGatewayOperationMetadata>

deleteAppGatewayCallable()

public final UnaryCallable<DeleteAppGatewayRequest,Operation> deleteAppGatewayCallable()

Deletes a single AppGateway.

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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   DeleteAppGatewayRequest request =
       DeleteAppGatewayRequest.newBuilder()
           .setName(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       appGatewaysServiceClient.deleteAppGatewayCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteAppGatewayRequest,Operation>

deleteAppGatewayOperationCallable()

public final OperationCallable<DeleteAppGatewayRequest,Empty,AppGatewayOperationMetadata> deleteAppGatewayOperationCallable()

Deletes a single AppGateway.

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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   DeleteAppGatewayRequest request =
       DeleteAppGatewayRequest.newBuilder()
           .setName(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<Empty, AppGatewayOperationMetadata> future =
       appGatewaysServiceClient.deleteAppGatewayOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteAppGatewayRequest,Empty,AppGatewayOperationMetadata>

getAppGateway(AppGatewayName name)

public final AppGateway getAppGateway(AppGatewayName name)

Gets details of a single AppGateway.

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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   AppGatewayName name = AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]");
   AppGateway response = appGatewaysServiceClient.getAppGateway(name);
 }
 
Parameter
NameDescription
nameAppGatewayName

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}

Returns
TypeDescription
AppGateway

getAppGateway(GetAppGatewayRequest request)

public final AppGateway getAppGateway(GetAppGatewayRequest request)

Gets details of a single AppGateway.

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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   GetAppGatewayRequest request =
       GetAppGatewayRequest.newBuilder()
           .setName(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .build();
   AppGateway response = appGatewaysServiceClient.getAppGateway(request);
 }
 
Parameter
NameDescription
requestGetAppGatewayRequest

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

Returns
TypeDescription
AppGateway

getAppGateway(String name)

public final AppGateway getAppGateway(String name)

Gets details of a single AppGateway.

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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   String name = AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString();
   AppGateway response = appGatewaysServiceClient.getAppGateway(name);
 }
 
Parameter
NameDescription
nameString

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}

Returns
TypeDescription
AppGateway

getAppGatewayCallable()

public final UnaryCallable<GetAppGatewayRequest,AppGateway> getAppGatewayCallable()

Gets details of a single AppGateway.

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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   GetAppGatewayRequest request =
       GetAppGatewayRequest.newBuilder()
           .setName(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .build();
   ApiFuture<AppGateway> future =
       appGatewaysServiceClient.getAppGatewayCallable().futureCall(request);
   // Do something.
   AppGateway response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetAppGatewayRequest,AppGateway>

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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = appGatewaysServiceClient.getIamPolicy(request);
 }
 
Parameter
NameDescription
requestcom.google.iam.v1.GetIamPolicyRequest

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

Returns
TypeDescription
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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       appGatewaysServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
TypeDescription
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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = appGatewaysServiceClient.getLocation(request);
 }
 
Parameter
NameDescription
requestcom.google.cloud.location.GetLocationRequest

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

Returns
TypeDescription
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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       appGatewaysServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 
Returns
TypeDescription
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
TypeDescription
OperationsClient

getSettings()

public final AppGatewaysServiceSettings getSettings()
Returns
TypeDescription
AppGatewaysServiceSettings

getStub()

public AppGatewaysServiceStub getStub()
Returns
TypeDescription
AppGatewaysServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listAppGateways(ListAppGatewaysRequest request)

public final AppGatewaysServiceClient.ListAppGatewaysPagedResponse listAppGateways(ListAppGatewaysRequest request)

Lists AppGateways 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   ListAppGatewaysRequest request =
       ListAppGatewaysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (AppGateway element : appGatewaysServiceClient.listAppGateways(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListAppGatewaysRequest

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

Returns
TypeDescription
AppGatewaysServiceClient.ListAppGatewaysPagedResponse

listAppGateways(LocationName parent)

public final AppGatewaysServiceClient.ListAppGatewaysPagedResponse listAppGateways(LocationName parent)

Lists AppGateways 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (AppGateway element : appGatewaysServiceClient.listAppGateways(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The resource name of the AppGateway location using the form: projects/{project_id}/locations/{location_id}

Returns
TypeDescription
AppGatewaysServiceClient.ListAppGatewaysPagedResponse

listAppGateways(String parent)

public final AppGatewaysServiceClient.ListAppGatewaysPagedResponse listAppGateways(String parent)

Lists AppGateways 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (AppGateway element : appGatewaysServiceClient.listAppGateways(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The resource name of the AppGateway location using the form: projects/{project_id}/locations/{location_id}

Returns
TypeDescription
AppGatewaysServiceClient.ListAppGatewaysPagedResponse

listAppGatewaysCallable()

public final UnaryCallable<ListAppGatewaysRequest,ListAppGatewaysResponse> listAppGatewaysCallable()

Lists AppGateways 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   ListAppGatewaysRequest request =
       ListAppGatewaysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListAppGatewaysResponse response =
         appGatewaysServiceClient.listAppGatewaysCallable().call(request);
     for (AppGateway element : response.getAppGatewaysList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAppGatewaysRequest,ListAppGatewaysResponse>

listAppGatewaysPagedCallable()

public final UnaryCallable<ListAppGatewaysRequest,AppGatewaysServiceClient.ListAppGatewaysPagedResponse> listAppGatewaysPagedCallable()

Lists AppGateways 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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   ListAppGatewaysRequest request =
       ListAppGatewaysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<AppGateway> future =
       appGatewaysServiceClient.listAppGatewaysPagedCallable().futureCall(request);
   // Do something.
   for (AppGateway element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAppGatewaysRequest,ListAppGatewaysPagedResponse>

listLocations(ListLocationsRequest request)

public final AppGatewaysServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

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

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

Returns
TypeDescription
AppGatewaysServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         appGatewaysServiceClient.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
TypeDescription
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

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

Lists information about the supported locations for this service.

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

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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = appGatewaysServiceClient.setIamPolicy(request);
 }
 
Parameter
NameDescription
requestcom.google.iam.v1.SetIamPolicyRequest

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

Returns
TypeDescription
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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       appGatewaysServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
TypeDescription
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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = appGatewaysServiceClient.testIamPermissions(request);
 }
 
Parameter
NameDescription
requestcom.google.iam.v1.TestIamPermissionsRequest

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

Returns
TypeDescription
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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(AppGatewayName.of("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       appGatewaysServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>