Class IDSClient
- java.lang.Object
-
- com.google.cloud.ids.v1.IDSClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class IDSClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: The IDS ServiceThis 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IDSClient.ListEndpointsFixedSizeCollection
static class
IDSClient.ListEndpointsPage
static class
IDSClient.ListEndpointsPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
IDSClient(IDSSettings settings)
Constructs an instance of IDSClient, using the given settings.protected
IDSClient(IDSStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static IDSClient
create()
Constructs an instance of IDSClient with default settings.static IDSClient
create(IDSSettings settings)
Constructs an instance of IDSClient, using the given settings.static IDSClient
create(IDSStub stub)
Constructs an instance of IDSClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<Endpoint,OperationMetadata>
createEndpointAsync(CreateEndpointRequest request)
Creates a new Endpoint in a given project and location.com.google.api.gax.longrunning.OperationFuture<Endpoint,OperationMetadata>
createEndpointAsync(LocationName parent, Endpoint endpoint, String endpointId)
Creates a new Endpoint in a given project and location.com.google.api.gax.longrunning.OperationFuture<Endpoint,OperationMetadata>
createEndpointAsync(String parent, Endpoint endpoint, String endpointId)
Creates a new Endpoint in a given project and location.com.google.api.gax.rpc.UnaryCallable<CreateEndpointRequest,com.google.longrunning.Operation>
createEndpointCallable()
Creates a new Endpoint in a given project and location.com.google.api.gax.rpc.OperationCallable<CreateEndpointRequest,Endpoint,OperationMetadata>
createEndpointOperationCallable()
Creates a new Endpoint in a given project and location.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteEndpointAsync(DeleteEndpointRequest request)
Deletes a single Endpoint.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteEndpointAsync(EndpointName name)
Deletes a single Endpoint.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteEndpointAsync(String name)
Deletes a single Endpoint.com.google.api.gax.rpc.UnaryCallable<DeleteEndpointRequest,com.google.longrunning.Operation>
deleteEndpointCallable()
Deletes a single Endpoint.com.google.api.gax.rpc.OperationCallable<DeleteEndpointRequest,com.google.protobuf.Empty,OperationMetadata>
deleteEndpointOperationCallable()
Deletes a single Endpoint.Endpoint
getEndpoint(EndpointName name)
Gets details of a single Endpoint.Endpoint
getEndpoint(GetEndpointRequest request)
Gets details of a single Endpoint.Endpoint
getEndpoint(String name)
Gets details of a single Endpoint.com.google.api.gax.rpc.UnaryCallable<GetEndpointRequest,Endpoint>
getEndpointCallable()
Gets details of a single Endpoint.com.google.api.gax.httpjson.longrunning.OperationsClient
getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.com.google.longrunning.OperationsClient
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.IDSSettings
getSettings()
IDSStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
IDSClient.ListEndpointsPagedResponse
listEndpoints(ListEndpointsRequest request)
Lists Endpoints in a given project and location.IDSClient.ListEndpointsPagedResponse
listEndpoints(LocationName parent)
Lists Endpoints in a given project and location.IDSClient.ListEndpointsPagedResponse
listEndpoints(String parent)
Lists Endpoints in a given project and location.com.google.api.gax.rpc.UnaryCallable<ListEndpointsRequest,ListEndpointsResponse>
listEndpointsCallable()
Lists Endpoints in a given project and location.com.google.api.gax.rpc.UnaryCallable<ListEndpointsRequest,IDSClient.ListEndpointsPagedResponse>
listEndpointsPagedCallable()
Lists Endpoints in a given project and location.void
shutdown()
void
shutdownNow()
-
-
-
Constructor Detail
-
IDSClient
protected IDSClient(IDSSettings settings) throws IOException
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.- Throws:
IOException
-
IDSClient
protected IDSClient(IDSStub stub)
-
-
Method Detail
-
create
public static final IDSClient create() throws IOException
Constructs an instance of IDSClient with default settings.- Throws:
IOException
-
create
public static final IDSClient create(IDSSettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final IDSSettings getSettings()
-
getStub
public IDSStub getStub()
-
getOperationsClient
public final com.google.longrunning.OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
getHttpJsonOperationsClient
@BetaApi public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
listEndpoints
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); } }
- Parameters:
parent
- Required. The parent, which owns this collection of endpoints.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listEndpoints
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); } }
- Parameters:
parent
- Required. The parent, which owns this collection of endpoints.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listEndpoints
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listEndpointsPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listEndpointsCallable
public final com.google.api.gax.rpc.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; } } }
-
getEndpoint
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); }
- Parameters:
name
- Required. The name of the endpoint to retrieve. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getEndpoint
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); }
- Parameters:
name
- Required. The name of the endpoint to retrieve. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getEndpoint
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getEndpointCallable
public final com.google.api.gax.rpc.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(); }
-
createEndpointAsync
public final com.google.api.gax.longrunning.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:
parent
- Required. The endpoint's parent.endpoint
- Required. The endpoint to create.endpointId
- 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.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createEndpointAsync
public final com.google.api.gax.longrunning.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:
parent
- Required. The endpoint's parent.endpoint
- Required. The endpoint to create.endpointId
- 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.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createEndpointAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createEndpointOperationCallable
public final com.google.api.gax.rpc.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(); }
-
createEndpointCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateEndpointRequest,com.google.longrunning.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(); }
-
deleteEndpointAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
name
- Required. The name of the endpoint to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteEndpointAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
name
- Required. The name of the endpoint to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteEndpointAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteEndpointOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteEndpointRequest,com.google.protobuf.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(); }
-
deleteEndpointCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteEndpointRequest,com.google.longrunning.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(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-