Package com.google.cloud.apihub.v1
Class ApiHubSettings
@Generated("by gapic-generator-java")
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic final ApiHubSettingscreate(ApiHubStubSettings stub) Returns the object with the settings used for calls to createApi.Returns the object with the settings used for calls to createApi.Returns the object with the settings used for calls to createAttribute.Returns the object with the settings used for calls to createDeployment.Returns the object with the settings used for calls to createExternalApi.Returns the object with the settings used for calls to createSpec.Returns the object with the settings used for calls to createVersion.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default ChannelProvider for this service.static TransportChannelProviderUnaryCallSettings<DeleteApiOperationRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteApi.UnaryCallSettings<DeleteApiRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteApi.UnaryCallSettings<DeleteAttributeRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteAttribute.UnaryCallSettings<DeleteDeploymentRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteDeployment.UnaryCallSettings<DeleteExternalApiRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteExternalApi.UnaryCallSettings<DeleteSpecRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteSpec.UnaryCallSettings<DeleteVersionRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteVersion.Returns the object with the settings used for calls to getApi.Returns the object with the settings used for calls to getApi.Returns the object with the settings used for calls to getAttribute.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getDefinition.Returns the object with the settings used for calls to getDeployment.Returns the object with the settings used for calls to getExternalApi.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getSpecContents.Returns the object with the settings used for calls to getSpec.Returns the object with the settings used for calls to getVersion.PagedCallSettings<ListApiOperationsRequest,ListApiOperationsResponse, ApiHubClient.ListApiOperationsPagedResponse> Returns the object with the settings used for calls to listApiOperations.Returns the object with the settings used for calls to listApis.PagedCallSettings<ListAttributesRequest,ListAttributesResponse, ApiHubClient.ListAttributesPagedResponse> Returns the object with the settings used for calls to listAttributes.PagedCallSettings<ListDeploymentsRequest,ListDeploymentsResponse, ApiHubClient.ListDeploymentsPagedResponse> Returns the object with the settings used for calls to listDeployments.PagedCallSettings<ListExternalApisRequest,ListExternalApisResponse, ApiHubClient.ListExternalApisPagedResponse> Returns the object with the settings used for calls to listExternalApis.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, ApiHubClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns the object with the settings used for calls to listSpecs.Returns the object with the settings used for calls to listVersions.static ApiHubSettings.BuilderReturns a new builder for this class.static ApiHubSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.PagedCallSettings<SearchResourcesRequest,SearchResourcesResponse, ApiHubClient.SearchResourcesPagedResponse> Returns the object with the settings used for calls to searchResources.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateApi.Returns the object with the settings used for calls to updateApi.Returns the object with the settings used for calls to updateAttribute.Returns the object with the settings used for calls to updateDeployment.Returns the object with the settings used for calls to updateExternalApi.Returns the object with the settings used for calls to updateSpec.Returns the object with the settings used for calls to updateVersion.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
ApiHubSettings
- Throws:
IOException
-
-
Method Details
-
createApiSettings
Returns the object with the settings used for calls to createApi. -
getApiSettings
Returns the object with the settings used for calls to getApi. -
listApisSettings
public PagedCallSettings<ListApisRequest,ListApisResponse, listApisSettings()ApiHubClient.ListApisPagedResponse> Returns the object with the settings used for calls to listApis. -
updateApiSettings
Returns the object with the settings used for calls to updateApi. -
deleteApiSettings
Returns the object with the settings used for calls to deleteApi. -
createVersionSettings
Returns the object with the settings used for calls to createVersion. -
getVersionSettings
Returns the object with the settings used for calls to getVersion. -
listVersionsSettings
public PagedCallSettings<ListVersionsRequest,ListVersionsResponse, listVersionsSettings()ApiHubClient.ListVersionsPagedResponse> Returns the object with the settings used for calls to listVersions. -
updateVersionSettings
Returns the object with the settings used for calls to updateVersion. -
deleteVersionSettings
Returns the object with the settings used for calls to deleteVersion. -
createSpecSettings
Returns the object with the settings used for calls to createSpec. -
getSpecSettings
Returns the object with the settings used for calls to getSpec. -
getSpecContentsSettings
Returns the object with the settings used for calls to getSpecContents. -
listSpecsSettings
public PagedCallSettings<ListSpecsRequest,ListSpecsResponse, listSpecsSettings()ApiHubClient.ListSpecsPagedResponse> Returns the object with the settings used for calls to listSpecs. -
updateSpecSettings
Returns the object with the settings used for calls to updateSpec. -
deleteSpecSettings
Returns the object with the settings used for calls to deleteSpec. -
createApiOperationSettings
Returns the object with the settings used for calls to createApi. -
getApiOperationSettings
Returns the object with the settings used for calls to getApi. -
listApiOperationsSettings
public PagedCallSettings<ListApiOperationsRequest,ListApiOperationsResponse, listApiOperationsSettings()ApiHubClient.ListApiOperationsPagedResponse> Returns the object with the settings used for calls to listApiOperations. -
updateApiOperationSettings
Returns the object with the settings used for calls to updateApi. -
deleteApiOperationSettings
public UnaryCallSettings<DeleteApiOperationRequest,com.google.protobuf.Empty> deleteApiOperationSettings()Returns the object with the settings used for calls to deleteApi. -
getDefinitionSettings
Returns the object with the settings used for calls to getDefinition. -
createDeploymentSettings
Returns the object with the settings used for calls to createDeployment. -
getDeploymentSettings
Returns the object with the settings used for calls to getDeployment. -
listDeploymentsSettings
public PagedCallSettings<ListDeploymentsRequest,ListDeploymentsResponse, listDeploymentsSettings()ApiHubClient.ListDeploymentsPagedResponse> Returns the object with the settings used for calls to listDeployments. -
updateDeploymentSettings
Returns the object with the settings used for calls to updateDeployment. -
deleteDeploymentSettings
public UnaryCallSettings<DeleteDeploymentRequest,com.google.protobuf.Empty> deleteDeploymentSettings()Returns the object with the settings used for calls to deleteDeployment. -
createAttributeSettings
Returns the object with the settings used for calls to createAttribute. -
getAttributeSettings
Returns the object with the settings used for calls to getAttribute. -
updateAttributeSettings
Returns the object with the settings used for calls to updateAttribute. -
deleteAttributeSettings
public UnaryCallSettings<DeleteAttributeRequest,com.google.protobuf.Empty> deleteAttributeSettings()Returns the object with the settings used for calls to deleteAttribute. -
listAttributesSettings
public PagedCallSettings<ListAttributesRequest,ListAttributesResponse, listAttributesSettings()ApiHubClient.ListAttributesPagedResponse> Returns the object with the settings used for calls to listAttributes. -
searchResourcesSettings
public PagedCallSettings<SearchResourcesRequest,SearchResourcesResponse, searchResourcesSettings()ApiHubClient.SearchResourcesPagedResponse> Returns the object with the settings used for calls to searchResources. -
createExternalApiSettings
Returns the object with the settings used for calls to createExternalApi. -
getExternalApiSettings
Returns the object with the settings used for calls to getExternalApi. -
updateExternalApiSettings
Returns the object with the settings used for calls to updateExternalApi. -
deleteExternalApiSettings
public UnaryCallSettings<DeleteExternalApiRequest,com.google.protobuf.Empty> deleteExternalApiSettings()Returns the object with the settings used for calls to deleteExternalApi. -
listExternalApisSettings
public PagedCallSettings<ListExternalApisRequest,ListExternalApisResponse, listExternalApisSettings()ApiHubClient.ListExternalApisPagedResponse> Returns the object with the settings used for calls to listExternalApis. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()ApiHubClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultHttpJsonTransportProviderBuilder
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<ApiHubSettings>
-