- 1.52.0 (latest)
- 1.51.0
- 1.50.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.7
- 1.1.1
- 1.0.4
GitHub Repository | Product Reference |
Service Description: The IDS Service
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 (IDSClient iDSClient = IDSClient.create()) {
EndpointName name = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
Endpoint response = iDSClient.getEndpoint(name);
}
Note: close() needs to be called on the IDSClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of IDSSettings 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
IDSSettings iDSSettings =
IDSSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
IDSClient iDSClient = IDSClient.create(iDSSettings);
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
IDSSettings iDSSettings = IDSSettings.newBuilder().setEndpoint(myEndpoint).build();
IDSClient iDSClient = IDSClient.create(iDSSettings);
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
IDSSettings iDSSettings = IDSSettings.newHttpJsonBuilder().build();
IDSClient iDSClient = IDSClient.create(iDSSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final IDSClient create()
Constructs an instance of IDSClient with default settings.
Returns | |
---|---|
Type | Description |
IDSClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(IDSSettings settings)
public static final IDSClient create(IDSSettings settings)
Constructs an instance of IDSClient, 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 | IDSSettings |
Returns | |
---|---|
Type | Description |
IDSClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(IDSStub stub)
public static final IDSClient create(IDSStub stub)
Constructs an instance of IDSClient, using the given stub for making calls. This is for advanced usage - prefer using create(IDSSettings).
Parameter | |
---|---|
Name | Description |
stub | IDSStub |
Returns | |
---|---|
Type | Description |
IDSClient |
Constructors
IDSClient(IDSSettings settings)
protected IDSClient(IDSSettings settings)
Constructs an instance of IDSClient, 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 | IDSSettings |
IDSClient(IDSStub stub)
protected IDSClient(IDSStub stub)
Parameter | |
---|---|
Name | Description |
stub | IDSStub |
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()
createEndpointAsync(CreateEndpointRequest request)
public final OperationFuture<Endpoint,OperationMetadata> createEndpointAsync(CreateEndpointRequest request)
Creates a new Endpoint 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 (IDSClient iDSClient = IDSClient.create()) {
CreateEndpointRequest request =
CreateEndpointRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setEndpointId("endpointId-1837754992")
.setEndpoint(Endpoint.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Endpoint response = iDSClient.createEndpointAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | CreateEndpointRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Endpoint,OperationMetadata> |
createEndpointAsync(LocationName parent, Endpoint endpoint, String endpointId)
public final OperationFuture<Endpoint,OperationMetadata> createEndpointAsync(LocationName parent, Endpoint endpoint, String endpointId)
Creates a new Endpoint 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 (IDSClient iDSClient = IDSClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Endpoint endpoint = Endpoint.newBuilder().build();
String endpointId = "endpointId-1837754992";
Endpoint response = iDSClient.createEndpointAsync(parent, endpoint, endpointId).get();
}
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The endpoint's parent. |
endpoint | Endpoint Required. The endpoint to create. |
endpointId | String Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error. |
Returns | |
---|---|
Type | Description |
OperationFuture<Endpoint,OperationMetadata> |
createEndpointAsync(String parent, Endpoint endpoint, String endpointId)
public final OperationFuture<Endpoint,OperationMetadata> createEndpointAsync(String parent, Endpoint endpoint, String endpointId)
Creates a new Endpoint 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 (IDSClient iDSClient = IDSClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Endpoint endpoint = Endpoint.newBuilder().build();
String endpointId = "endpointId-1837754992";
Endpoint response = iDSClient.createEndpointAsync(parent, endpoint, endpointId).get();
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The endpoint's parent. |
endpoint | Endpoint Required. The endpoint to create. |
endpointId | String Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error. |
Returns | |
---|---|
Type | Description |
OperationFuture<Endpoint,OperationMetadata> |
createEndpointCallable()
public final UnaryCallable<CreateEndpointRequest,Operation> createEndpointCallable()
Creates a new Endpoint 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 (IDSClient iDSClient = IDSClient.create()) {
CreateEndpointRequest request =
CreateEndpointRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setEndpointId("endpointId-1837754992")
.setEndpoint(Endpoint.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = iDSClient.createEndpointCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateEndpointRequest,Operation> |
createEndpointOperationCallable()
public final OperationCallable<CreateEndpointRequest,Endpoint,OperationMetadata> createEndpointOperationCallable()
Creates a new Endpoint 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 (IDSClient iDSClient = IDSClient.create()) {
CreateEndpointRequest request =
CreateEndpointRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setEndpointId("endpointId-1837754992")
.setEndpoint(Endpoint.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<Endpoint, OperationMetadata> future =
iDSClient.createEndpointOperationCallable().futureCall(request);
// Do something.
Endpoint response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateEndpointRequest,Endpoint,OperationMetadata> |
deleteEndpointAsync(DeleteEndpointRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteEndpointAsync(DeleteEndpointRequest request)
Deletes a single Endpoint.
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 (IDSClient iDSClient = IDSClient.create()) {
DeleteEndpointRequest request =
DeleteEndpointRequest.newBuilder()
.setName(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.setRequestId("requestId693933066")
.build();
iDSClient.deleteEndpointAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeleteEndpointRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteEndpointAsync(EndpointName name)
public final OperationFuture<Empty,OperationMetadata> deleteEndpointAsync(EndpointName name)
Deletes a single Endpoint.
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 (IDSClient iDSClient = IDSClient.create()) {
EndpointName name = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
iDSClient.deleteEndpointAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | EndpointName Required. The name of the endpoint to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteEndpointAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteEndpointAsync(String name)
Deletes a single Endpoint.
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 (IDSClient iDSClient = IDSClient.create()) {
String name = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString();
iDSClient.deleteEndpointAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the endpoint to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteEndpointCallable()
public final UnaryCallable<DeleteEndpointRequest,Operation> deleteEndpointCallable()
Deletes a single Endpoint.
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 (IDSClient iDSClient = IDSClient.create()) {
DeleteEndpointRequest request =
DeleteEndpointRequest.newBuilder()
.setName(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = iDSClient.deleteEndpointCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteEndpointRequest,Operation> |
deleteEndpointOperationCallable()
public final OperationCallable<DeleteEndpointRequest,Empty,OperationMetadata> deleteEndpointOperationCallable()
Deletes a single Endpoint.
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 (IDSClient iDSClient = IDSClient.create()) {
DeleteEndpointRequest request =
DeleteEndpointRequest.newBuilder()
.setName(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<Empty, OperationMetadata> future =
iDSClient.deleteEndpointOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteEndpointRequest,Empty,OperationMetadata> |
getEndpoint(EndpointName name)
public final Endpoint getEndpoint(EndpointName name)
Gets details of a single Endpoint.
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 (IDSClient iDSClient = IDSClient.create()) {
EndpointName name = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
Endpoint response = iDSClient.getEndpoint(name);
}
Parameter | |
---|---|
Name | Description |
name | EndpointName Required. The name of the endpoint to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
Endpoint |
getEndpoint(GetEndpointRequest request)
public final Endpoint getEndpoint(GetEndpointRequest request)
Gets details of a single Endpoint.
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 (IDSClient iDSClient = IDSClient.create()) {
GetEndpointRequest request =
GetEndpointRequest.newBuilder()
.setName(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.build();
Endpoint response = iDSClient.getEndpoint(request);
}
Parameter | |
---|---|
Name | Description |
request | GetEndpointRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Endpoint |
getEndpoint(String name)
public final Endpoint getEndpoint(String name)
Gets details of a single Endpoint.
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 (IDSClient iDSClient = IDSClient.create()) {
String name = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString();
Endpoint response = iDSClient.getEndpoint(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the endpoint to retrieve. Format:
|
Returns | |
---|---|
Type | Description |
Endpoint |
getEndpointCallable()
public final UnaryCallable<GetEndpointRequest,Endpoint> getEndpointCallable()
Gets details of a single Endpoint.
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 (IDSClient iDSClient = IDSClient.create()) {
GetEndpointRequest request =
GetEndpointRequest.newBuilder()
.setName(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.build();
ApiFuture<Endpoint> future = iDSClient.getEndpointCallable().futureCall(request);
// Do something.
Endpoint response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetEndpointRequest,Endpoint> |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()
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 |
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 IDSSettings getSettings()
Returns | |
---|---|
Type | Description |
IDSSettings |
getStub()
public IDSStub getStub()
Returns | |
---|---|
Type | Description |
IDSStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listEndpoints(ListEndpointsRequest request)
public final IDSClient.ListEndpointsPagedResponse listEndpoints(ListEndpointsRequest request)
Lists Endpoints 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 (IDSClient iDSClient = IDSClient.create()) {
ListEndpointsRequest request =
ListEndpointsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Endpoint element : iDSClient.listEndpoints(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListEndpointsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
IDSClient.ListEndpointsPagedResponse |
listEndpoints(LocationName parent)
public final IDSClient.ListEndpointsPagedResponse listEndpoints(LocationName parent)
Lists Endpoints 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 (IDSClient iDSClient = IDSClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Endpoint element : iDSClient.listEndpoints(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | LocationName Required. The parent, which owns this collection of endpoints. |
Returns | |
---|---|
Type | Description |
IDSClient.ListEndpointsPagedResponse |
listEndpoints(String parent)
public final IDSClient.ListEndpointsPagedResponse listEndpoints(String parent)
Lists Endpoints 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 (IDSClient iDSClient = IDSClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Endpoint element : iDSClient.listEndpoints(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The parent, which owns this collection of endpoints. |
Returns | |
---|---|
Type | Description |
IDSClient.ListEndpointsPagedResponse |
listEndpointsCallable()
public final UnaryCallable<ListEndpointsRequest,ListEndpointsResponse> listEndpointsCallable()
Lists Endpoints 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 (IDSClient iDSClient = IDSClient.create()) {
ListEndpointsRequest request =
ListEndpointsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListEndpointsResponse response = iDSClient.listEndpointsCallable().call(request);
for (Endpoint element : response.getEndpointsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListEndpointsRequest,ListEndpointsResponse> |
listEndpointsPagedCallable()
public final UnaryCallable<ListEndpointsRequest,IDSClient.ListEndpointsPagedResponse> listEndpointsPagedCallable()
Lists Endpoints 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 (IDSClient iDSClient = IDSClient.create()) {
ListEndpointsRequest request =
ListEndpointsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Endpoint> future = iDSClient.listEndpointsPagedCallable().futureCall(request);
// Do something.
for (Endpoint element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListEndpointsRequest,ListEndpointsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()