public class ApiGatewayServiceStubSettings extends StubSettings<ApiGatewayServiceStubSettings>
Settings class to configure an instance of ApiGatewayServiceStub .
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:
// 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
ApiGatewayServiceStubSettings.Builder apiGatewayServiceSettingsBuilder =
ApiGatewayServiceStubSettings.newBuilder();
apiGatewayServiceSettingsBuilder
.getGatewaySettings()
.setRetrySettings(
apiGatewayServiceSettingsBuilder
.getGatewaySettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ApiGatewayServiceStubSettings apiGatewayServiceSettings =
apiGatewayServiceSettingsBuilder.build();
Static Methods
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Beta
The surface for customizing headers is not stable yet and may change in the future.
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.
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Beta
The surface for customizing headers is not stable yet and may change in the future.
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.
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.
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()
getDefaultEndpoint()
public static String getDefaultEndpoint()
Returns the default service endpoint.
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint()
Returns the default mTLS service endpoint.
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
newBuilder()
public static ApiGatewayServiceStubSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
newBuilder(ClientContext clientContext)
public static ApiGatewayServiceStubSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
newHttpJsonBuilder()
public static ApiGatewayServiceStubSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
Constructors
ApiGatewayServiceStubSettings(ApiGatewayServiceStubSettings.Builder settingsBuilder)
protected ApiGatewayServiceStubSettings(ApiGatewayServiceStubSettings.Builder settingsBuilder)
Methods
createApiConfigOperationSettings()
public OperationCallSettings<CreateApiConfigRequest,ApiConfig,OperationMetadata> createApiConfigOperationSettings()
Returns the object with the settings used for calls to createApiConfig.
createApiConfigSettings()
public UnaryCallSettings<CreateApiConfigRequest,Operation> createApiConfigSettings()
Returns the object with the settings used for calls to createApiConfig.
createApiOperationSettings()
public OperationCallSettings<CreateApiRequest,Api,OperationMetadata> createApiOperationSettings()
Returns the object with the settings used for calls to createApi.
createApiSettings()
public UnaryCallSettings<CreateApiRequest,Operation> createApiSettings()
Returns the object with the settings used for calls to createApi.
createGatewayOperationSettings()
public OperationCallSettings<CreateGatewayRequest,Gateway,OperationMetadata> createGatewayOperationSettings()
Returns the object with the settings used for calls to createGateway.
createGatewaySettings()
public UnaryCallSettings<CreateGatewayRequest,Operation> createGatewaySettings()
Returns the object with the settings used for calls to createGateway.
createStub()
public ApiGatewayServiceStub createStub()
deleteApiConfigOperationSettings()
public OperationCallSettings<DeleteApiConfigRequest,Empty,OperationMetadata> deleteApiConfigOperationSettings()
Returns the object with the settings used for calls to deleteApiConfig.
deleteApiConfigSettings()
public UnaryCallSettings<DeleteApiConfigRequest,Operation> deleteApiConfigSettings()
Returns the object with the settings used for calls to deleteApiConfig.
deleteApiOperationSettings()
public OperationCallSettings<DeleteApiRequest,Empty,OperationMetadata> deleteApiOperationSettings()
Returns the object with the settings used for calls to deleteApi.
deleteApiSettings()
public UnaryCallSettings<DeleteApiRequest,Operation> deleteApiSettings()
Returns the object with the settings used for calls to deleteApi.
deleteGatewayOperationSettings()
public OperationCallSettings<DeleteGatewayRequest,Empty,OperationMetadata> deleteGatewayOperationSettings()
Returns the object with the settings used for calls to deleteGateway.
deleteGatewaySettings()
public UnaryCallSettings<DeleteGatewayRequest,Operation> deleteGatewaySettings()
Returns the object with the settings used for calls to deleteGateway.
getApiConfigSettings()
public UnaryCallSettings<GetApiConfigRequest,ApiConfig> getApiConfigSettings()
Returns the object with the settings used for calls to getApiConfig.
getApiSettings()
public UnaryCallSettings<GetApiRequest,Api> getApiSettings()
Returns the object with the settings used for calls to getApi.
getEndpoint()
public String getEndpoint()
Returns the endpoint set by the user or the the service's default endpoint.
Overrides
getGatewaySettings()
public UnaryCallSettings<GetGatewayRequest,Gateway> getGatewaySettings()
Returns the object with the settings used for calls to getGateway.
getServiceName()
public String getServiceName()
Returns the default service name.
Overrides
listApiConfigsSettings()
public PagedCallSettings<ListApiConfigsRequest,ListApiConfigsResponse,ApiGatewayServiceClient.ListApiConfigsPagedResponse> listApiConfigsSettings()
Returns the object with the settings used for calls to listApiConfigs.
listApisSettings()
public PagedCallSettings<ListApisRequest,ListApisResponse,ApiGatewayServiceClient.ListApisPagedResponse> listApisSettings()
Returns the object with the settings used for calls to listApis.
listGatewaysSettings()
public PagedCallSettings<ListGatewaysRequest,ListGatewaysResponse,ApiGatewayServiceClient.ListGatewaysPagedResponse> listGatewaysSettings()
Returns the object with the settings used for calls to listGateways.
toBuilder()
public ApiGatewayServiceStubSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
Overrides
updateApiConfigOperationSettings()
public OperationCallSettings<UpdateApiConfigRequest,ApiConfig,OperationMetadata> updateApiConfigOperationSettings()
Returns the object with the settings used for calls to updateApiConfig.
updateApiConfigSettings()
public UnaryCallSettings<UpdateApiConfigRequest,Operation> updateApiConfigSettings()
Returns the object with the settings used for calls to updateApiConfig.
updateApiOperationSettings()
public OperationCallSettings<UpdateApiRequest,Api,OperationMetadata> updateApiOperationSettings()
Returns the object with the settings used for calls to updateApi.
updateApiSettings()
public UnaryCallSettings<UpdateApiRequest,Operation> updateApiSettings()
Returns the object with the settings used for calls to updateApi.
updateGatewayOperationSettings()
public OperationCallSettings<UpdateGatewayRequest,Gateway,OperationMetadata> updateGatewayOperationSettings()
Returns the object with the settings used for calls to updateGateway.
updateGatewaySettings()
public UnaryCallSettings<UpdateGatewayRequest,Operation> updateGatewaySettings()
Returns the object with the settings used for calls to updateGateway.
