Class ConfigStubSettings (0.16.0)

public class ConfigStubSettings extends StubSettings<ConfigStubSettings>

Settings class to configure an instance of ConfigStub.

The default instance has everything set to sensible defaults:

The default service address (config.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 getDeployment 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
 ConfigStubSettings.Builder configSettingsBuilder = ConfigStubSettings.newBuilder();
 configSettingsBuilder
     .getDeploymentSettings()
     .setRetrySettings(
         configSettingsBuilder
             .getDeploymentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ConfigStubSettings configSettings = configSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > ConfigStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

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

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`

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

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`

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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`

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 ConfigStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
`ConfigStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static ConfigStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`ConfigStubSettings.Builder`

newHttpJsonBuilder()

public static ConfigStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
`ConfigStubSettings.Builder`

Constructors

ConfigStubSettings(ConfigStubSettings.Builder settingsBuilder)

protected ConfigStubSettings(ConfigStubSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`ConfigStubSettings.Builder`

Methods

createDeploymentOperationSettings()

public OperationCallSettings<CreateDeploymentRequest,Deployment,OperationMetadata> createDeploymentOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateDeploymentRequest,Deployment,OperationMetadata>`

createDeploymentSettings()

public UnaryCallSettings<CreateDeploymentRequest,Operation> createDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateDeploymentRequest,Operation>`

createPreviewOperationSettings()

public OperationCallSettings<CreatePreviewRequest,Preview,OperationMetadata> createPreviewOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreatePreviewRequest,Preview,OperationMetadata>`

createPreviewSettings()

public UnaryCallSettings<CreatePreviewRequest,Operation> createPreviewSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreatePreviewRequest,Operation>`

createStub()

public ConfigStub createStub()

Returns
Type	Description
`ConfigStub`

Exceptions
Type	Description
`IOException`

deleteDeploymentOperationSettings()

public OperationCallSettings<DeleteDeploymentRequest,Deployment,OperationMetadata> deleteDeploymentOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteDeploymentRequest,Deployment,OperationMetadata>`

deleteDeploymentSettings()

public UnaryCallSettings<DeleteDeploymentRequest,Operation> deleteDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteDeploymentRequest,Operation>`

deletePreviewOperationSettings()

public OperationCallSettings<DeletePreviewRequest,Preview,OperationMetadata> deletePreviewOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeletePreviewRequest,Preview,OperationMetadata>`

deletePreviewSettings()

public UnaryCallSettings<DeletePreviewRequest,Operation> deletePreviewSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeletePreviewRequest,Operation>`

deleteStatefileSettings()

public UnaryCallSettings<DeleteStatefileRequest,Empty> deleteStatefileSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteStatefileRequest,Empty>`

exportDeploymentStatefileSettings()

public UnaryCallSettings<ExportDeploymentStatefileRequest,Statefile> exportDeploymentStatefileSettings()

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

Returns
Type	Description
`UnaryCallSettings<ExportDeploymentStatefileRequest,Statefile>`

exportLockInfoSettings()

public UnaryCallSettings<ExportLockInfoRequest,LockInfo> exportLockInfoSettings()

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

Returns
Type	Description
`UnaryCallSettings<ExportLockInfoRequest,LockInfo>`

exportPreviewResultSettings()

public UnaryCallSettings<ExportPreviewResultRequest,ExportPreviewResultResponse> exportPreviewResultSettings()

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

Returns
Type	Description
`UnaryCallSettings<ExportPreviewResultRequest,ExportPreviewResultResponse>`

exportRevisionStatefileSettings()

public UnaryCallSettings<ExportRevisionStatefileRequest,Statefile> exportRevisionStatefileSettings()

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

Returns
Type	Description
`UnaryCallSettings<ExportRevisionStatefileRequest,Statefile>`

getDeploymentSettings()

public UnaryCallSettings<GetDeploymentRequest,Deployment> getDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetDeploymentRequest,Deployment>`

getEndpoint()

public String getEndpoint()

Returns the endpoint set by the user or the the service's default endpoint.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getEndpoint()

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`

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>`

getPreviewSettings()

public UnaryCallSettings<GetPreviewRequest,Preview> getPreviewSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetPreviewRequest,Preview>`

getResourceSettings()

public UnaryCallSettings<GetResourceRequest,Resource> getResourceSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetResourceRequest,Resource>`

getRevisionSettings()

public UnaryCallSettings<GetRevisionRequest,Revision> getRevisionSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetRevisionRequest,Revision>`

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getServiceName()

getTerraformVersionSettings()

public UnaryCallSettings<GetTerraformVersionRequest,TerraformVersion> getTerraformVersionSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetTerraformVersionRequest,TerraformVersion>`

importStatefileSettings()

public UnaryCallSettings<ImportStatefileRequest,Statefile> importStatefileSettings()

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

Returns
Type	Description
`UnaryCallSettings<ImportStatefileRequest,Statefile>`

listDeploymentsSettings()

public PagedCallSettings<ListDeploymentsRequest,ListDeploymentsResponse,ConfigClient.ListDeploymentsPagedResponse> listDeploymentsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListDeploymentsRequest,ListDeploymentsResponse,ListDeploymentsPagedResponse>`

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,ConfigClient.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>`

listPreviewsSettings()

public PagedCallSettings<ListPreviewsRequest,ListPreviewsResponse,ConfigClient.ListPreviewsPagedResponse> listPreviewsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListPreviewsRequest,ListPreviewsResponse,ListPreviewsPagedResponse>`

listResourcesSettings()

public PagedCallSettings<ListResourcesRequest,ListResourcesResponse,ConfigClient.ListResourcesPagedResponse> listResourcesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListResourcesRequest,ListResourcesResponse,ListResourcesPagedResponse>`

listRevisionsSettings()

public PagedCallSettings<ListRevisionsRequest,ListRevisionsResponse,ConfigClient.ListRevisionsPagedResponse> listRevisionsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListRevisionsRequest,ListRevisionsResponse,ListRevisionsPagedResponse>`

listTerraformVersionsSettings()

public PagedCallSettings<ListTerraformVersionsRequest,ListTerraformVersionsResponse,ConfigClient.ListTerraformVersionsPagedResponse> listTerraformVersionsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListTerraformVersionsRequest,ListTerraformVersionsResponse,ListTerraformVersionsPagedResponse>`

lockDeploymentOperationSettings()

public OperationCallSettings<LockDeploymentRequest,Deployment,OperationMetadata> lockDeploymentOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<LockDeploymentRequest,Deployment,OperationMetadata>`

lockDeploymentSettings()

public UnaryCallSettings<LockDeploymentRequest,Operation> lockDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<LockDeploymentRequest,Operation>`

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`

toBuilder()

public ConfigStubSettings.Builder toBuilder()

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

Returns
Type	Description
`ConfigStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()

unlockDeploymentOperationSettings()

public OperationCallSettings<UnlockDeploymentRequest,Deployment,OperationMetadata> unlockDeploymentOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UnlockDeploymentRequest,Deployment,OperationMetadata>`

unlockDeploymentSettings()

public UnaryCallSettings<UnlockDeploymentRequest,Operation> unlockDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<UnlockDeploymentRequest,Operation>`

updateDeploymentOperationSettings()

public OperationCallSettings<UpdateDeploymentRequest,Deployment,OperationMetadata> updateDeploymentOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateDeploymentRequest,Deployment,OperationMetadata>`

updateDeploymentSettings()

public UnaryCallSettings<UpdateDeploymentRequest,Operation> updateDeploymentSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateDeploymentRequest,Operation>`