Class ConnectionServiceClient (2.30.0)

Service Description: Service Interface for the Apigee Connect connection management APIs.

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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
   EndpointName parent = EndpointName.of("[PROJECT]", "[ENDPOINT]");
   for (Connection element : connectionServiceClient.listConnections(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Note: close() needs to be called on the ConnectionServiceClient 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 ConnectionServiceSettings 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
 ConnectionServiceSettings connectionServiceSettings =
     ConnectionServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ConnectionServiceClient connectionServiceClient =
     ConnectionServiceClient.create(connectionServiceSettings);

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
 ConnectionServiceSettings connectionServiceSettings =
     ConnectionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ConnectionServiceClient connectionServiceClient =
     ConnectionServiceClient.create(connectionServiceSettings);

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
 ConnectionServiceSettings connectionServiceSettings =
     ConnectionServiceSettings.newHttpJsonBuilder().build();
 ConnectionServiceClient connectionServiceClient =
     ConnectionServiceClient.create(connectionServiceSettings);

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

Inheritance

java.lang.Object > ConnectionServiceClient

Static Methods

create()

public static final ConnectionServiceClient create()

Constructs an instance of ConnectionServiceClient with default settings.

Returns
Type	Description
`ConnectionServiceClient`

Exceptions
Type	Description
`IOException`

create(ConnectionServiceSettings settings)

public static final ConnectionServiceClient create(ConnectionServiceSettings settings)

Constructs an instance of ConnectionServiceClient, 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`	`ConnectionServiceSettings`

Returns
Type	Description
`ConnectionServiceClient`

Exceptions
Type	Description
`IOException`

create(ConnectionServiceStub stub)

public static final ConnectionServiceClient create(ConnectionServiceStub stub)

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

Parameter
Name	Description
`stub`	`ConnectionServiceStub`

Returns
Type	Description
`ConnectionServiceClient`

Constructors

ConnectionServiceClient(ConnectionServiceSettings settings)

protected ConnectionServiceClient(ConnectionServiceSettings settings)

Constructs an instance of ConnectionServiceClient, 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`	`ConnectionServiceSettings`

ConnectionServiceClient(ConnectionServiceStub stub)

protected ConnectionServiceClient(ConnectionServiceStub stub)

Parameter
Name	Description
`stub`	`ConnectionServiceStub`

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()

getSettings()

public final ConnectionServiceSettings getSettings()

Returns
Type	Description
`ConnectionServiceSettings`

getStub()

public ConnectionServiceStub getStub()

Returns
Type	Description
`ConnectionServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listConnections(EndpointName parent)

public final ConnectionServiceClient.ListConnectionsPagedResponse listConnections(EndpointName parent)

Lists connections that are currently active for the given Apigee Connect 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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
   EndpointName parent = EndpointName.of("[PROJECT]", "[ENDPOINT]");
   for (Connection element : connectionServiceClient.listConnections(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`EndpointName` Required. Parent name of the form: `projects/{project_number or project_id}/endpoints/{endpoint}`.

Returns
Type	Description
`ConnectionServiceClient.ListConnectionsPagedResponse`

listConnections(ListConnectionsRequest request)

public final ConnectionServiceClient.ListConnectionsPagedResponse listConnections(ListConnectionsRequest request)

Lists connections that are currently active for the given Apigee Connect 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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
   ListConnectionsRequest request =
       ListConnectionsRequest.newBuilder()
           .setParent(EndpointName.of("[PROJECT]", "[ENDPOINT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Connection element : connectionServiceClient.listConnections(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListConnectionsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ConnectionServiceClient.ListConnectionsPagedResponse`

listConnections(String parent)

public final ConnectionServiceClient.ListConnectionsPagedResponse listConnections(String parent)

Lists connections that are currently active for the given Apigee Connect 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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
   String parent = EndpointName.of("[PROJECT]", "[ENDPOINT]").toString();
   for (Connection element : connectionServiceClient.listConnections(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. Parent name of the form: `projects/{project_number or project_id}/endpoints/{endpoint}`.

Returns
Type	Description
`ConnectionServiceClient.ListConnectionsPagedResponse`

listConnectionsCallable()

public final UnaryCallable<ListConnectionsRequest,ListConnectionsResponse> listConnectionsCallable()

Lists connections that are currently active for the given Apigee Connect 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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
   ListConnectionsRequest request =
       ListConnectionsRequest.newBuilder()
           .setParent(EndpointName.of("[PROJECT]", "[ENDPOINT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListConnectionsResponse response =
         connectionServiceClient.listConnectionsCallable().call(request);
     for (Connection element : response.getConnectionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListConnectionsRequest,ListConnectionsResponse>`

listConnectionsPagedCallable()

public final UnaryCallable<ListConnectionsRequest,ConnectionServiceClient.ListConnectionsPagedResponse> listConnectionsPagedCallable()

Lists connections that are currently active for the given Apigee Connect 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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
   ListConnectionsRequest request =
       ListConnectionsRequest.newBuilder()
           .setParent(EndpointName.of("[PROJECT]", "[ENDPOINT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Connection> future =
       connectionServiceClient.listConnectionsPagedCallable().futureCall(request);
   // Do something.
   for (Connection element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListConnectionsRequest,ListConnectionsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()