GitHub Repository | Product Reference |
Service Description: APIs for Identity-Aware Proxy Admin configurations.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]").toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = identityAwareProxyAdminServiceClient.setIamPolicy(request);
}
Note: close() needs to be called on the IdentityAwareProxyAdminServiceClient 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 |
---|---|---|
SetIamPolicy |
Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api |
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 an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api |
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 Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api |
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.
|
GetIapSettings |
Gets the IAP settings on a particular IAP protected resource. |
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.
|
UpdateIapSettings |
Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless the |
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.
|
ListTunnelDestGroups |
Lists the existing TunnelDestGroups. To group across all locations, use a |
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.
|
CreateTunnelDestGroup |
Creates a new TunnelDestGroup. |
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.
|
GetTunnelDestGroup |
Retrieves an existing TunnelDestGroup. |
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.
|
DeleteTunnelDestGroup |
Deletes a TunnelDestGroup. |
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.
|
UpdateTunnelDestGroup |
Updates a TunnelDestGroup. |
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.
|
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 IdentityAwareProxyAdminServiceSettings 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
IdentityAwareProxyAdminServiceSettings identityAwareProxyAdminServiceSettings =
IdentityAwareProxyAdminServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create(identityAwareProxyAdminServiceSettings);
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
IdentityAwareProxyAdminServiceSettings identityAwareProxyAdminServiceSettings =
IdentityAwareProxyAdminServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create(identityAwareProxyAdminServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
IdentityAwareProxyAdminServiceSettings identityAwareProxyAdminServiceSettings =
IdentityAwareProxyAdminServiceSettings.newHttpJsonBuilder().build();
IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create(identityAwareProxyAdminServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final IdentityAwareProxyAdminServiceClient create()
Constructs an instance of IdentityAwareProxyAdminServiceClient with default settings.
Returns | |
---|---|
Type | Description |
IdentityAwareProxyAdminServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(IdentityAwareProxyAdminServiceSettings settings)
public static final IdentityAwareProxyAdminServiceClient create(IdentityAwareProxyAdminServiceSettings settings)
Constructs an instance of IdentityAwareProxyAdminServiceClient, 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 |
IdentityAwareProxyAdminServiceSettings |
Returns | |
---|---|
Type | Description |
IdentityAwareProxyAdminServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(IdentityAwareProxyAdminServiceStub stub)
public static final IdentityAwareProxyAdminServiceClient create(IdentityAwareProxyAdminServiceStub stub)
Constructs an instance of IdentityAwareProxyAdminServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(IdentityAwareProxyAdminServiceSettings).
Parameter | |
---|---|
Name | Description |
stub |
IdentityAwareProxyAdminServiceStub |
Returns | |
---|---|
Type | Description |
IdentityAwareProxyAdminServiceClient |
Constructors
IdentityAwareProxyAdminServiceClient(IdentityAwareProxyAdminServiceSettings settings)
protected IdentityAwareProxyAdminServiceClient(IdentityAwareProxyAdminServiceSettings settings)
Constructs an instance of IdentityAwareProxyAdminServiceClient, 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 |
IdentityAwareProxyAdminServiceSettings |
IdentityAwareProxyAdminServiceClient(IdentityAwareProxyAdminServiceStub stub)
protected IdentityAwareProxyAdminServiceClient(IdentityAwareProxyAdminServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub |
IdentityAwareProxyAdminServiceStub |
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()
createTunnelDestGroup(CreateTunnelDestGroupRequest request)
public final TunnelDestGroup createTunnelDestGroup(CreateTunnelDestGroupRequest request)
Creates a new TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
CreateTunnelDestGroupRequest request =
CreateTunnelDestGroupRequest.newBuilder()
.setParent(TunnelLocationName.of("[PROJECT]", "[LOCATION]").toString())
.setTunnelDestGroup(TunnelDestGroup.newBuilder().build())
.setTunnelDestGroupId("tunnelDestGroupId-1240473232")
.build();
TunnelDestGroup response =
identityAwareProxyAdminServiceClient.createTunnelDestGroup(request);
}
Parameter | |
---|---|
Name | Description |
request |
CreateTunnelDestGroupRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
TunnelDestGroup |
createTunnelDestGroup(TunnelLocationName parent, TunnelDestGroup tunnelDestGroup, String tunnelDestGroupId)
public final TunnelDestGroup createTunnelDestGroup(TunnelLocationName parent, TunnelDestGroup tunnelDestGroup, String tunnelDestGroupId)
Creates a new TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
TunnelLocationName parent = TunnelLocationName.of("[PROJECT]", "[LOCATION]");
TunnelDestGroup tunnelDestGroup = TunnelDestGroup.newBuilder().build();
String tunnelDestGroupId = "tunnelDestGroupId-1240473232";
TunnelDestGroup response =
identityAwareProxyAdminServiceClient.createTunnelDestGroup(
parent, tunnelDestGroup, tunnelDestGroupId);
}
Parameters | |
---|---|
Name | Description |
parent |
TunnelLocationName Required. Google Cloud Project ID and location. In the following format:
|
tunnelDestGroup |
TunnelDestGroup Required. The TunnelDestGroup to create. |
tunnelDestGroupId |
String Required. The ID to use for the TunnelDestGroup, which becomes the final component of the resource name. This value must be 4-63 characters, and valid characters are |
Returns | |
---|---|
Type | Description |
TunnelDestGroup |
createTunnelDestGroup(String parent, TunnelDestGroup tunnelDestGroup, String tunnelDestGroupId)
public final TunnelDestGroup createTunnelDestGroup(String parent, TunnelDestGroup tunnelDestGroup, String tunnelDestGroupId)
Creates a new TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
String parent = TunnelLocationName.of("[PROJECT]", "[LOCATION]").toString();
TunnelDestGroup tunnelDestGroup = TunnelDestGroup.newBuilder().build();
String tunnelDestGroupId = "tunnelDestGroupId-1240473232";
TunnelDestGroup response =
identityAwareProxyAdminServiceClient.createTunnelDestGroup(
parent, tunnelDestGroup, tunnelDestGroupId);
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. Google Cloud Project ID and location. In the following format:
|
tunnelDestGroup |
TunnelDestGroup Required. The TunnelDestGroup to create. |
tunnelDestGroupId |
String Required. The ID to use for the TunnelDestGroup, which becomes the final component of the resource name. This value must be 4-63 characters, and valid characters are |
Returns | |
---|---|
Type | Description |
TunnelDestGroup |
createTunnelDestGroupCallable()
public final UnaryCallable<CreateTunnelDestGroupRequest,TunnelDestGroup> createTunnelDestGroupCallable()
Creates a new TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
CreateTunnelDestGroupRequest request =
CreateTunnelDestGroupRequest.newBuilder()
.setParent(TunnelLocationName.of("[PROJECT]", "[LOCATION]").toString())
.setTunnelDestGroup(TunnelDestGroup.newBuilder().build())
.setTunnelDestGroupId("tunnelDestGroupId-1240473232")
.build();
ApiFuture<TunnelDestGroup> future =
identityAwareProxyAdminServiceClient.createTunnelDestGroupCallable().futureCall(request);
// Do something.
TunnelDestGroup response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateTunnelDestGroupRequest,TunnelDestGroup> |
deleteTunnelDestGroup(DeleteTunnelDestGroupRequest request)
public final void deleteTunnelDestGroup(DeleteTunnelDestGroupRequest request)
Deletes a TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
DeleteTunnelDestGroupRequest request =
DeleteTunnelDestGroupRequest.newBuilder()
.setName(TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]").toString())
.build();
identityAwareProxyAdminServiceClient.deleteTunnelDestGroup(request);
}
Parameter | |
---|---|
Name | Description |
request |
DeleteTunnelDestGroupRequest The request object containing all of the parameters for the API call. |
deleteTunnelDestGroup(TunnelDestGroupName name)
public final void deleteTunnelDestGroup(TunnelDestGroupName name)
Deletes a TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
TunnelDestGroupName name = TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]");
identityAwareProxyAdminServiceClient.deleteTunnelDestGroup(name);
}
Parameter | |
---|---|
Name | Description |
name |
TunnelDestGroupName Required. Name of the TunnelDestGroup to delete. In the following format:
|
deleteTunnelDestGroup(String name)
public final void deleteTunnelDestGroup(String name)
Deletes a TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
String name = TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]").toString();
identityAwareProxyAdminServiceClient.deleteTunnelDestGroup(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. Name of the TunnelDestGroup to delete. In the following format:
|
deleteTunnelDestGroupCallable()
public final UnaryCallable<DeleteTunnelDestGroupRequest,Empty> deleteTunnelDestGroupCallable()
Deletes a TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
DeleteTunnelDestGroupRequest request =
DeleteTunnelDestGroupRequest.newBuilder()
.setName(TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]").toString())
.build();
ApiFuture<Empty> future =
identityAwareProxyAdminServiceClient.deleteTunnelDestGroupCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteTunnelDestGroupRequest,Empty> |
getIamPolicy(GetIamPolicyRequest request)
public final Policy getIamPolicy(GetIamPolicyRequest request)
Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]").toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = identityAwareProxyAdminServiceClient.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 an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]").toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future =
identityAwareProxyAdminServiceClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getIapSettings(GetIapSettingsRequest request)
public final IapSettings getIapSettings(GetIapSettingsRequest request)
Gets the IAP settings on a particular IAP protected resource.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
GetIapSettingsRequest request =
GetIapSettingsRequest.newBuilder().setName("name3373707").build();
IapSettings response = identityAwareProxyAdminServiceClient.getIapSettings(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetIapSettingsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
IapSettings |
getIapSettingsCallable()
public final UnaryCallable<GetIapSettingsRequest,IapSettings> getIapSettingsCallable()
Gets the IAP settings on a particular IAP protected resource.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
GetIapSettingsRequest request =
GetIapSettingsRequest.newBuilder().setName("name3373707").build();
ApiFuture<IapSettings> future =
identityAwareProxyAdminServiceClient.getIapSettingsCallable().futureCall(request);
// Do something.
IapSettings response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetIapSettingsRequest,IapSettings> |
getSettings()
public final IdentityAwareProxyAdminServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
IdentityAwareProxyAdminServiceSettings |
getStub()
public IdentityAwareProxyAdminServiceStub getStub()
Returns | |
---|---|
Type | Description |
IdentityAwareProxyAdminServiceStub |
getTunnelDestGroup(GetTunnelDestGroupRequest request)
public final TunnelDestGroup getTunnelDestGroup(GetTunnelDestGroupRequest request)
Retrieves an existing TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
GetTunnelDestGroupRequest request =
GetTunnelDestGroupRequest.newBuilder()
.setName(TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]").toString())
.build();
TunnelDestGroup response = identityAwareProxyAdminServiceClient.getTunnelDestGroup(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetTunnelDestGroupRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
TunnelDestGroup |
getTunnelDestGroup(TunnelDestGroupName name)
public final TunnelDestGroup getTunnelDestGroup(TunnelDestGroupName name)
Retrieves an existing TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
TunnelDestGroupName name = TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]");
TunnelDestGroup response = identityAwareProxyAdminServiceClient.getTunnelDestGroup(name);
}
Parameter | |
---|---|
Name | Description |
name |
TunnelDestGroupName Required. Name of the TunnelDestGroup to be fetched. In the following format:
|
Returns | |
---|---|
Type | Description |
TunnelDestGroup |
getTunnelDestGroup(String name)
public final TunnelDestGroup getTunnelDestGroup(String name)
Retrieves an existing TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
String name = TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]").toString();
TunnelDestGroup response = identityAwareProxyAdminServiceClient.getTunnelDestGroup(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. Name of the TunnelDestGroup to be fetched. In the following format:
|
Returns | |
---|---|
Type | Description |
TunnelDestGroup |
getTunnelDestGroupCallable()
public final UnaryCallable<GetTunnelDestGroupRequest,TunnelDestGroup> getTunnelDestGroupCallable()
Retrieves an existing TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
GetTunnelDestGroupRequest request =
GetTunnelDestGroupRequest.newBuilder()
.setName(TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]").toString())
.build();
ApiFuture<TunnelDestGroup> future =
identityAwareProxyAdminServiceClient.getTunnelDestGroupCallable().futureCall(request);
// Do something.
TunnelDestGroup response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetTunnelDestGroupRequest,TunnelDestGroup> |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listTunnelDestGroups(ListTunnelDestGroupsRequest request)
public final IdentityAwareProxyAdminServiceClient.ListTunnelDestGroupsPagedResponse listTunnelDestGroups(ListTunnelDestGroupsRequest request)
Lists the existing TunnelDestGroups. To group across all locations, use a -
as the location
ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
ListTunnelDestGroupsRequest request =
ListTunnelDestGroupsRequest.newBuilder()
.setParent(TunnelLocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (TunnelDestGroup element :
identityAwareProxyAdminServiceClient.listTunnelDestGroups(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListTunnelDestGroupsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
IdentityAwareProxyAdminServiceClient.ListTunnelDestGroupsPagedResponse |
listTunnelDestGroups(TunnelLocationName parent)
public final IdentityAwareProxyAdminServiceClient.ListTunnelDestGroupsPagedResponse listTunnelDestGroups(TunnelLocationName parent)
Lists the existing TunnelDestGroups. To group across all locations, use a -
as the location
ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
TunnelLocationName parent = TunnelLocationName.of("[PROJECT]", "[LOCATION]");
for (TunnelDestGroup element :
identityAwareProxyAdminServiceClient.listTunnelDestGroups(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
TunnelLocationName Required. Google Cloud Project ID and location. In the following format:
|
Returns | |
---|---|
Type | Description |
IdentityAwareProxyAdminServiceClient.ListTunnelDestGroupsPagedResponse |
listTunnelDestGroups(String parent)
public final IdentityAwareProxyAdminServiceClient.ListTunnelDestGroupsPagedResponse listTunnelDestGroups(String parent)
Lists the existing TunnelDestGroups. To group across all locations, use a -
as the location
ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
String parent = TunnelLocationName.of("[PROJECT]", "[LOCATION]").toString();
for (TunnelDestGroup element :
identityAwareProxyAdminServiceClient.listTunnelDestGroups(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. Google Cloud Project ID and location. In the following format:
|
Returns | |
---|---|
Type | Description |
IdentityAwareProxyAdminServiceClient.ListTunnelDestGroupsPagedResponse |
listTunnelDestGroupsCallable()
public final UnaryCallable<ListTunnelDestGroupsRequest,ListTunnelDestGroupsResponse> listTunnelDestGroupsCallable()
Lists the existing TunnelDestGroups. To group across all locations, use a -
as the location
ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
ListTunnelDestGroupsRequest request =
ListTunnelDestGroupsRequest.newBuilder()
.setParent(TunnelLocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListTunnelDestGroupsResponse response =
identityAwareProxyAdminServiceClient.listTunnelDestGroupsCallable().call(request);
for (TunnelDestGroup element : response.getTunnelDestGroupsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListTunnelDestGroupsRequest,ListTunnelDestGroupsResponse> |
listTunnelDestGroupsPagedCallable()
public final UnaryCallable<ListTunnelDestGroupsRequest,IdentityAwareProxyAdminServiceClient.ListTunnelDestGroupsPagedResponse> listTunnelDestGroupsPagedCallable()
Lists the existing TunnelDestGroups. To group across all locations, use a -
as the location
ID. For example: /v1/projects/123/iap_tunnel/locations/-/destGroups
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
ListTunnelDestGroupsRequest request =
ListTunnelDestGroupsRequest.newBuilder()
.setParent(TunnelLocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<TunnelDestGroup> future =
identityAwareProxyAdminServiceClient
.listTunnelDestGroupsPagedCallable()
.futureCall(request);
// Do something.
for (TunnelDestGroup element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListTunnelDestGroupsRequest,ListTunnelDestGroupsPagedResponse> |
setIamPolicy(SetIamPolicyRequest request)
public final Policy setIamPolicy(SetIamPolicyRequest request)
Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]").toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = identityAwareProxyAdminServiceClient.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 for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]").toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future =
identityAwareProxyAdminServiceClient.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 Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]").toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response =
identityAwareProxyAdminServiceClient.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 Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
TunnelDestGroupName.of("[PROJECT]", "[LOCATION]", "[DEST_GROUP]").toString())
.addAllPermissions(new ArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse> future =
identityAwareProxyAdminServiceClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
updateIapSettings(UpdateIapSettingsRequest request)
public final IapSettings updateIapSettings(UpdateIapSettingsRequest request)
Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless
the update_mask
is 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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
UpdateIapSettingsRequest request =
UpdateIapSettingsRequest.newBuilder()
.setIapSettings(IapSettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
IapSettings response = identityAwareProxyAdminServiceClient.updateIapSettings(request);
}
Parameter | |
---|---|
Name | Description |
request |
UpdateIapSettingsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
IapSettings |
updateIapSettingsCallable()
public final UnaryCallable<UpdateIapSettingsRequest,IapSettings> updateIapSettingsCallable()
Updates the IAP settings on a particular IAP protected resource. It replaces all fields unless
the update_mask
is 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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
UpdateIapSettingsRequest request =
UpdateIapSettingsRequest.newBuilder()
.setIapSettings(IapSettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<IapSettings> future =
identityAwareProxyAdminServiceClient.updateIapSettingsCallable().futureCall(request);
// Do something.
IapSettings response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateIapSettingsRequest,IapSettings> |
updateTunnelDestGroup(TunnelDestGroup tunnelDestGroup, FieldMask updateMask)
public final TunnelDestGroup updateTunnelDestGroup(TunnelDestGroup tunnelDestGroup, FieldMask updateMask)
Updates a TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
TunnelDestGroup tunnelDestGroup = TunnelDestGroup.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
TunnelDestGroup response =
identityAwareProxyAdminServiceClient.updateTunnelDestGroup(tunnelDestGroup, updateMask);
}
Parameters | |
---|---|
Name | Description |
tunnelDestGroup |
TunnelDestGroup Required. The new values for the TunnelDestGroup. |
updateMask |
FieldMask A field mask that specifies which IAP settings to update. If omitted, then all of the settings are updated. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask |
Returns | |
---|---|
Type | Description |
TunnelDestGroup |
updateTunnelDestGroup(UpdateTunnelDestGroupRequest request)
public final TunnelDestGroup updateTunnelDestGroup(UpdateTunnelDestGroupRequest request)
Updates a TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
UpdateTunnelDestGroupRequest request =
UpdateTunnelDestGroupRequest.newBuilder()
.setTunnelDestGroup(TunnelDestGroup.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
TunnelDestGroup response =
identityAwareProxyAdminServiceClient.updateTunnelDestGroup(request);
}
Parameter | |
---|---|
Name | Description |
request |
UpdateTunnelDestGroupRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
TunnelDestGroup |
updateTunnelDestGroupCallable()
public final UnaryCallable<UpdateTunnelDestGroupRequest,TunnelDestGroup> updateTunnelDestGroupCallable()
Updates a TunnelDestGroup.
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 (IdentityAwareProxyAdminServiceClient identityAwareProxyAdminServiceClient =
IdentityAwareProxyAdminServiceClient.create()) {
UpdateTunnelDestGroupRequest request =
UpdateTunnelDestGroupRequest.newBuilder()
.setTunnelDestGroup(TunnelDestGroup.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<TunnelDestGroup> future =
identityAwareProxyAdminServiceClient.updateTunnelDestGroupCallable().futureCall(request);
// Do something.
TunnelDestGroup response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateTunnelDestGroupRequest,TunnelDestGroup> |