Package com.google.cloud.dataform.v1beta1 (0.20.0)

A client to Dataform API

The interfaces provided are listed below, along with usage samples.

DataformClient

Service Description: Dataform is a service to develop, create, document, test, and update curated tables in BigQuery.

Sample for DataformClient:


 // 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
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   Repository response = dataformClient.getRepository(name);
 }

Classes

CancelWorkflowInvocationRequest

CancelWorkflowInvocation request message.

Protobuf type google.cloud.dataform.v1beta1.CancelWorkflowInvocationRequest

CancelWorkflowInvocationRequest.Builder

CancelWorkflowInvocation request message.

Protobuf type google.cloud.dataform.v1beta1.CancelWorkflowInvocationRequest

CommitAuthor

Represents the author of a Git commit.

Protobuf type google.cloud.dataform.v1beta1.CommitAuthor

CommitAuthor.Builder

Represents the author of a Git commit.

Protobuf type google.cloud.dataform.v1beta1.CommitAuthor

CommitWorkspaceChangesRequest

CommitWorkspaceChanges request message.

Protobuf type google.cloud.dataform.v1beta1.CommitWorkspaceChangesRequest

CommitWorkspaceChangesRequest.Builder

CommitWorkspaceChanges request message.

Protobuf type google.cloud.dataform.v1beta1.CommitWorkspaceChangesRequest

CompilationResult

Represents the result of compiling a Dataform project.

Protobuf type google.cloud.dataform.v1beta1.CompilationResult

CompilationResult.Builder

Represents the result of compiling a Dataform project.

Protobuf type google.cloud.dataform.v1beta1.CompilationResult

CompilationResult.CodeCompilationConfig

Configures various aspects of Dataform code compilation.

Protobuf type google.cloud.dataform.v1beta1.CompilationResult.CodeCompilationConfig

CompilationResult.CodeCompilationConfig.Builder

Configures various aspects of Dataform code compilation.

Protobuf type google.cloud.dataform.v1beta1.CompilationResult.CodeCompilationConfig

CompilationResult.CompilationError

An error encountered when attempting to compile a Dataform project.

Protobuf type google.cloud.dataform.v1beta1.CompilationResult.CompilationError

CompilationResult.CompilationError.Builder

An error encountered when attempting to compile a Dataform project.

Protobuf type google.cloud.dataform.v1beta1.CompilationResult.CompilationError

CompilationResultAction

Represents a single Dataform action in a compilation result.

Protobuf type google.cloud.dataform.v1beta1.CompilationResultAction

CompilationResultAction.Assertion

Represents an assertion upon a SQL query which is required return zero rows.

Protobuf type google.cloud.dataform.v1beta1.CompilationResultAction.Assertion

CompilationResultAction.Assertion.Builder

Represents an assertion upon a SQL query which is required return zero rows.

Protobuf type google.cloud.dataform.v1beta1.CompilationResultAction.Assertion

CompilationResultAction.Builder

Represents a single Dataform action in a compilation result.

Protobuf type google.cloud.dataform.v1beta1.CompilationResultAction

CompilationResultAction.Declaration

Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions.

Protobuf type google.cloud.dataform.v1beta1.CompilationResultAction.Declaration

CompilationResultAction.Declaration.Builder

Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions.

Protobuf type google.cloud.dataform.v1beta1.CompilationResultAction.Declaration

CompilationResultAction.Operations

Represents a list of arbitrary database operations.

Protobuf type google.cloud.dataform.v1beta1.CompilationResultAction.Operations

CompilationResultAction.Operations.Builder

Represents a list of arbitrary database operations.

Protobuf type google.cloud.dataform.v1beta1.CompilationResultAction.Operations

CompilationResultAction.Relation

Represents a database relation.

Protobuf type google.cloud.dataform.v1beta1.CompilationResultAction.Relation

CompilationResultAction.Relation.Builder

Represents a database relation.

Protobuf type google.cloud.dataform.v1beta1.CompilationResultAction.Relation

CompilationResultAction.Relation.IncrementalTableConfig

Contains settings for relations of type INCREMENTAL_TABLE.

Protobuf type google.cloud.dataform.v1beta1.CompilationResultAction.Relation.IncrementalTableConfig

CompilationResultAction.Relation.IncrementalTableConfig.Builder

Contains settings for relations of type INCREMENTAL_TABLE.

Protobuf type google.cloud.dataform.v1beta1.CompilationResultAction.Relation.IncrementalTableConfig

CompilationResultName.Builder

Builder for projects/{project}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result}.

CreateCompilationResultRequest

CreateCompilationResult request message.

Protobuf type google.cloud.dataform.v1beta1.CreateCompilationResultRequest

CreateCompilationResultRequest.Builder

CreateCompilationResult request message.

Protobuf type google.cloud.dataform.v1beta1.CreateCompilationResultRequest

CreateRepositoryRequest

CreateRepository request message.

Protobuf type google.cloud.dataform.v1beta1.CreateRepositoryRequest

CreateRepositoryRequest.Builder

CreateRepository request message.

Protobuf type google.cloud.dataform.v1beta1.CreateRepositoryRequest

CreateWorkflowInvocationRequest

CreateWorkflowInvocation request message.

Protobuf type google.cloud.dataform.v1beta1.CreateWorkflowInvocationRequest

CreateWorkflowInvocationRequest.Builder

CreateWorkflowInvocation request message.

Protobuf type google.cloud.dataform.v1beta1.CreateWorkflowInvocationRequest

CreateWorkspaceRequest

CreateWorkspace request message.

Protobuf type google.cloud.dataform.v1beta1.CreateWorkspaceRequest

CreateWorkspaceRequest.Builder

CreateWorkspace request message.

Protobuf type google.cloud.dataform.v1beta1.CreateWorkspaceRequest

DataformClient

Service Description: Dataform is a service to develop, create, document, test, and update curated tables in BigQuery.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   Repository response = dataformClient.getRepository(name);
 }

Note: close() needs to be called on the DataformClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DataformSettings to create(). For example:

To customize credentials:


 // 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 dataformSettings =
     DataformSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataformClient dataformClient = DataformClient.create(dataformSettings);

To customize the endpoint:


 // 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 dataformSettings =
     DataformSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataformClient dataformClient = DataformClient.create(dataformSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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 dataformSettings = DataformSettings.newHttpJsonBuilder().build();
 DataformClient dataformClient = DataformClient.create(dataformSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

DataformClient.ListCompilationResultsFixedSizeCollection

DataformClient.ListCompilationResultsPage

DataformClient.ListCompilationResultsPagedResponse

DataformClient.ListLocationsFixedSizeCollection

DataformClient.ListLocationsPage

DataformClient.ListLocationsPagedResponse

DataformClient.ListRepositoriesFixedSizeCollection

DataformClient.ListRepositoriesPage

DataformClient.ListRepositoriesPagedResponse

DataformClient.ListWorkflowInvocationsFixedSizeCollection

DataformClient.ListWorkflowInvocationsPage

DataformClient.ListWorkflowInvocationsPagedResponse

DataformClient.ListWorkspacesFixedSizeCollection

DataformClient.ListWorkspacesPage

DataformClient.ListWorkspacesPagedResponse

DataformClient.QueryCompilationResultActionsFixedSizeCollection

DataformClient.QueryCompilationResultActionsPage

DataformClient.QueryCompilationResultActionsPagedResponse

DataformClient.QueryDirectoryContentsFixedSizeCollection

DataformClient.QueryDirectoryContentsPage

DataformClient.QueryDirectoryContentsPagedResponse