Class DataformSettings (0.34.0) 

public class DataformSettings extends ClientSettings<DataformSettings>

Settings class to configure an instance of DataformClient.

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 total timeout of getRepository 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
 DataformSettings.Builder dataformSettingsBuilder = DataformSettings.newBuilder();
 dataformSettingsBuilder
     .getRepositorySettings()
     .setRetrySettings(
         dataformSettingsBuilder
             .getRepositorySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DataformSettings dataformSettings = dataformSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > DataformSettings

Static Methods

create(DataformStubSettings stub)

public static final DataformSettings create(DataformStubSettings stub)
Parameter
Name Description
stub DataformStubSettings
Returns
Type Description
DataformSettings
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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

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

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static DataformSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
DataformSettings.Builder

newBuilder(ClientContext clientContext)

public static DataformSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
DataformSettings.Builder

newHttpJsonBuilder()

public static DataformSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
DataformSettings.Builder

Constructors

DataformSettings(DataformSettings.Builder settingsBuilder)

protected DataformSettings(DataformSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder DataformSettings.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>

commitRepositoryChangesSettings()

public UnaryCallSettings<CommitRepositoryChangesRequest,Empty> commitRepositoryChangesSettings()

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

Returns
Type Description
UnaryCallSettings<CommitRepositoryChangesRequest,Empty>

commitWorkspaceChangesSettings()

public UnaryCallSettings<CommitWorkspaceChangesRequest,Empty> commitWorkspaceChangesSettings()

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

Returns
Type Description
UnaryCallSettings<CommitWorkspaceChangesRequest,Empty>

computeRepositoryAccessTokenStatusSettings()

public UnaryCallSettings<ComputeRepositoryAccessTokenStatusRequest,ComputeRepositoryAccessTokenStatusResponse> computeRepositoryAccessTokenStatusSettings()

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

Returns
Type Description
UnaryCallSettings<ComputeRepositoryAccessTokenStatusRequest,ComputeRepositoryAccessTokenStatusResponse>

createCompilationResultSettings()

public UnaryCallSettings<CreateCompilationResultRequest,CompilationResult> createCompilationResultSettings()

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

Returns
Type Description
UnaryCallSettings<CreateCompilationResultRequest,CompilationResult>

createReleaseConfigSettings()

public UnaryCallSettings<CreateReleaseConfigRequest,ReleaseConfig> createReleaseConfigSettings()

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

Returns
Type Description
UnaryCallSettings<CreateReleaseConfigRequest,ReleaseConfig>

createRepositorySettings()

public UnaryCallSettings<CreateRepositoryRequest,Repository> createRepositorySettings()

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

Returns
Type Description
UnaryCallSettings<CreateRepositoryRequest,Repository>

createWorkflowConfigSettings()

public UnaryCallSettings<CreateWorkflowConfigRequest,WorkflowConfig> createWorkflowConfigSettings()

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

Returns
Type Description
UnaryCallSettings<CreateWorkflowConfigRequest,WorkflowConfig>

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>

deleteReleaseConfigSettings()

public UnaryCallSettings<DeleteReleaseConfigRequest,Empty> deleteReleaseConfigSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteReleaseConfigRequest,Empty>

deleteRepositorySettings()

public UnaryCallSettings<DeleteRepositoryRequest,Empty> deleteRepositorySettings()

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

Returns
Type Description
UnaryCallSettings<DeleteRepositoryRequest,Empty>

deleteWorkflowConfigSettings()

public UnaryCallSettings<DeleteWorkflowConfigRequest,Empty> deleteWorkflowConfigSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteWorkflowConfigRequest,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>

fetchRepositoryHistorySettings()

public PagedCallSettings<FetchRepositoryHistoryRequest,FetchRepositoryHistoryResponse,DataformClient.FetchRepositoryHistoryPagedResponse> fetchRepositoryHistorySettings()

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

Returns
Type Description
PagedCallSettings<FetchRepositoryHistoryRequest,FetchRepositoryHistoryResponse,FetchRepositoryHistoryPagedResponse>

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>

getReleaseConfigSettings()

public UnaryCallSettings<GetReleaseConfigRequest,ReleaseConfig> getReleaseConfigSettings()

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

Returns
Type Description
UnaryCallSettings<GetReleaseConfigRequest,ReleaseConfig>

getRepositorySettings()

public UnaryCallSettings<GetRepositoryRequest,Repository> getRepositorySettings()

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

Returns
Type Description
UnaryCallSettings<GetRepositoryRequest,Repository>

getWorkflowConfigSettings()

public UnaryCallSettings<GetWorkflowConfigRequest,WorkflowConfig> getWorkflowConfigSettings()

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

Returns
Type Description
UnaryCallSettings<GetWorkflowConfigRequest,WorkflowConfig>

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>

listReleaseConfigsSettings()

public PagedCallSettings<ListReleaseConfigsRequest,ListReleaseConfigsResponse,DataformClient.ListReleaseConfigsPagedResponse> listReleaseConfigsSettings()

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

Returns
Type Description
PagedCallSettings<ListReleaseConfigsRequest,ListReleaseConfigsResponse,ListReleaseConfigsPagedResponse>

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>

listWorkflowConfigsSettings()

public PagedCallSettings<ListWorkflowConfigsRequest,ListWorkflowConfigsResponse,DataformClient.ListWorkflowConfigsPagedResponse> listWorkflowConfigsSettings()

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

Returns
Type Description
PagedCallSettings<ListWorkflowConfigsRequest,ListWorkflowConfigsResponse,ListWorkflowConfigsPagedResponse>

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>

queryRepositoryDirectoryContentsSettings()

public PagedCallSettings<QueryRepositoryDirectoryContentsRequest,QueryRepositoryDirectoryContentsResponse,DataformClient.QueryRepositoryDirectoryContentsPagedResponse> queryRepositoryDirectoryContentsSettings()

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

Returns
Type Description
PagedCallSettings<QueryRepositoryDirectoryContentsRequest,QueryRepositoryDirectoryContentsResponse,QueryRepositoryDirectoryContentsPagedResponse>

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>

readRepositoryFileSettings()

public UnaryCallSettings<ReadRepositoryFileRequest,ReadRepositoryFileResponse> readRepositoryFileSettings()

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

Returns
Type Description
UnaryCallSettings<ReadRepositoryFileRequest,ReadRepositoryFileResponse>

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

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

Returns
Type Description
DataformSettings.Builder
Overrides

updateReleaseConfigSettings()

public UnaryCallSettings<UpdateReleaseConfigRequest,ReleaseConfig> updateReleaseConfigSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateReleaseConfigRequest,ReleaseConfig>

updateRepositorySettings()

public UnaryCallSettings<UpdateRepositoryRequest,Repository> updateRepositorySettings()

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

Returns
Type Description
UnaryCallSettings<UpdateRepositoryRequest,Repository>

updateWorkflowConfigSettings()

public UnaryCallSettings<UpdateWorkflowConfigRequest,WorkflowConfig> updateWorkflowConfigSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateWorkflowConfigRequest,WorkflowConfig>

writeFileSettings()

public UnaryCallSettings<WriteFileRequest,WriteFileResponse> writeFileSettings()

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

Returns
Type Description
UnaryCallSettings<WriteFileRequest,WriteFileResponse>