Class DataformStubSettings (0.54.0)

public class DataformStubSettings extends StubSettings<DataformStubSettings>

Settings class to configure an instance of DataformStub.

The default instance has everything set to sensible defaults:

The default service address (dataform.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 getRepository:


 // 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
 DataformStubSettings.Builder dataformSettingsBuilder = DataformStubSettings.newBuilder();
 dataformSettingsBuilder
     .getRepositorySettings()
     .setRetrySettings(
         dataformSettingsBuilder
             .getRepositorySettings()
             .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());
 DataformStubSettings dataformSettings = dataformSettingsBuilder.build();

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

Inheritance

java.lang.Object > StubSettings > DataformStubSettings

Inherited Members

StubSettings.getApiKey()

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.getStreamWatchdogCheckIntervalDuration()

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 DataformStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
`DataformStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static DataformStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`DataformStubSettings.Builder`

newHttpJsonBuilder()

public static DataformStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
`DataformStubSettings.Builder`

Constructors

DataformStubSettings(DataformStubSettings.Builder settingsBuilder)

protected DataformStubSettings(DataformStubSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`DataformStubSettings.Builder`

Methods

cancelWorkflowInvocationSettings()

public UnaryCallSettings<CancelWorkflowInvocationRequest,Empty> cancelWorkflowInvocationSettings()

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

Returns
Type	Description
`UnaryCallSettings<CancelWorkflowInvocationRequest,Empty>`

commitWorkspaceChangesSettings()

public UnaryCallSettings<CommitWorkspaceChangesRequest,Empty> commitWorkspaceChangesSettings()

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

Returns
Type	Description
`UnaryCallSettings<CommitWorkspaceChangesRequest,Empty>`

createCompilationResultSettings()

public UnaryCallSettings<CreateCompilationResultRequest,CompilationResult> createCompilationResultSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateCompilationResultRequest,CompilationResult>`

createRepositorySettings()

public UnaryCallSettings<CreateRepositoryRequest,Repository> createRepositorySettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateRepositoryRequest,Repository>`

createStub()

public DataformStub createStub()

Returns
Type	Description
`DataformStub`

Exceptions
Type	Description
`IOException`

createWorkflowInvocationSettings()

public UnaryCallSettings<CreateWorkflowInvocationRequest,WorkflowInvocation> createWorkflowInvocationSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateWorkflowInvocationRequest,WorkflowInvocation>`

createWorkspaceSettings()

public UnaryCallSettings<CreateWorkspaceRequest,Workspace> createWorkspaceSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateWorkspaceRequest,Workspace>`

deleteRepositorySettings()

public UnaryCallSettings<DeleteRepositoryRequest,Empty> deleteRepositorySettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteRepositoryRequest,Empty>`

deleteWorkflowInvocationSettings()

public UnaryCallSettings<DeleteWorkflowInvocationRequest,Empty> deleteWorkflowInvocationSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteWorkflowInvocationRequest,Empty>`

deleteWorkspaceSettings()

public UnaryCallSettings<DeleteWorkspaceRequest,Empty> deleteWorkspaceSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteWorkspaceRequest,Empty>`

fetchFileDiffSettings()

public UnaryCallSettings<FetchFileDiffRequest,FetchFileDiffResponse> fetchFileDiffSettings()

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

Returns
Type	Description
`UnaryCallSettings<FetchFileDiffRequest,FetchFileDiffResponse>`

fetchFileGitStatusesSettings()

public UnaryCallSettings<FetchFileGitStatusesRequest,FetchFileGitStatusesResponse> fetchFileGitStatusesSettings()

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

Returns
Type	Description
`UnaryCallSettings<FetchFileGitStatusesRequest,FetchFileGitStatusesResponse>`

fetchGitAheadBehindSettings()

public UnaryCallSettings<FetchGitAheadBehindRequest,FetchGitAheadBehindResponse> fetchGitAheadBehindSettings()

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

Returns
Type	Description
`UnaryCallSettings<FetchGitAheadBehindRequest,FetchGitAheadBehindResponse>`

fetchRemoteBranchesSettings()

public UnaryCallSettings<FetchRemoteBranchesRequest,FetchRemoteBranchesResponse> fetchRemoteBranchesSettings()

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

Returns
Type	Description
`UnaryCallSettings<FetchRemoteBranchesRequest,FetchRemoteBranchesResponse>`

getCompilationResultSettings()

public UnaryCallSettings<GetCompilationResultRequest,CompilationResult> getCompilationResultSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetCompilationResultRequest,CompilationResult>`

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

getRepositorySettings()

public UnaryCallSettings<GetRepositoryRequest,Repository> getRepositorySettings()

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

Returns
Type	Description
`UnaryCallSettings<GetRepositoryRequest,Repository>`

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getServiceName()

getWorkflowInvocationSettings()

public UnaryCallSettings<GetWorkflowInvocationRequest,WorkflowInvocation> getWorkflowInvocationSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetWorkflowInvocationRequest,WorkflowInvocation>`

getWorkspaceSettings()

public UnaryCallSettings<GetWorkspaceRequest,Workspace> getWorkspaceSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetWorkspaceRequest,Workspace>`

installNpmPackagesSettings()

public UnaryCallSettings<InstallNpmPackagesRequest,InstallNpmPackagesResponse> installNpmPackagesSettings()

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

Returns
Type	Description
`UnaryCallSettings<InstallNpmPackagesRequest,InstallNpmPackagesResponse>`

listCompilationResultsSettings()

public PagedCallSettings<ListCompilationResultsRequest,ListCompilationResultsResponse,DataformClient.ListCompilationResultsPagedResponse> listCompilationResultsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListCompilationResultsRequest,ListCompilationResultsResponse,ListCompilationResultsPagedResponse>`

listLocationsSettings()

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

listRepositoriesSettings()

public PagedCallSettings<ListRepositoriesRequest,ListRepositoriesResponse,DataformClient.ListRepositoriesPagedResponse> listRepositoriesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListRepositoriesRequest,ListRepositoriesResponse,ListRepositoriesPagedResponse>`

listWorkflowInvocationsSettings()

public PagedCallSettings<ListWorkflowInvocationsRequest,ListWorkflowInvocationsResponse,DataformClient.ListWorkflowInvocationsPagedResponse> listWorkflowInvocationsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListWorkflowInvocationsRequest,ListWorkflowInvocationsResponse,ListWorkflowInvocationsPagedResponse>`

listWorkspacesSettings()

public PagedCallSettings<ListWorkspacesRequest,ListWorkspacesResponse,DataformClient.ListWorkspacesPagedResponse> listWorkspacesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListWorkspacesRequest,ListWorkspacesResponse,ListWorkspacesPagedResponse>`

makeDirectorySettings()

public UnaryCallSettings<MakeDirectoryRequest,MakeDirectoryResponse> makeDirectorySettings()

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

Returns
Type	Description
`UnaryCallSettings<MakeDirectoryRequest,MakeDirectoryResponse>`

moveDirectorySettings()

public UnaryCallSettings<MoveDirectoryRequest,MoveDirectoryResponse> moveDirectorySettings()

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

Returns
Type	Description
`UnaryCallSettings<MoveDirectoryRequest,MoveDirectoryResponse>`

moveFileSettings()

public UnaryCallSettings<MoveFileRequest,MoveFileResponse> moveFileSettings()

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

Returns
Type	Description
`UnaryCallSettings<MoveFileRequest,MoveFileResponse>`

pullGitCommitsSettings()

public UnaryCallSettings<PullGitCommitsRequest,Empty> pullGitCommitsSettings()

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

Returns
Type	Description
`UnaryCallSettings<PullGitCommitsRequest,Empty>`

pushGitCommitsSettings()

public UnaryCallSettings<PushGitCommitsRequest,Empty> pushGitCommitsSettings()

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

Returns
Type	Description
`UnaryCallSettings<PushGitCommitsRequest,Empty>`

queryCompilationResultActionsSettings()

public PagedCallSettings<QueryCompilationResultActionsRequest,QueryCompilationResultActionsResponse,DataformClient.QueryCompilationResultActionsPagedResponse> queryCompilationResultActionsSettings()

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

Returns
Type	Description
`PagedCallSettings<QueryCompilationResultActionsRequest,QueryCompilationResultActionsResponse,QueryCompilationResultActionsPagedResponse>`

queryDirectoryContentsSettings()

public PagedCallSettings<QueryDirectoryContentsRequest,QueryDirectoryContentsResponse,DataformClient.QueryDirectoryContentsPagedResponse> queryDirectoryContentsSettings()

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

Returns
Type	Description
`PagedCallSettings<QueryDirectoryContentsRequest,QueryDirectoryContentsResponse,QueryDirectoryContentsPagedResponse>`

queryWorkflowInvocationActionsSettings()

public PagedCallSettings<QueryWorkflowInvocationActionsRequest,QueryWorkflowInvocationActionsResponse,DataformClient.QueryWorkflowInvocationActionsPagedResponse> queryWorkflowInvocationActionsSettings()

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

Returns
Type	Description
`PagedCallSettings<QueryWorkflowInvocationActionsRequest,QueryWorkflowInvocationActionsResponse,QueryWorkflowInvocationActionsPagedResponse>`

readFileSettings()

public UnaryCallSettings<ReadFileRequest,ReadFileResponse> readFileSettings()

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

Returns
Type	Description
`UnaryCallSettings<ReadFileRequest,ReadFileResponse>`

removeDirectorySettings()

public UnaryCallSettings<RemoveDirectoryRequest,Empty> removeDirectorySettings()

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

Returns
Type	Description
`UnaryCallSettings<RemoveDirectoryRequest,Empty>`

removeFileSettings()

public UnaryCallSettings<RemoveFileRequest,Empty> removeFileSettings()

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

Returns
Type	Description
`UnaryCallSettings<RemoveFileRequest,Empty>`

resetWorkspaceChangesSettings()

public UnaryCallSettings<ResetWorkspaceChangesRequest,Empty> resetWorkspaceChangesSettings()

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

Returns
Type	Description
`UnaryCallSettings<ResetWorkspaceChangesRequest,Empty>`

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 DataformStubSettings.Builder toBuilder()

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

Returns
Type	Description
`DataformStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()

updateRepositorySettings()

public UnaryCallSettings<UpdateRepositoryRequest,Repository> updateRepositorySettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateRepositoryRequest,Repository>`

writeFileSettings()

public UnaryCallSettings<WriteFileRequest,WriteFileResponse> writeFileSettings()

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

Returns
Type	Description
`UnaryCallSettings<WriteFileRequest,WriteFileResponse>`