- 0.53.0 (latest)
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
GitHub Repository | Product Reference |
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().
Method | Description | Method Variants |
---|---|---|
ListAppGateways | Lists AppGateways in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetAppGateway | Gets details of a single AppGateway. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateAppGateway | Creates a new AppGateway in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteAppGateway | Deletes a single AppGateway. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListLocations | Lists information about the supported locations for this service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation | Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy | Sets the access control policy on the specified resource. Replacesany existing policy. Can return |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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 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.
Callable method variants take no parameters and return 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.
Static Methods
create()
public static final AppGatewaysServiceClient create()
Constructs an instance of AppGatewaysServiceClient with default settings.
Returns | |
---|---|
Type | Description |
AppGatewaysServiceClient |
Exceptions | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
settings | AppGatewaysServiceSettings |
Returns | |
---|---|
Type | Description |
AppGatewaysServiceClient |
Exceptions | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
stub | AppGatewaysServiceStub |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
settings | AppGatewaysServiceSettings |
AppGatewaysServiceClient(AppGatewaysServiceStub stub)
protected AppGatewaysServiceClient(AppGatewaysServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub | AppGatewaysServiceStub |
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()
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 | |
---|---|
Name | Description |
request | CreateAppGatewayRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
parent | LocationName Required. The resource project name of the AppGateway location using the form:
|
appGateway | AppGateway Required. A BeyondCorp AppGateway resource. |
appGatewayId | String Optional. User-settable AppGateway resource ID. * Must start with a
letter. * Must contain between 4-63 characters from |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
parent | String Required. The resource project name of the AppGateway location using the form:
|
appGateway | AppGateway Required. A BeyondCorp AppGateway resource. |
appGatewayId | String Optional. User-settable AppGateway resource ID. * Must start with a
letter. * Must contain between 4-63 characters from |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
name | AppGatewayName Required. BeyondCorp AppGateway name using the form:
|
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
request | DeleteAppGatewayRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
name | String Required. BeyondCorp AppGateway name using the form:
|
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
name | AppGatewayName Required. BeyondCorp AppGateway name using the form:
|
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
request | GetAppGatewayRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
name | String Required. BeyondCorp AppGateway name using the form:
|
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
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 (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 | |
---|---|
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 (AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = appGatewaysServiceClient.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 (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 | |
---|---|
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 |
getSettings()
public final AppGatewaysServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
AppGatewaysServiceSettings |
getStub()
public AppGatewaysServiceStub getStub()
Returns | |
---|---|
Type | Description |
AppGatewaysServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
request | ListAppGatewaysRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
parent | LocationName Required. The resource name of the AppGateway location using the form:
|
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
parent | String Required. The resource name of the AppGateway location using the form:
|
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
request | com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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_DENIED
errors.
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 | |
---|---|
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_DENIED
errors.
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 | |
---|---|
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 (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 | |
---|---|
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 (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 | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |