Package com.google.cloud.apigateway.v1 (2.5.0)

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

ApiGatewayServiceClient

Service Description: The API Gateway Service is the interface for managing API Gateways.

Sample for ApiGatewayServiceClient:


 // 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 (ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.create()) {
   GatewayName name = GatewayName.of("[PROJECT]", "[LOCATION]", "[GATEWAY]");
   Gateway response = apiGatewayServiceClient.getGateway(name);
 }

Classes

Api

An API that can be served by one or more Gateways.

Protobuf type google.cloud.apigateway.v1.Api

Api.Builder

An API that can be served by one or more Gateways.

Protobuf type google.cloud.apigateway.v1.Api

ApiConfig

An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.

Protobuf type google.cloud.apigateway.v1.ApiConfig

ApiConfig.Builder

An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.

Protobuf type google.cloud.apigateway.v1.ApiConfig

ApiConfig.File

A lightweight description of a file.

Protobuf type google.cloud.apigateway.v1.ApiConfig.File

ApiConfig.File.Builder

A lightweight description of a file.

Protobuf type google.cloud.apigateway.v1.ApiConfig.File

ApiConfig.GrpcServiceDefinition

A gRPC service definition.

Protobuf type google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition

ApiConfig.GrpcServiceDefinition.Builder

A gRPC service definition.

Protobuf type google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition

ApiConfig.OpenApiDocument

An OpenAPI Specification Document describing an API.

Protobuf type google.cloud.apigateway.v1.ApiConfig.OpenApiDocument

ApiConfig.OpenApiDocument.Builder

An OpenAPI Specification Document describing an API.

Protobuf type google.cloud.apigateway.v1.ApiConfig.OpenApiDocument

ApiConfigName.Builder

Builder for projects/{project}/locations/global/apis/{api}/configs/{api_config}.

ApiGatewayServiceClient

Service Description: The API Gateway Service is the interface for managing API Gateways.

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 (ApiGatewayServiceClient apiGatewayServiceClient = ApiGatewayServiceClient.create()) {
   GatewayName name = GatewayName.of("[PROJECT]", "[LOCATION]", "[GATEWAY]");
   Gateway response = apiGatewayServiceClient.getGateway(name);
 }

Note: close() needs to be called on the ApiGatewayServiceClient 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 ApiGatewayServiceSettings 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
 ApiGatewayServiceSettings apiGatewayServiceSettings =
     ApiGatewayServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ApiGatewayServiceClient apiGatewayServiceClient =
     ApiGatewayServiceClient.create(apiGatewayServiceSettings);

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
 ApiGatewayServiceSettings apiGatewayServiceSettings =
     ApiGatewayServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ApiGatewayServiceClient apiGatewayServiceClient =
     ApiGatewayServiceClient.create(apiGatewayServiceSettings);

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
 ApiGatewayServiceSettings apiGatewayServiceSettings =
     ApiGatewayServiceSettings.newBuilder()
         .setTransportChannelProvider(
             ApiGatewayServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 ApiGatewayServiceClient apiGatewayServiceClient =
     ApiGatewayServiceClient.create(apiGatewayServiceSettings);

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

ApiGatewayServiceClient.ListApiConfigsFixedSizeCollection

ApiGatewayServiceClient.ListApiConfigsPage

ApiGatewayServiceClient.ListApiConfigsPagedResponse

ApiGatewayServiceClient.ListApisFixedSizeCollection

ApiGatewayServiceClient.ListApisPage

ApiGatewayServiceClient.ListApisPagedResponse