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

GitHub Repository REST Documentation

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.cloud.apigateway.v1.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:

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.apigateway.v1.ApiGatewayServiceSettings Settings class to configure an instance of ApiGatewayServiceClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.cloud.apigateway.v1.Api An API that can be served by one or more Gateways.
com.google.cloud.apigateway.v1.Api.Builder An API that can be served by one or more Gateways.
com.google.cloud.apigateway.v1.ApiConfig An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.
com.google.cloud.apigateway.v1.ApiConfig.Builder An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.
com.google.cloud.apigateway.v1.ApiConfig.File A lightweight description of a file.
com.google.cloud.apigateway.v1.ApiConfig.File.Builder A lightweight description of a file.
com.google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition A gRPC service definition.
com.google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition.Builder A gRPC service definition.
com.google.cloud.apigateway.v1.ApiConfig.OpenApiDocument An OpenAPI Specification Document describing an API.
com.google.cloud.apigateway.v1.ApiConfig.OpenApiDocument.Builder An OpenAPI Specification Document describing an API.
com.google.cloud.apigateway.v1.ApiConfigName
com.google.cloud.apigateway.v1.ApiConfigName.Builder Builder for projects/{project}/locations/global/apis/{api}/configs/{api_config}.
com.google.cloud.apigateway.v1.ApiGatewayServiceClient.ListApiConfigsFixedSizeCollection
com.google.cloud.apigateway.v1.ApiGatewayServiceClient.ListApiConfigsPage
com.google.cloud.apigateway.v1.ApiGatewayServiceClient.ListApiConfigsPagedResponse
com.google.cloud.apigateway.v1.ApiGatewayServiceClient.ListApisFixedSizeCollection
com.google.cloud.apigateway.v1.ApiGatewayServiceClient.ListApisPage
com.google.cloud.apigateway.v1.ApiGatewayServiceClient.ListApisPagedResponse
com.google.cloud.apigateway.v1.ApiGatewayServiceClient.ListGatewaysFixedSizeCollection
com.google.cloud.apigateway.v1.ApiGatewayServiceClient.ListGatewaysPage
com.google.cloud.apigateway.v1.ApiGatewayServiceClient.ListGatewaysPagedResponse
com.google.cloud.apigateway.v1.ApiGatewayServiceGrpc The API Gateway Service is the interface for managing API Gateways.
com.google.cloud.apigateway.v1.ApiGatewayServiceGrpc.ApiGatewayServiceImplBase Base class for the server implementation of the service ApiGatewayService. The API Gateway Service is the interface for managing API Gateways.
com.google.cloud.apigateway.v1.ApiGatewayServiceSettings.Builder Builder for ApiGatewayServiceSettings.
com.google.cloud.apigateway.v1.ApiName
com.google.cloud.apigateway.v1.ApiName.Builder Builder for projects/{project}/locations/global/apis/{api}.
com.google.cloud.apigateway.v1.Apigateway
com.google.cloud.apigateway.v1.ApigatewayService
com.google.cloud.apigateway.v1.CreateApiConfigRequest Request message for ApiGatewayService.CreateApiConfig
com.google.cloud.apigateway.v1.CreateApiConfigRequest.Builder Request message for ApiGatewayService.CreateApiConfig
com.google.cloud.apigateway.v1.CreateApiRequest Request message for ApiGatewayService.CreateApi
com.google.cloud.apigateway.v1.CreateApiRequest.Builder Request message for ApiGatewayService.CreateApi
com.google.cloud.apigateway.v1.CreateGatewayRequest Request message for ApiGatewayService.CreateGateway
com.google.cloud.apigateway.v1.CreateGatewayRequest.Builder Request message for ApiGatewayService.CreateGateway
com.google.cloud.apigateway.v1.DeleteApiConfigRequest Request message for ApiGatewayService.DeleteApiConfig
com.google.cloud.apigateway.v1.DeleteApiConfigRequest.Builder Request message for ApiGatewayService.DeleteApiConfig
com.google.cloud.apigateway.v1.DeleteApiRequest Request message for ApiGatewayService.DeleteApi
com.google.cloud.apigateway.v1.DeleteApiRequest.Builder Request message for ApiGatewayService.DeleteApi
com.google.cloud.apigateway.v1.DeleteGatewayRequest Request message for ApiGatewayService.DeleteGateway
com.google.cloud.apigateway.v1.DeleteGatewayRequest.Builder Request message for ApiGatewayService.DeleteGateway
com.google.cloud.apigateway.v1.Gateway A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.
com.google.cloud.apigateway.v1.Gateway.Builder A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.
com.google.cloud.apigateway.v1.GatewayName
com.google.cloud.apigateway.v1.GatewayName.Builder Builder for projects/{project}/locations/{location}/gateways/{gateway}.
com.google.cloud.apigateway.v1.GetApiConfigRequest Request message for ApiGatewayService.GetApiConfig
com.google.cloud.apigateway.v1.GetApiConfigRequest.Builder Request message for ApiGatewayService.GetApiConfig
com.google.cloud.apigateway.v1.GetApiRequest Request message for ApiGatewayService.GetApi
com.google.cloud.apigateway.v1.GetApiRequest.Builder Request message for ApiGatewayService.GetApi
com.google.cloud.apigateway.v1.GetGatewayRequest Request message for ApiGatewayService.GetGateway
com.google.cloud.apigateway.v1.GetGatewayRequest.Builder Request message for ApiGatewayService.GetGateway
com.google.cloud.apigateway.v1.ListApiConfigsRequest Request message for ApiGatewayService.ListApiConfigs
com.google.cloud.apigateway.v1.ListApiConfigsRequest.Builder Request message for ApiGatewayService.ListApiConfigs
com.google.cloud.apigateway.v1.ListApiConfigsResponse Response message for ApiGatewayService.ListApiConfigs
com.google.cloud.apigateway.v1.ListApiConfigsResponse.Builder Response message for ApiGatewayService.ListApiConfigs
com.google.cloud.apigateway.v1.ListApisRequest Request message for ApiGatewayService.ListApis
com.google.cloud.apigateway.v1.ListApisRequest.Builder Request message for ApiGatewayService.ListApis
com.google.cloud.apigateway.v1.ListApisResponse Response message for ApiGatewayService.ListApis
com.google.cloud.apigateway.v1.ListApisResponse.Builder Response message for ApiGatewayService.ListApis
com.google.cloud.apigateway.v1.ListGatewaysRequest Request message for ApiGatewayService.ListGateways
com.google.cloud.apigateway.v1.ListGatewaysRequest.Builder Request message for ApiGatewayService.ListGateways
com.google.cloud.apigateway.v1.ListGatewaysResponse Response message for ApiGatewayService.ListGateways
com.google.cloud.apigateway.v1.ListGatewaysResponse.Builder Response message for ApiGatewayService.ListGateways
com.google.cloud.apigateway.v1.LocationName
com.google.cloud.apigateway.v1.LocationName.Builder Builder for projects/{project}/locations/{location}.
com.google.cloud.apigateway.v1.OperationMetadata Represents the metadata of the long-running operation.
com.google.cloud.apigateway.v1.OperationMetadata.Builder Represents the metadata of the long-running operation.
com.google.cloud.apigateway.v1.OperationMetadata.Diagnostic Diagnostic information from configuration processing.
com.google.cloud.apigateway.v1.OperationMetadata.Diagnostic.Builder Diagnostic information from configuration processing.
com.google.cloud.apigateway.v1.UpdateApiConfigRequest Request message for ApiGatewayService.UpdateApiConfig
com.google.cloud.apigateway.v1.UpdateApiConfigRequest.Builder Request message for ApiGatewayService.UpdateApiConfig
com.google.cloud.apigateway.v1.UpdateApiRequest Request message for ApiGatewayService.UpdateApi
com.google.cloud.apigateway.v1.UpdateApiRequest.Builder Request message for ApiGatewayService.UpdateApi
com.google.cloud.apigateway.v1.UpdateGatewayRequest Request message for ApiGatewayService.UpdateGateway
com.google.cloud.apigateway.v1.UpdateGatewayRequest.Builder Request message for ApiGatewayService.UpdateGateway

Interfaces

Interface Description
com.google.cloud.apigateway.v1.ApiConfig.FileOrBuilder
com.google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinitionOrBuilder
com.google.cloud.apigateway.v1.ApiConfig.OpenApiDocumentOrBuilder
com.google.cloud.apigateway.v1.ApiConfigOrBuilder
com.google.cloud.apigateway.v1.ApiGatewayServiceGrpc.AsyncService The API Gateway Service is the interface for managing API Gateways.
com.google.cloud.apigateway.v1.ApiOrBuilder
com.google.cloud.apigateway.v1.CreateApiConfigRequestOrBuilder
com.google.cloud.apigateway.v1.CreateApiRequestOrBuilder
com.google.cloud.apigateway.v1.CreateGatewayRequestOrBuilder
com.google.cloud.apigateway.v1.DeleteApiConfigRequestOrBuilder
com.google.cloud.apigateway.v1.DeleteApiRequestOrBuilder
com.google.cloud.apigateway.v1.DeleteGatewayRequestOrBuilder
com.google.cloud.apigateway.v1.GatewayOrBuilder
com.google.cloud.apigateway.v1.GetApiConfigRequestOrBuilder
com.google.cloud.apigateway.v1.GetApiRequestOrBuilder
com.google.cloud.apigateway.v1.GetGatewayRequestOrBuilder
com.google.cloud.apigateway.v1.ListApiConfigsRequestOrBuilder
com.google.cloud.apigateway.v1.ListApiConfigsResponseOrBuilder
com.google.cloud.apigateway.v1.ListApisRequestOrBuilder
com.google.cloud.apigateway.v1.ListApisResponseOrBuilder
com.google.cloud.apigateway.v1.ListGatewaysRequestOrBuilder
com.google.cloud.apigateway.v1.ListGatewaysResponseOrBuilder
com.google.cloud.apigateway.v1.OperationMetadata.DiagnosticOrBuilder
com.google.cloud.apigateway.v1.OperationMetadataOrBuilder
com.google.cloud.apigateway.v1.UpdateApiConfigRequestOrBuilder
com.google.cloud.apigateway.v1.UpdateApiRequestOrBuilder
com.google.cloud.apigateway.v1.UpdateGatewayRequestOrBuilder

Enums

Enum Description
com.google.cloud.apigateway.v1.Api.State All the possible API states.
com.google.cloud.apigateway.v1.ApiConfig.State All the possible API Config states.
com.google.cloud.apigateway.v1.Gateway.State All the possible Gateway states.
com.google.cloud.apigateway.v1.GetApiConfigRequest.ConfigView Enum to control which fields should be included in the response.