Class ApiGatewayServiceSettings (2.53.0)

Version latest

• 2.53.0 (latest)
• 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 RetrySettings of getGateway:

 // 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.Builder apiGatewayServiceSettingsBuilder =
     ApiGatewayServiceSettings.newBuilder();
 apiGatewayServiceSettingsBuilder
     .getGatewaySettings()
     .setRetrySettings(
         apiGatewayServiceSettingsBuilder
             .getGatewaySettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 ApiGatewayServiceSettings apiGatewayServiceSettings = apiGatewayServiceSettingsBuilder.build();
 

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createGateway:

 // 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.Builder apiGatewayServiceSettingsBuilder =
     ApiGatewayServiceSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 apiGatewayServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > ClientSettings > ApiGatewayServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(ApiGatewayServiceStubSettings stub)

public static final ApiGatewayServiceSettings create(ApiGatewayServiceStubSettings stub)

Parameter
Name	Description
stub	ApiGatewayServiceStubSettings

Returns
Type	Description
ApiGatewayServiceSettings

Exceptions
Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
List<String>

newBuilder()

public static ApiGatewayServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
ApiGatewayServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static ApiGatewayServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
ApiGatewayServiceSettings.Builder

newHttpJsonBuilder()

public static ApiGatewayServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
ApiGatewayServiceSettings.Builder

Constructors

ApiGatewayServiceSettings(ApiGatewayServiceSettings.Builder settingsBuilder)

protected ApiGatewayServiceSettings(ApiGatewayServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	ApiGatewayServiceSettings.Builder

Methods

createApiConfigOperationSettings()

public OperationCallSettings<CreateApiConfigRequest,ApiConfig,OperationMetadata> createApiConfigOperationSettings()

Returns the object with the settings used for calls to createApiConfig.

Returns
Type	Description
OperationCallSettings<CreateApiConfigRequest,ApiConfig,OperationMetadata>

createApiConfigSettings()

public UnaryCallSettings<CreateApiConfigRequest,Operation> createApiConfigSettings()

Returns the object with the settings used for calls to createApiConfig.

Returns
Type	Description
UnaryCallSettings<CreateApiConfigRequest,Operation>

createApiOperationSettings()

public OperationCallSettings<CreateApiRequest,Api,OperationMetadata> createApiOperationSettings()

Returns the object with the settings used for calls to createApi.

Returns
Type	Description
OperationCallSettings<CreateApiRequest,Api,OperationMetadata>

createApiSettings()

public UnaryCallSettings<CreateApiRequest,Operation> createApiSettings()

Returns the object with the settings used for calls to createApi.

Returns
Type	Description
UnaryCallSettings<CreateApiRequest,Operation>

createGatewayOperationSettings()

public OperationCallSettings<CreateGatewayRequest,Gateway,OperationMetadata> createGatewayOperationSettings()

Returns the object with the settings used for calls to createGateway.

Returns
Type	Description
OperationCallSettings<CreateGatewayRequest,Gateway,OperationMetadata>

createGatewaySettings()

public UnaryCallSettings<CreateGatewayRequest,Operation> createGatewaySettings()

Returns the object with the settings used for calls to createGateway.

Returns
Type	Description
UnaryCallSettings<CreateGatewayRequest,Operation>

deleteApiConfigOperationSettings()

public OperationCallSettings<DeleteApiConfigRequest,Empty,OperationMetadata> deleteApiConfigOperationSettings()

Returns the object with the settings used for calls to deleteApiConfig.

Returns
Type	Description
OperationCallSettings<DeleteApiConfigRequest,Empty,OperationMetadata>

deleteApiConfigSettings()

public UnaryCallSettings<DeleteApiConfigRequest,Operation> deleteApiConfigSettings()

Returns the object with the settings used for calls to deleteApiConfig.

Returns
Type	Description
UnaryCallSettings<DeleteApiConfigRequest,Operation>

deleteApiOperationSettings()

public OperationCallSettings<DeleteApiRequest,Empty,OperationMetadata> deleteApiOperationSettings()

Returns the object with the settings used for calls to deleteApi.

Returns
Type	Description
OperationCallSettings<DeleteApiRequest,Empty,OperationMetadata>

deleteApiSettings()

public UnaryCallSettings<DeleteApiRequest,Operation> deleteApiSettings()

Returns the object with the settings used for calls to deleteApi.

Returns
Type	Description
UnaryCallSettings<DeleteApiRequest,Operation>

deleteGatewayOperationSettings()

public OperationCallSettings<DeleteGatewayRequest,Empty,OperationMetadata> deleteGatewayOperationSettings()

Returns the object with the settings used for calls to deleteGateway.

Returns
Type	Description
OperationCallSettings<DeleteGatewayRequest,Empty,OperationMetadata>

deleteGatewaySettings()

public UnaryCallSettings<DeleteGatewayRequest,Operation> deleteGatewaySettings()

Returns the object with the settings used for calls to deleteGateway.

Returns
Type	Description
UnaryCallSettings<DeleteGatewayRequest,Operation>

getApiConfigSettings()

public UnaryCallSettings<GetApiConfigRequest,ApiConfig> getApiConfigSettings()

Returns the object with the settings used for calls to getApiConfig.

Returns
Type	Description
UnaryCallSettings<GetApiConfigRequest,ApiConfig>

getApiSettings()

public UnaryCallSettings<GetApiRequest,Api> getApiSettings()

Returns the object with the settings used for calls to getApi.

Returns
Type	Description
UnaryCallSettings<GetApiRequest,Api>

getGatewaySettings()

public UnaryCallSettings<GetGatewayRequest,Gateway> getGatewaySettings()

Returns the object with the settings used for calls to getGateway.

Returns
Type	Description
UnaryCallSettings<GetGatewayRequest,Gateway>

listApiConfigsSettings()

public PagedCallSettings<ListApiConfigsRequest,ListApiConfigsResponse,ApiGatewayServiceClient.ListApiConfigsPagedResponse> listApiConfigsSettings()

Returns the object with the settings used for calls to listApiConfigs.

Returns
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.

Returns
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.

Returns
Type	Description
PagedCallSettings<ListGatewaysRequest,ListGatewaysResponse,ListGatewaysPagedResponse>

toBuilder()

public ApiGatewayServiceSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type	Description
ApiGatewayServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateApiConfigOperationSettings()

public OperationCallSettings<UpdateApiConfigRequest,ApiConfig,OperationMetadata> updateApiConfigOperationSettings()

Returns the object with the settings used for calls to updateApiConfig.

Returns
Type	Description
OperationCallSettings<UpdateApiConfigRequest,ApiConfig,OperationMetadata>

updateApiConfigSettings()

public UnaryCallSettings<UpdateApiConfigRequest,Operation> updateApiConfigSettings()

Returns the object with the settings used for calls to updateApiConfig.

Returns
Type	Description
UnaryCallSettings<UpdateApiConfigRequest,Operation>

updateApiOperationSettings()

public OperationCallSettings<UpdateApiRequest,Api,OperationMetadata> updateApiOperationSettings()

Returns the object with the settings used for calls to updateApi.

Returns
Type	Description
OperationCallSettings<UpdateApiRequest,Api,OperationMetadata>

updateApiSettings()

public UnaryCallSettings<UpdateApiRequest,Operation> updateApiSettings()

Returns the object with the settings used for calls to updateApi.

Returns
Type	Description
UnaryCallSettings<UpdateApiRequest,Operation>

updateGatewayOperationSettings()

public OperationCallSettings<UpdateGatewayRequest,Gateway,OperationMetadata> updateGatewayOperationSettings()

Returns the object with the settings used for calls to updateGateway.

Returns
Type	Description
OperationCallSettings<UpdateGatewayRequest,Gateway,OperationMetadata>

updateGatewaySettings()

public UnaryCallSettings<UpdateGatewayRequest,Operation> updateGatewaySettings()

Returns the object with the settings used for calls to updateGateway.

Returns
Type	Description
UnaryCallSettings<UpdateGatewayRequest,Operation>