- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.7
- 2.2.1
- 2.1.12
public class ApiGatewayServiceSettings extends ClientSettings<ApiGatewayServiceSettings>Settings class to configure an instance of ApiGatewayServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (apigateway.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 getGateway to 30 seconds:
ApiGatewayServiceSettings.Builder apiGatewayServiceSettingsBuilder =
ApiGatewayServiceSettings.newBuilder();
apiGatewayServiceSettingsBuilder
.getGatewaySettings()
.setRetrySettings(
apiGatewayServiceSettingsBuilder
.getGatewaySettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ApiGatewayServiceSettings apiGatewayServiceSettings = apiGatewayServiceSettingsBuilder.build();
Static Methods
create(ApiGatewayServiceStubSettings stub)
public static final ApiGatewayServiceSettings create(ApiGatewayServiceStubSettings stub)| Name | Description |
| stub | ApiGatewayServiceStubSettings |
| Type | Description |
| ApiGatewayServiceSettings |
| Type | Description |
| IOException |
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Type | Description |
| Builder |
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Type | Description |
| Builder |
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Type | Description |
| Builder |
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service.
| Type | Description |
| Builder |
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Type | Description |
| TransportChannelProvider |
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Type | Description |
| String |
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Type | Description |
| List<String> |
newBuilder()
public static ApiGatewayServiceSettings.Builder newBuilder()Returns a new builder for this class.
| Type | Description |
| ApiGatewayServiceSettings.Builder |
newBuilder(ClientContext clientContext)
public static ApiGatewayServiceSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Name | Description |
| clientContext | ClientContext |
| Type | Description |
| ApiGatewayServiceSettings.Builder |
Constructors
ApiGatewayServiceSettings(ApiGatewayServiceSettings.Builder settingsBuilder)
protected ApiGatewayServiceSettings(ApiGatewayServiceSettings.Builder settingsBuilder)| Name | Description |
| settingsBuilder | ApiGatewayServiceSettings.Builder |
Methods
createApiConfigOperationSettings()
public OperationCallSettings<CreateApiConfigRequest,ApiConfig,OperationMetadata> createApiConfigOperationSettings()Returns the object with the settings used for calls to createApiConfig.
| Type | Description |
| OperationCallSettings<CreateApiConfigRequest,ApiConfig,OperationMetadata> |
createApiConfigSettings()
public UnaryCallSettings<CreateApiConfigRequest,Operation> createApiConfigSettings()Returns the object with the settings used for calls to createApiConfig.
| Type | Description |
| UnaryCallSettings<CreateApiConfigRequest,Operation> |
createApiOperationSettings()
public OperationCallSettings<CreateApiRequest,Api,OperationMetadata> createApiOperationSettings()Returns the object with the settings used for calls to createApi.
| Type | Description |
| OperationCallSettings<CreateApiRequest,Api,OperationMetadata> |
createApiSettings()
public UnaryCallSettings<CreateApiRequest,Operation> createApiSettings()Returns the object with the settings used for calls to createApi.
| Type | Description |
| UnaryCallSettings<CreateApiRequest,Operation> |
createGatewayOperationSettings()
public OperationCallSettings<CreateGatewayRequest,Gateway,OperationMetadata> createGatewayOperationSettings()Returns the object with the settings used for calls to createGateway.
| Type | Description |
| OperationCallSettings<CreateGatewayRequest,Gateway,OperationMetadata> |
createGatewaySettings()
public UnaryCallSettings<CreateGatewayRequest,Operation> createGatewaySettings()Returns the object with the settings used for calls to createGateway.
| Type | Description |
| UnaryCallSettings<CreateGatewayRequest,Operation> |
deleteApiConfigOperationSettings()
public OperationCallSettings<DeleteApiConfigRequest,Empty,OperationMetadata> deleteApiConfigOperationSettings()Returns the object with the settings used for calls to deleteApiConfig.
| Type | Description |
| OperationCallSettings<DeleteApiConfigRequest,Empty,OperationMetadata> |
deleteApiConfigSettings()
public UnaryCallSettings<DeleteApiConfigRequest,Operation> deleteApiConfigSettings()Returns the object with the settings used for calls to deleteApiConfig.
| Type | Description |
| UnaryCallSettings<DeleteApiConfigRequest,Operation> |
deleteApiOperationSettings()
public OperationCallSettings<DeleteApiRequest,Empty,OperationMetadata> deleteApiOperationSettings()Returns the object with the settings used for calls to deleteApi.
| Type | Description |
| OperationCallSettings<DeleteApiRequest,Empty,OperationMetadata> |
deleteApiSettings()
public UnaryCallSettings<DeleteApiRequest,Operation> deleteApiSettings()Returns the object with the settings used for calls to deleteApi.
| Type | Description |
| UnaryCallSettings<DeleteApiRequest,Operation> |
deleteGatewayOperationSettings()
public OperationCallSettings<DeleteGatewayRequest,Empty,OperationMetadata> deleteGatewayOperationSettings()Returns the object with the settings used for calls to deleteGateway.
| Type | Description |
| OperationCallSettings<DeleteGatewayRequest,Empty,OperationMetadata> |
deleteGatewaySettings()
public UnaryCallSettings<DeleteGatewayRequest,Operation> deleteGatewaySettings()Returns the object with the settings used for calls to deleteGateway.
| Type | Description |
| UnaryCallSettings<DeleteGatewayRequest,Operation> |
getApiConfigSettings()
public UnaryCallSettings<GetApiConfigRequest,ApiConfig> getApiConfigSettings()Returns the object with the settings used for calls to getApiConfig.
| Type | Description |
| UnaryCallSettings<GetApiConfigRequest,ApiConfig> |
getApiSettings()
public UnaryCallSettings<GetApiRequest,Api> getApiSettings()Returns the object with the settings used for calls to getApi.
| Type | Description |
| UnaryCallSettings<GetApiRequest,Api> |
getGatewaySettings()
public UnaryCallSettings<GetGatewayRequest,Gateway> getGatewaySettings()Returns the object with the settings used for calls to getGateway.
| Type | Description |
| UnaryCallSettings<GetGatewayRequest,Gateway> |
listApiConfigsSettings()
public PagedCallSettings<ListApiConfigsRequest,ListApiConfigsResponse,ApiGatewayServiceClient.ListApiConfigsPagedResponse> listApiConfigsSettings()Returns the object with the settings used for calls to listApiConfigs.
| Type | Description |
| PagedCallSettings<ListApiConfigsRequest,ListApiConfigsResponse,ListApiConfigsPagedResponse> |
listApisSettings()
public PagedCallSettings<ListApisRequest,ListApisResponse,ApiGatewayServiceClient.ListApisPagedResponse> listApisSettings()Returns the object with the settings used for calls to listApis.
| Type | Description |
| PagedCallSettings<ListApisRequest,ListApisResponse,ListApisPagedResponse> |
listGatewaysSettings()
public PagedCallSettings<ListGatewaysRequest,ListGatewaysResponse,ApiGatewayServiceClient.ListGatewaysPagedResponse> listGatewaysSettings()Returns the object with the settings used for calls to listGateways.
| Type | Description |
| PagedCallSettings<ListGatewaysRequest,ListGatewaysResponse,ListGatewaysPagedResponse> |
toBuilder()
public ApiGatewayServiceSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Type | Description |
| ApiGatewayServiceSettings.Builder |
updateApiConfigOperationSettings()
public OperationCallSettings<UpdateApiConfigRequest,ApiConfig,OperationMetadata> updateApiConfigOperationSettings()Returns the object with the settings used for calls to updateApiConfig.
| Type | Description |
| OperationCallSettings<UpdateApiConfigRequest,ApiConfig,OperationMetadata> |
updateApiConfigSettings()
public UnaryCallSettings<UpdateApiConfigRequest,Operation> updateApiConfigSettings()Returns the object with the settings used for calls to updateApiConfig.
| Type | Description |
| UnaryCallSettings<UpdateApiConfigRequest,Operation> |
updateApiOperationSettings()
public OperationCallSettings<UpdateApiRequest,Api,OperationMetadata> updateApiOperationSettings()Returns the object with the settings used for calls to updateApi.
| Type | Description |
| OperationCallSettings<UpdateApiRequest,Api,OperationMetadata> |
updateApiSettings()
public UnaryCallSettings<UpdateApiRequest,Operation> updateApiSettings()Returns the object with the settings used for calls to updateApi.
| Type | Description |
| UnaryCallSettings<UpdateApiRequest,Operation> |
updateGatewayOperationSettings()
public OperationCallSettings<UpdateGatewayRequest,Gateway,OperationMetadata> updateGatewayOperationSettings()Returns the object with the settings used for calls to updateGateway.
| Type | Description |
| OperationCallSettings<UpdateGatewayRequest,Gateway,OperationMetadata> |
updateGatewaySettings()
public UnaryCallSettings<UpdateGatewayRequest,Operation> updateGatewaySettings()Returns the object with the settings used for calls to updateGateway.
| Type | Description |
| UnaryCallSettings<UpdateGatewayRequest,Operation> |