Package com.google.cloud.apigeeconnect.v1 (2.21.0)

A client to Apigee Connect API

The interfaces provided are listed below, along with usage samples.

ConnectionServiceClient

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

Sample for ConnectionServiceClient:


 // 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);
   }
 }
 

TetherClient

Service Description: Tether provides a way for the control plane to send HTTP API requests to services in data planes that runs in a remote datacenter without requiring customers to open firewalls on their runtime plane.

Sample for TetherClient:


 // 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 (TetherClient tetherClient = TetherClient.create()) {
   BidiStream<EgressResponse, EgressRequest> bidiStream = tetherClient.egressCallable().call();
   EgressResponse request =
       EgressResponse.newBuilder()
           .setId("id3355")
           .setHttpResponse(HttpResponse.newBuilder().build())
           .setStatus(Status.newBuilder().build())
           .setProject("project-309310695")
           .setTraceId("traceId-1067401920")
           .setEndpoint(TetherEndpoint.forNumber(0))
           .setName("name3373707")
           .build();
   bidiStream.send(request);
   for (EgressRequest response : bidiStream) {
     // Do something when a response is received.
   }
 }
 

Classes

Cluster

Protobuf type google.cloud.apigeeconnect.v1.Cluster

Cluster.Builder

Protobuf type google.cloud.apigeeconnect.v1.Cluster

Connection

Protobuf type google.cloud.apigeeconnect.v1.Connection

Connection.Builder

Protobuf type google.cloud.apigeeconnect.v1.Connection

ConnectionProto

ConnectionServiceClient

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:

  1. 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.
  2. 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.
  3. 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.

ConnectionServiceClient.ListConnectionsFixedSizeCollection

ConnectionServiceClient.ListConnectionsPage

ConnectionServiceClient.ListConnectionsPagedResponse

ConnectionServiceGrpc

Service Interface for the Apigee Connect connection management APIs.

ConnectionServiceGrpc.ConnectionServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service ConnectionService.

Service Interface for the Apigee Connect connection management APIs.

ConnectionServiceGrpc.ConnectionServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service ConnectionService.

Service Interface for the Apigee Connect connection management APIs.

ConnectionServiceGrpc.ConnectionServiceImplBase

Base class for the server implementation of the service ConnectionService.

Service Interface for the Apigee Connect connection management APIs.

ConnectionServiceGrpc.ConnectionServiceStub

A stub to allow clients to do asynchronous rpc calls to service ConnectionService.

Service Interface for the Apigee Connect connection management APIs.

ConnectionServiceSettings

Settings class to configure an instance of ConnectionServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (apigeeconnect.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of listConnections to 30 seconds:


 // 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.Builder connectionServiceSettingsBuilder =
     ConnectionServiceSettings.newBuilder();
 connectionServiceSettingsBuilder
     .listConnectionsSettings()
     .setRetrySettings(
         connectionServiceSettingsBuilder
             .listConnectionsSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ConnectionServiceSettings connectionServiceSettings = connectionServiceSettingsBuilder.build();
 

ConnectionServiceSettings.Builder

Builder for ConnectionServiceSettings.

EgressRequest

gRPC request payload for tether.

Protobuf type google.cloud.apigeeconnect.v1.EgressRequest

EgressRequest.Builder

gRPC request payload for tether.

Protobuf type google.cloud.apigeeconnect.v1.EgressRequest

EgressResponse

gRPC response payload for tether.

Protobuf type google.cloud.apigeeconnect.v1.EgressResponse

EgressResponse.Builder

gRPC response payload for tether.

Protobuf type google.cloud.apigeeconnect.v1.EgressResponse

EndpointName

EndpointName.Builder

Builder for projects/{project}/endpoints/{endpoint}.

The http headers.

Protobuf type google.cloud.apigeeconnect.v1.Header

Header.Builder

The http headers.

Protobuf type google.cloud.apigeeconnect.v1.Header

HttpRequest

The proto definition of http request.

Protobuf type google.cloud.apigeeconnect.v1.HttpRequest

HttpRequest.Builder

The proto definition of http request.

Protobuf type google.cloud.apigeeconnect.v1.HttpRequest

HttpResponse

The proto definition of http response.

Protobuf type google.cloud.apigeeconnect.v1.HttpResponse

HttpResponse.Builder

The proto definition of http response.

Protobuf type google.cloud.apigeeconnect.v1.HttpResponse

ListConnectionsRequest

The request for ListConnections.

Protobuf type google.cloud.apigeeconnect.v1.ListConnectionsRequest

ListConnectionsRequest.Builder

The request for ListConnections.

Protobuf type google.cloud.apigeeconnect.v1.ListConnectionsRequest

ListConnectionsResponse

The response for ListConnections.

Protobuf type google.cloud.apigeeconnect.v1.ListConnectionsResponse

ListConnectionsResponse.Builder

The response for ListConnections.

Protobuf type google.cloud.apigeeconnect.v1.ListConnectionsResponse

Payload

Payload for EgressRequest.

Protobuf type google.cloud.apigeeconnect.v1.Payload

Payload.Builder

Payload for EgressRequest.

Protobuf type google.cloud.apigeeconnect.v1.Payload

StreamInfo

The Information of bi-directional stream.

Protobuf type google.cloud.apigeeconnect.v1.StreamInfo

StreamInfo.Builder

The Information of bi-directional stream.

Protobuf type google.cloud.apigeeconnect.v1.StreamInfo

TetherClient

Service Description: Tether provides a way for the control plane to send HTTP API requests to services in data planes that runs in a remote datacenter without requiring customers to open firewalls on their runtime plane.

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 (TetherClient tetherClient = TetherClient.create()) {
   BidiStream<EgressResponse, EgressRequest> bidiStream = tetherClient.egressCallable().call();
   EgressResponse request =
       EgressResponse.newBuilder()
           .setId("id3355")
           .setHttpResponse(HttpResponse.newBuilder().build())
           .setStatus(Status.newBuilder().build())
           .setProject("project-309310695")
           .setTraceId("traceId-1067401920")
           .setEndpoint(TetherEndpoint.forNumber(0))
           .setName("name3373707")
           .build();
   bidiStream.send(request);
   for (EgressRequest response : bidiStream) {
     // Do something when a response is received.
   }
 }
 

Note: close() needs to be called on the TetherClient 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:

  1. 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.
  2. 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.
  3. 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 TetherSettings 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
 TetherSettings tetherSettings =
     TetherSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TetherClient tetherClient = TetherClient.create(tetherSettings);
 

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
 TetherSettings tetherSettings = TetherSettings.newBuilder().setEndpoint(myEndpoint).build();
 TetherClient tetherClient = TetherClient.create(tetherSettings);
 

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

TetherGrpc

Tether provides a way for the control plane to send HTTP API requests to services in data planes that runs in a remote datacenter without requiring customers to open firewalls on their runtime plane.

TetherGrpc.TetherBlockingStub

A stub to allow clients to do synchronous rpc calls to service Tether.

Tether provides a way for the control plane to send HTTP API requests to services in data planes that runs in a remote datacenter without requiring customers to open firewalls on their runtime plane.

TetherGrpc.TetherFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Tether.

Tether provides a way for the control plane to send HTTP API requests to services in data planes that runs in a remote datacenter without requiring customers to open firewalls on their runtime plane.

TetherGrpc.TetherImplBase

Base class for the server implementation of the service Tether.

Tether provides a way for the control plane to send HTTP API requests to services in data planes that runs in a remote datacenter without requiring customers to open firewalls on their runtime plane.

TetherGrpc.TetherStub

A stub to allow clients to do asynchronous rpc calls to service Tether.

Tether provides a way for the control plane to send HTTP API requests to services in data planes that runs in a remote datacenter without requiring customers to open firewalls on their runtime plane.

TetherProto

TetherSettings

Settings class to configure an instance of TetherClient.

The default instance has everything set to sensible defaults:

  • The default service address (apigeeconnect.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of egress to 30 seconds:


 // 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
 TetherSettings.Builder tetherSettingsBuilder = TetherSettings.newBuilder();
 tetherSettingsBuilder
     .egressSettings()
     .setRetrySettings(
         tetherSettingsBuilder
             .egressSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TetherSettings tetherSettings = tetherSettingsBuilder.build();
 

TetherSettings.Builder

Builder for TetherSettings.

Url

The proto definition of url. A url represents a URL and the general form represented is:

scheme://[path]

Protobuf type google.cloud.apigeeconnect.v1.Url

Url.Builder

The proto definition of url. A url represents a URL and the general form represented is:

scheme://[path]

Protobuf type google.cloud.apigeeconnect.v1.Url

Interfaces

ClusterOrBuilder

ConnectionOrBuilder

ConnectionServiceGrpc.AsyncService

Service Interface for the Apigee Connect connection management APIs.

EgressRequestOrBuilder

EgressResponseOrBuilder

HeaderOrBuilder

HttpRequestOrBuilder

HttpResponseOrBuilder

ListConnectionsRequestOrBuilder

ListConnectionsResponseOrBuilder

PayloadOrBuilder

StreamInfoOrBuilder

TetherGrpc.AsyncService

Tether provides a way for the control plane to send HTTP API requests to services in data planes that runs in a remote datacenter without requiring customers to open firewalls on their runtime plane.

UrlOrBuilder

Enums

Action

The action taken by agent.

Protobuf enum google.cloud.apigeeconnect.v1.Action

Payload.KindCase

Scheme

HTTP Scheme.

Protobuf enum google.cloud.apigeeconnect.v1.Scheme

TetherEndpoint

Endpoint indicates where the messages will be delivered.

Protobuf enum google.cloud.apigeeconnect.v1.TetherEndpoint