public class ApiHubSettings extends ClientSettings<ApiHubSettings>Settings class to configure an instance of ApiHubClient.
The default instance has everything set to sensible defaults:
- The default service address (apihub.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 createApi:
// 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
ApiHubSettings.Builder apiHubSettingsBuilder = ApiHubSettings.newBuilder();
apiHubSettingsBuilder
.createApiSettings()
.setRetrySettings(
apiHubSettingsBuilder
.createApiSettings()
.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());
ApiHubSettings apiHubSettings = apiHubSettingsBuilder.build();
Please refer to the Client Side Retry Guide for additional support in setting retries.
Static Methods
create(ApiHubStubSettings stub)
public static final ApiHubSettings create(ApiHubStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
ApiHubStubSettings |
| Returns | |
|---|---|
| Type | Description |
ApiHubSettings |
|
| 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 |
|
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default 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 ApiHubSettings.Builder newBuilder()Returns a new builder for this class.
| Returns | |
|---|---|
| Type | Description |
ApiHubSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static ApiHubSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
ApiHubSettings.Builder |
|
Constructors
ApiHubSettings(ApiHubSettings.Builder settingsBuilder)
protected ApiHubSettings(ApiHubSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
ApiHubSettings.Builder |
Methods
createApiSettings()
public UnaryCallSettings<CreateApiRequest,Api> createApiSettings()Returns the object with the settings used for calls to createApi.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateApiRequest,Api> |
|
createAttributeSettings()
public UnaryCallSettings<CreateAttributeRequest,Attribute> createAttributeSettings()Returns the object with the settings used for calls to createAttribute.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateAttributeRequest,Attribute> |
|
createDeploymentSettings()
public UnaryCallSettings<CreateDeploymentRequest,Deployment> createDeploymentSettings()Returns the object with the settings used for calls to createDeployment.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateDeploymentRequest,Deployment> |
|
createExternalApiSettings()
public UnaryCallSettings<CreateExternalApiRequest,ExternalApi> createExternalApiSettings()Returns the object with the settings used for calls to createExternalApi.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateExternalApiRequest,ExternalApi> |
|
createSpecSettings()
public UnaryCallSettings<CreateSpecRequest,Spec> createSpecSettings()Returns the object with the settings used for calls to createSpec.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateSpecRequest,Spec> |
|
createVersionSettings()
public UnaryCallSettings<CreateVersionRequest,Version> createVersionSettings()Returns the object with the settings used for calls to createVersion.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateVersionRequest,Version> |
|
deleteApiSettings()
public UnaryCallSettings<DeleteApiRequest,Empty> deleteApiSettings()Returns the object with the settings used for calls to deleteApi.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteApiRequest,Empty> |
|
deleteAttributeSettings()
public UnaryCallSettings<DeleteAttributeRequest,Empty> deleteAttributeSettings()Returns the object with the settings used for calls to deleteAttribute.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteAttributeRequest,Empty> |
|
deleteDeploymentSettings()
public UnaryCallSettings<DeleteDeploymentRequest,Empty> deleteDeploymentSettings()Returns the object with the settings used for calls to deleteDeployment.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteDeploymentRequest,Empty> |
|
deleteExternalApiSettings()
public UnaryCallSettings<DeleteExternalApiRequest,Empty> deleteExternalApiSettings()Returns the object with the settings used for calls to deleteExternalApi.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteExternalApiRequest,Empty> |
|
deleteSpecSettings()
public UnaryCallSettings<DeleteSpecRequest,Empty> deleteSpecSettings()Returns the object with the settings used for calls to deleteSpec.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteSpecRequest,Empty> |
|
deleteVersionSettings()
public UnaryCallSettings<DeleteVersionRequest,Empty> deleteVersionSettings()Returns the object with the settings used for calls to deleteVersion.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteVersionRequest,Empty> |
|
getApiOperationSettings()
public UnaryCallSettings<GetApiOperationRequest,ApiOperation> getApiOperationSettings()Returns the object with the settings used for calls to getApi.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetApiOperationRequest,ApiOperation> |
|
getApiSettings()
public UnaryCallSettings<GetApiRequest,Api> getApiSettings()Returns the object with the settings used for calls to getApi.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetApiRequest,Api> |
|
getAttributeSettings()
public UnaryCallSettings<GetAttributeRequest,Attribute> getAttributeSettings()Returns the object with the settings used for calls to getAttribute.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetAttributeRequest,Attribute> |
|
getDefinitionSettings()
public UnaryCallSettings<GetDefinitionRequest,Definition> getDefinitionSettings()Returns the object with the settings used for calls to getDefinition.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetDefinitionRequest,Definition> |
|
getDeploymentSettings()
public UnaryCallSettings<GetDeploymentRequest,Deployment> getDeploymentSettings()Returns the object with the settings used for calls to getDeployment.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetDeploymentRequest,Deployment> |
|
getExternalApiSettings()
public UnaryCallSettings<GetExternalApiRequest,ExternalApi> getExternalApiSettings()Returns the object with the settings used for calls to getExternalApi.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetExternalApiRequest,ExternalApi> |
|
getLocationSettings()
public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()Returns the object with the settings used for calls to getLocation.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
|
getSpecContentsSettings()
public UnaryCallSettings<GetSpecContentsRequest,SpecContents> getSpecContentsSettings()Returns the object with the settings used for calls to getSpecContents.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetSpecContentsRequest,SpecContents> |
|
getSpecSettings()
public UnaryCallSettings<GetSpecRequest,Spec> getSpecSettings()Returns the object with the settings used for calls to getSpec.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetSpecRequest,Spec> |
|
getVersionSettings()
public UnaryCallSettings<GetVersionRequest,Version> getVersionSettings()Returns the object with the settings used for calls to getVersion.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetVersionRequest,Version> |
|
listApiOperationsSettings()
public PagedCallSettings<ListApiOperationsRequest,ListApiOperationsResponse,ApiHubClient.ListApiOperationsPagedResponse> listApiOperationsSettings()Returns the object with the settings used for calls to listApiOperations.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListApiOperationsRequest,ListApiOperationsResponse,ListApiOperationsPagedResponse> |
|
listApisSettings()
public PagedCallSettings<ListApisRequest,ListApisResponse,ApiHubClient.ListApisPagedResponse> listApisSettings()Returns the object with the settings used for calls to listApis.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListApisRequest,ListApisResponse,ListApisPagedResponse> |
|
listAttributesSettings()
public PagedCallSettings<ListAttributesRequest,ListAttributesResponse,ApiHubClient.ListAttributesPagedResponse> listAttributesSettings()Returns the object with the settings used for calls to listAttributes.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListAttributesRequest,ListAttributesResponse,ListAttributesPagedResponse> |
|
listDeploymentsSettings()
public PagedCallSettings<ListDeploymentsRequest,ListDeploymentsResponse,ApiHubClient.ListDeploymentsPagedResponse> listDeploymentsSettings()Returns the object with the settings used for calls to listDeployments.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListDeploymentsRequest,ListDeploymentsResponse,ListDeploymentsPagedResponse> |
|
listExternalApisSettings()
public PagedCallSettings<ListExternalApisRequest,ListExternalApisResponse,ApiHubClient.ListExternalApisPagedResponse> listExternalApisSettings()Returns the object with the settings used for calls to listExternalApis.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListExternalApisRequest,ListExternalApisResponse,ListExternalApisPagedResponse> |
|
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,ApiHubClient.ListLocationsPagedResponse> listLocationsSettings()Returns the object with the settings used for calls to listLocations.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse> |
|
listSpecsSettings()
public PagedCallSettings<ListSpecsRequest,ListSpecsResponse,ApiHubClient.ListSpecsPagedResponse> listSpecsSettings()Returns the object with the settings used for calls to listSpecs.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListSpecsRequest,ListSpecsResponse,ListSpecsPagedResponse> |
|
listVersionsSettings()
public PagedCallSettings<ListVersionsRequest,ListVersionsResponse,ApiHubClient.ListVersionsPagedResponse> listVersionsSettings()Returns the object with the settings used for calls to listVersions.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListVersionsRequest,ListVersionsResponse,ListVersionsPagedResponse> |
|
searchResourcesSettings()
public PagedCallSettings<SearchResourcesRequest,SearchResourcesResponse,ApiHubClient.SearchResourcesPagedResponse> searchResourcesSettings()Returns the object with the settings used for calls to searchResources.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<SearchResourcesRequest,SearchResourcesResponse,SearchResourcesPagedResponse> |
|
toBuilder()
public ApiHubSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
ApiHubSettings.Builder |
|
updateApiSettings()
public UnaryCallSettings<UpdateApiRequest,Api> updateApiSettings()Returns the object with the settings used for calls to updateApi.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateApiRequest,Api> |
|
updateAttributeSettings()
public UnaryCallSettings<UpdateAttributeRequest,Attribute> updateAttributeSettings()Returns the object with the settings used for calls to updateAttribute.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateAttributeRequest,Attribute> |
|
updateDeploymentSettings()
public UnaryCallSettings<UpdateDeploymentRequest,Deployment> updateDeploymentSettings()Returns the object with the settings used for calls to updateDeployment.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateDeploymentRequest,Deployment> |
|
updateExternalApiSettings()
public UnaryCallSettings<UpdateExternalApiRequest,ExternalApi> updateExternalApiSettings()Returns the object with the settings used for calls to updateExternalApi.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateExternalApiRequest,ExternalApi> |
|
updateSpecSettings()
public UnaryCallSettings<UpdateSpecRequest,Spec> updateSpecSettings()Returns the object with the settings used for calls to updateSpec.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateSpecRequest,Spec> |
|
updateVersionSettings()
public UnaryCallSettings<UpdateVersionRequest,Version> updateVersionSettings()Returns the object with the settings used for calls to updateVersion.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateVersionRequest,Version> |
|