Dataform v1 API - Class DataformClientImpl (1.0.0-beta02) 

public sealed class DataformClientImpl : DataformClient

Reference documentation and code samples for the Dataform v1 API class DataformClientImpl.

Dataform client wrapper implementation, for convenient use.

Inheritance

object > DataformClient > DataformClientImpl

Namespace

Google.Cloud.Dataform.V1

Assembly

Google.Cloud.Dataform.V1.dll

Remarks

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

Constructors

DataformClientImpl(DataformClient, DataformSettings, ILogger)

public DataformClientImpl(Dataform.DataformClient grpcClient, DataformSettings settings, ILogger logger)

Constructs a client wrapper for the Dataform service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient DataformDataformClient

The underlying gRPC client.
settings DataformSettings

The base DataformSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override Dataform.DataformClient GrpcClient { get; }

The underlying gRPC Dataform client

Property Value
Type Description
DataformDataformClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

CancelWorkflowInvocation(CancelWorkflowInvocationRequest, CallSettings)

public override CancelWorkflowInvocationResponse CancelWorkflowInvocation(CancelWorkflowInvocationRequest request, CallSettings callSettings = null)

Requests cancellation of a running WorkflowInvocation.

Parameters
Name Description
request CancelWorkflowInvocationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CancelWorkflowInvocationResponse

The RPC response.
Overrides

CancelWorkflowInvocationAsync(CancelWorkflowInvocationRequest, CallSettings)

public override Task<CancelWorkflowInvocationResponse> CancelWorkflowInvocationAsync(CancelWorkflowInvocationRequest request, CallSettings callSettings = null)

Requests cancellation of a running WorkflowInvocation.

Parameters
Name Description
request CancelWorkflowInvocationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCancelWorkflowInvocationResponse

A Task containing the RPC response.
Overrides

CommitRepositoryChanges(CommitRepositoryChangesRequest, CallSettings)

public override CommitRepositoryChangesResponse CommitRepositoryChanges(CommitRepositoryChangesRequest request, CallSettings callSettings = null)

Applies a Git commit to a Repository. The Repository must not have a value for git_remote_settings.url.

Parameters
Name Description
request CommitRepositoryChangesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CommitRepositoryChangesResponse

The RPC response.
Overrides

CommitRepositoryChangesAsync(CommitRepositoryChangesRequest, CallSettings)

public override Task<CommitRepositoryChangesResponse> CommitRepositoryChangesAsync(CommitRepositoryChangesRequest request, CallSettings callSettings = null)

Applies a Git commit to a Repository. The Repository must not have a value for git_remote_settings.url.

Parameters
Name Description
request CommitRepositoryChangesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCommitRepositoryChangesResponse

A Task containing the RPC response.
Overrides

CommitWorkspaceChanges(CommitWorkspaceChangesRequest, CallSettings)

public override CommitWorkspaceChangesResponse CommitWorkspaceChanges(CommitWorkspaceChangesRequest request, CallSettings callSettings = null)

Applies a Git commit for uncommitted files in a Workspace.

Parameters
Name Description
request CommitWorkspaceChangesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CommitWorkspaceChangesResponse

The RPC response.
Overrides

CommitWorkspaceChangesAsync(CommitWorkspaceChangesRequest, CallSettings)

public override Task<CommitWorkspaceChangesResponse> CommitWorkspaceChangesAsync(CommitWorkspaceChangesRequest request, CallSettings callSettings = null)

Applies a Git commit for uncommitted files in a Workspace.

Parameters
Name Description
request CommitWorkspaceChangesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCommitWorkspaceChangesResponse

A Task containing the RPC response.
Overrides

ComputeRepositoryAccessTokenStatus(ComputeRepositoryAccessTokenStatusRequest, CallSettings)

public override ComputeRepositoryAccessTokenStatusResponse ComputeRepositoryAccessTokenStatus(ComputeRepositoryAccessTokenStatusRequest request, CallSettings callSettings = null)

Computes a Repository's Git access token status.

Parameters
Name Description
request ComputeRepositoryAccessTokenStatusRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ComputeRepositoryAccessTokenStatusResponse

The RPC response.
Overrides

ComputeRepositoryAccessTokenStatusAsync(ComputeRepositoryAccessTokenStatusRequest, CallSettings)

public override Task<ComputeRepositoryAccessTokenStatusResponse> ComputeRepositoryAccessTokenStatusAsync(ComputeRepositoryAccessTokenStatusRequest request, CallSettings callSettings = null)

Computes a Repository's Git access token status.

Parameters
Name Description
request ComputeRepositoryAccessTokenStatusRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskComputeRepositoryAccessTokenStatusResponse

A Task containing the RPC response.
Overrides

CreateCompilationResult(CreateCompilationResultRequest, CallSettings)

public override CompilationResult CreateCompilationResult(CreateCompilationResultRequest request, CallSettings callSettings = null)

Creates a new CompilationResult in a given project and location.

Parameters
Name Description
request CreateCompilationResultRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CompilationResult

The RPC response.
Overrides

CreateCompilationResultAsync(CreateCompilationResultRequest, CallSettings)

public override Task<CompilationResult> CreateCompilationResultAsync(CreateCompilationResultRequest request, CallSettings callSettings = null)

Creates a new CompilationResult in a given project and location.

Parameters
Name Description
request CreateCompilationResultRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCompilationResult

A Task containing the RPC response.
Overrides

CreateReleaseConfig(CreateReleaseConfigRequest, CallSettings)

public override ReleaseConfig CreateReleaseConfig(CreateReleaseConfigRequest request, CallSettings callSettings = null)

Creates a new ReleaseConfig in a given Repository.

Parameters
Name Description
request CreateReleaseConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ReleaseConfig

The RPC response.
Overrides

CreateReleaseConfigAsync(CreateReleaseConfigRequest, CallSettings)

public override Task<ReleaseConfig> CreateReleaseConfigAsync(CreateReleaseConfigRequest request, CallSettings callSettings = null)

Creates a new ReleaseConfig in a given Repository.

Parameters
Name Description
request CreateReleaseConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskReleaseConfig

A Task containing the RPC response.
Overrides

CreateRepository(CreateRepositoryRequest, CallSettings)

public override Repository CreateRepository(CreateRepositoryRequest request, CallSettings callSettings = null)

Creates a new Repository in a given project and location.

Parameters
Name Description
request CreateRepositoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Repository

The RPC response.
Overrides

CreateRepositoryAsync(CreateRepositoryRequest, CallSettings)

public override Task<Repository> CreateRepositoryAsync(CreateRepositoryRequest request, CallSettings callSettings = null)

Creates a new Repository in a given project and location.

Parameters
Name Description
request CreateRepositoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRepository

A Task containing the RPC response.
Overrides

CreateWorkflowConfig(CreateWorkflowConfigRequest, CallSettings)

public override WorkflowConfig CreateWorkflowConfig(CreateWorkflowConfigRequest request, CallSettings callSettings = null)

Creates a new WorkflowConfig in a given Repository.

Parameters
Name Description
request CreateWorkflowConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
WorkflowConfig

The RPC response.
Overrides

CreateWorkflowConfigAsync(CreateWorkflowConfigRequest, CallSettings)

public override Task<WorkflowConfig> CreateWorkflowConfigAsync(CreateWorkflowConfigRequest request, CallSettings callSettings = null)

Creates a new WorkflowConfig in a given Repository.

Parameters
Name Description
request CreateWorkflowConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskWorkflowConfig

A Task containing the RPC response.
Overrides

CreateWorkflowInvocation(CreateWorkflowInvocationRequest, CallSettings)

public override WorkflowInvocation CreateWorkflowInvocation(CreateWorkflowInvocationRequest request, CallSettings callSettings = null)

Creates a new WorkflowInvocation in a given Repository.

Parameters
Name Description
request CreateWorkflowInvocationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
WorkflowInvocation

The RPC response.
Overrides

CreateWorkflowInvocationAsync(CreateWorkflowInvocationRequest, CallSettings)

public override Task<WorkflowInvocation> CreateWorkflowInvocationAsync(CreateWorkflowInvocationRequest request, CallSettings callSettings = null)

Creates a new WorkflowInvocation in a given Repository.

Parameters
Name Description
request CreateWorkflowInvocationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskWorkflowInvocation

A Task containing the RPC response.
Overrides

CreateWorkspace(CreateWorkspaceRequest, CallSettings)

public override Workspace CreateWorkspace(CreateWorkspaceRequest request, CallSettings callSettings = null)

Creates a new Workspace in a given Repository.

Parameters
Name Description
request CreateWorkspaceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Workspace

The RPC response.
Overrides

CreateWorkspaceAsync(CreateWorkspaceRequest, CallSettings)

public override Task<Workspace> CreateWorkspaceAsync(CreateWorkspaceRequest request, CallSettings callSettings = null)

Creates a new Workspace in a given Repository.

Parameters
Name Description
request CreateWorkspaceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskWorkspace

A Task containing the RPC response.
Overrides

DeleteReleaseConfig(DeleteReleaseConfigRequest, CallSettings)

public override void DeleteReleaseConfig(DeleteReleaseConfigRequest request, CallSettings callSettings = null)

Deletes a single ReleaseConfig.

Parameters
Name Description
request DeleteReleaseConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteReleaseConfigAsync(DeleteReleaseConfigRequest, CallSettings)

public override Task DeleteReleaseConfigAsync(DeleteReleaseConfigRequest request, CallSettings callSettings = null)

Deletes a single ReleaseConfig.

Parameters
Name Description
request DeleteReleaseConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteRepository(DeleteRepositoryRequest, CallSettings)

public override void DeleteRepository(DeleteRepositoryRequest request, CallSettings callSettings = null)

Deletes a single Repository.

Parameters
Name Description
request DeleteRepositoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteRepositoryAsync(DeleteRepositoryRequest, CallSettings)

public override Task DeleteRepositoryAsync(DeleteRepositoryRequest request, CallSettings callSettings = null)

Deletes a single Repository.

Parameters
Name Description
request DeleteRepositoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteWorkflowConfig(DeleteWorkflowConfigRequest, CallSettings)

public override void DeleteWorkflowConfig(DeleteWorkflowConfigRequest request, CallSettings callSettings = null)

Deletes a single WorkflowConfig.

Parameters
Name Description
request DeleteWorkflowConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteWorkflowConfigAsync(DeleteWorkflowConfigRequest, CallSettings)

public override Task DeleteWorkflowConfigAsync(DeleteWorkflowConfigRequest request, CallSettings callSettings = null)

Deletes a single WorkflowConfig.

Parameters
Name Description
request DeleteWorkflowConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteWorkflowInvocation(DeleteWorkflowInvocationRequest, CallSettings)

public override void DeleteWorkflowInvocation(DeleteWorkflowInvocationRequest request, CallSettings callSettings = null)

Deletes a single WorkflowInvocation.

Parameters
Name Description
request DeleteWorkflowInvocationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteWorkflowInvocationAsync(DeleteWorkflowInvocationRequest, CallSettings)

public override Task DeleteWorkflowInvocationAsync(DeleteWorkflowInvocationRequest request, CallSettings callSettings = null)

Deletes a single WorkflowInvocation.

Parameters
Name Description
request DeleteWorkflowInvocationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteWorkspace(DeleteWorkspaceRequest, CallSettings)

public override void DeleteWorkspace(DeleteWorkspaceRequest request, CallSettings callSettings = null)

Deletes a single Workspace.

Parameters
Name Description
request DeleteWorkspaceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteWorkspaceAsync(DeleteWorkspaceRequest, CallSettings)

public override Task DeleteWorkspaceAsync(DeleteWorkspaceRequest request, CallSettings callSettings = null)

Deletes a single Workspace.

Parameters
Name Description
request DeleteWorkspaceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

FetchFileDiff(FetchFileDiffRequest, CallSettings)

public override FetchFileDiffResponse FetchFileDiff(FetchFileDiffRequest request, CallSettings callSettings = null)

Fetches Git diff for an uncommitted file in a Workspace.

Parameters
Name Description
request FetchFileDiffRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
FetchFileDiffResponse

The RPC response.
Overrides

FetchFileDiffAsync(FetchFileDiffRequest, CallSettings)

public override Task<FetchFileDiffResponse> FetchFileDiffAsync(FetchFileDiffRequest request, CallSettings callSettings = null)

Fetches Git diff for an uncommitted file in a Workspace.

Parameters
Name Description
request FetchFileDiffRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFetchFileDiffResponse

A Task containing the RPC response.
Overrides

FetchFileGitStatuses(FetchFileGitStatusesRequest, CallSettings)

public override FetchFileGitStatusesResponse FetchFileGitStatuses(FetchFileGitStatusesRequest request, CallSettings callSettings = null)

Fetches Git statuses for the files in a Workspace.

Parameters
Name Description
request FetchFileGitStatusesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
FetchFileGitStatusesResponse

The RPC response.
Overrides

FetchFileGitStatusesAsync(FetchFileGitStatusesRequest, CallSettings)

public override Task<FetchFileGitStatusesResponse> FetchFileGitStatusesAsync(FetchFileGitStatusesRequest request, CallSettings callSettings = null)

Fetches Git statuses for the files in a Workspace.

Parameters
Name Description
request FetchFileGitStatusesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFetchFileGitStatusesResponse

A Task containing the RPC response.
Overrides

FetchGitAheadBehind(FetchGitAheadBehindRequest, CallSettings)

public override FetchGitAheadBehindResponse FetchGitAheadBehind(FetchGitAheadBehindRequest request, CallSettings callSettings = null)

Fetches Git ahead/behind against a remote branch.

Parameters
Name Description
request FetchGitAheadBehindRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
FetchGitAheadBehindResponse

The RPC response.
Overrides

FetchGitAheadBehindAsync(FetchGitAheadBehindRequest, CallSettings)

public override Task<FetchGitAheadBehindResponse> FetchGitAheadBehindAsync(FetchGitAheadBehindRequest request, CallSettings callSettings = null)

Fetches Git ahead/behind against a remote branch.

Parameters
Name Description
request FetchGitAheadBehindRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFetchGitAheadBehindResponse

A Task containing the RPC response.
Overrides

FetchRemoteBranches(FetchRemoteBranchesRequest, CallSettings)

public override FetchRemoteBranchesResponse FetchRemoteBranches(FetchRemoteBranchesRequest request, CallSettings callSettings = null)

Fetches a Repository's remote branches.

Parameters
Name Description
request FetchRemoteBranchesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
FetchRemoteBranchesResponse

The RPC response.
Overrides

FetchRemoteBranchesAsync(FetchRemoteBranchesRequest, CallSettings)

public override Task<FetchRemoteBranchesResponse> FetchRemoteBranchesAsync(FetchRemoteBranchesRequest request, CallSettings callSettings = null)

Fetches a Repository's remote branches.

Parameters
Name Description
request FetchRemoteBranchesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFetchRemoteBranchesResponse

A Task containing the RPC response.
Overrides

FetchRepositoryHistory(FetchRepositoryHistoryRequest, CallSettings)

public override PagedEnumerable<FetchRepositoryHistoryResponse, CommitLogEntry> FetchRepositoryHistory(FetchRepositoryHistoryRequest request, CallSettings callSettings = null)

Fetches a Repository's history of commits. The Repository must not have a value for git_remote_settings.url.

Parameters
Name Description
request FetchRepositoryHistoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableFetchRepositoryHistoryResponseCommitLogEntry

A pageable sequence of CommitLogEntry resources.
Overrides

FetchRepositoryHistoryAsync(FetchRepositoryHistoryRequest, CallSettings)

public override PagedAsyncEnumerable<FetchRepositoryHistoryResponse, CommitLogEntry> FetchRepositoryHistoryAsync(FetchRepositoryHistoryRequest request, CallSettings callSettings = null)

Fetches a Repository's history of commits. The Repository must not have a value for git_remote_settings.url.

Parameters
Name Description
request FetchRepositoryHistoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableFetchRepositoryHistoryResponseCommitLogEntry

A pageable asynchronous sequence of CommitLogEntry resources.
Overrides

GetCompilationResult(GetCompilationResultRequest, CallSettings)

public override CompilationResult GetCompilationResult(GetCompilationResultRequest request, CallSettings callSettings = null)

Fetches a single CompilationResult.

Parameters
Name Description
request GetCompilationResultRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CompilationResult

The RPC response.
Overrides

GetCompilationResultAsync(GetCompilationResultRequest, CallSettings)

public override Task<CompilationResult> GetCompilationResultAsync(GetCompilationResultRequest request, CallSettings callSettings = null)

Fetches a single CompilationResult.

Parameters
Name Description
request GetCompilationResultRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCompilationResult

A Task containing the RPC response.
Overrides

GetConfig(GetConfigRequest, CallSettings)

public override Config GetConfig(GetConfigRequest request, CallSettings callSettings = null)

Get default config for a given project and location.

Parameters
Name Description
request GetConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Config

The RPC response.
Overrides

GetConfigAsync(GetConfigRequest, CallSettings)

public override Task<Config> GetConfigAsync(GetConfigRequest request, CallSettings callSettings = null)

Get default config for a given project and location.

Parameters
Name Description
request GetConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskConfig

A Task containing the RPC response.
Overrides

GetReleaseConfig(GetReleaseConfigRequest, CallSettings)

public override ReleaseConfig GetReleaseConfig(GetReleaseConfigRequest request, CallSettings callSettings = null)

Fetches a single ReleaseConfig.

Parameters
Name Description
request GetReleaseConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ReleaseConfig

The RPC response.
Overrides

GetReleaseConfigAsync(GetReleaseConfigRequest, CallSettings)

public override Task<ReleaseConfig> GetReleaseConfigAsync(GetReleaseConfigRequest request, CallSettings callSettings = null)

Fetches a single ReleaseConfig.

Parameters
Name Description
request GetReleaseConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskReleaseConfig

A Task containing the RPC response.
Overrides

GetRepository(GetRepositoryRequest, CallSettings)

public override Repository GetRepository(GetRepositoryRequest request, CallSettings callSettings = null)

Fetches a single Repository.

Parameters
Name Description
request GetRepositoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Repository

The RPC response.
Overrides

GetRepositoryAsync(GetRepositoryRequest, CallSettings)

public override Task<Repository> GetRepositoryAsync(GetRepositoryRequest request, CallSettings callSettings = null)

Fetches a single Repository.

Parameters
Name Description
request GetRepositoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRepository

A Task containing the RPC response.
Overrides

GetWorkflowConfig(GetWorkflowConfigRequest, CallSettings)

public override WorkflowConfig GetWorkflowConfig(GetWorkflowConfigRequest request, CallSettings callSettings = null)

Fetches a single WorkflowConfig.

Parameters
Name Description
request GetWorkflowConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
WorkflowConfig

The RPC response.
Overrides

GetWorkflowConfigAsync(GetWorkflowConfigRequest, CallSettings)

public override Task<WorkflowConfig> GetWorkflowConfigAsync(GetWorkflowConfigRequest request, CallSettings callSettings = null)

Fetches a single WorkflowConfig.

Parameters
Name Description
request GetWorkflowConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskWorkflowConfig

A Task containing the RPC response.
Overrides

GetWorkflowInvocation(GetWorkflowInvocationRequest, CallSettings)

public override WorkflowInvocation GetWorkflowInvocation(GetWorkflowInvocationRequest request, CallSettings callSettings = null)

Fetches a single WorkflowInvocation.

Parameters
Name Description
request GetWorkflowInvocationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
WorkflowInvocation

The RPC response.
Overrides

GetWorkflowInvocationAsync(GetWorkflowInvocationRequest, CallSettings)

public override Task<WorkflowInvocation> GetWorkflowInvocationAsync(GetWorkflowInvocationRequest request, CallSettings callSettings = null)

Fetches a single WorkflowInvocation.

Parameters
Name Description
request GetWorkflowInvocationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskWorkflowInvocation

A Task containing the RPC response.
Overrides

GetWorkspace(GetWorkspaceRequest, CallSettings)

public override Workspace GetWorkspace(GetWorkspaceRequest request, CallSettings callSettings = null)

Fetches a single Workspace.

Parameters
Name Description
request GetWorkspaceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Workspace

The RPC response.
Overrides

GetWorkspaceAsync(GetWorkspaceRequest, CallSettings)

public override Task<Workspace> GetWorkspaceAsync(GetWorkspaceRequest request, CallSettings callSettings = null)

Fetches a single Workspace.

Parameters
Name Description
request GetWorkspaceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskWorkspace

A Task containing the RPC response.
Overrides

InstallNpmPackages(InstallNpmPackagesRequest, CallSettings)

public override InstallNpmPackagesResponse InstallNpmPackages(InstallNpmPackagesRequest request, CallSettings callSettings = null)

Installs dependency NPM packages (inside a Workspace).

Parameters
Name Description
request InstallNpmPackagesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
InstallNpmPackagesResponse

The RPC response.
Overrides

InstallNpmPackagesAsync(InstallNpmPackagesRequest, CallSettings)

public override Task<InstallNpmPackagesResponse> InstallNpmPackagesAsync(InstallNpmPackagesRequest request, CallSettings callSettings = null)

Installs dependency NPM packages (inside a Workspace).

Parameters
Name Description
request InstallNpmPackagesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskInstallNpmPackagesResponse

A Task containing the RPC response.
Overrides

ListCompilationResults(ListCompilationResultsRequest, CallSettings)

public override PagedEnumerable<ListCompilationResultsResponse, CompilationResult> ListCompilationResults(ListCompilationResultsRequest request, CallSettings callSettings = null)

Lists CompilationResults in a given Repository.

Parameters
Name Description
request ListCompilationResultsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListCompilationResultsResponseCompilationResult

A pageable sequence of CompilationResult resources.
Overrides

ListCompilationResultsAsync(ListCompilationResultsRequest, CallSettings)

public override PagedAsyncEnumerable<ListCompilationResultsResponse, CompilationResult> ListCompilationResultsAsync(ListCompilationResultsRequest request, CallSettings callSettings = null)

Lists CompilationResults in a given Repository.

Parameters
Name Description
request ListCompilationResultsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListCompilationResultsResponseCompilationResult

A pageable asynchronous sequence of CompilationResult resources.
Overrides

ListReleaseConfigs(ListReleaseConfigsRequest, CallSettings)

public override PagedEnumerable<ListReleaseConfigsResponse, ReleaseConfig> ListReleaseConfigs(ListReleaseConfigsRequest request, CallSettings callSettings = null)

Lists ReleaseConfigs in a given Repository.

Parameters
Name Description
request ListReleaseConfigsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListReleaseConfigsResponseReleaseConfig

A pageable sequence of ReleaseConfig resources.
Overrides

ListReleaseConfigsAsync(ListReleaseConfigsRequest, CallSettings)

public override PagedAsyncEnumerable<ListReleaseConfigsResponse, ReleaseConfig> ListReleaseConfigsAsync(ListReleaseConfigsRequest request, CallSettings callSettings = null)

Lists ReleaseConfigs in a given Repository.

Parameters
Name Description
request ListReleaseConfigsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListReleaseConfigsResponseReleaseConfig

A pageable asynchronous sequence of ReleaseConfig resources.
Overrides

ListRepositories(ListRepositoriesRequest, CallSettings)

public override PagedEnumerable<ListRepositoriesResponse, Repository> ListRepositories(ListRepositoriesRequest request, CallSettings callSettings = null)

Lists Repositories in a given project and location.

Note: This method can return repositories not shown in the Dataform UI.

Parameters
Name Description
request ListRepositoriesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListRepositoriesResponseRepository

A pageable sequence of Repository resources.
Overrides

ListRepositoriesAsync(ListRepositoriesRequest, CallSettings)

public override PagedAsyncEnumerable<ListRepositoriesResponse, Repository> ListRepositoriesAsync(ListRepositoriesRequest request, CallSettings callSettings = null)

Lists Repositories in a given project and location.

Note: This method can return repositories not shown in the Dataform UI.

Parameters
Name Description
request ListRepositoriesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListRepositoriesResponseRepository

A pageable asynchronous sequence of Repository resources.
Overrides

ListWorkflowConfigs(ListWorkflowConfigsRequest, CallSettings)

public override PagedEnumerable<ListWorkflowConfigsResponse, WorkflowConfig> ListWorkflowConfigs(ListWorkflowConfigsRequest request, CallSettings callSettings = null)

Lists WorkflowConfigs in a given Repository.

Parameters
Name Description
request ListWorkflowConfigsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListWorkflowConfigsResponseWorkflowConfig

A pageable sequence of WorkflowConfig resources.
Overrides

ListWorkflowConfigsAsync(ListWorkflowConfigsRequest, CallSettings)

public override PagedAsyncEnumerable<ListWorkflowConfigsResponse, WorkflowConfig> ListWorkflowConfigsAsync(ListWorkflowConfigsRequest request, CallSettings callSettings = null)

Lists WorkflowConfigs in a given Repository.

Parameters
Name Description
request ListWorkflowConfigsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListWorkflowConfigsResponseWorkflowConfig

A pageable asynchronous sequence of WorkflowConfig resources.
Overrides

ListWorkflowInvocations(ListWorkflowInvocationsRequest, CallSettings)

public override PagedEnumerable<ListWorkflowInvocationsResponse, WorkflowInvocation> ListWorkflowInvocations(ListWorkflowInvocationsRequest request, CallSettings callSettings = null)

Lists WorkflowInvocations in a given Repository.

Parameters
Name Description
request ListWorkflowInvocationsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListWorkflowInvocationsResponseWorkflowInvocation

A pageable sequence of WorkflowInvocation resources.
Overrides

ListWorkflowInvocationsAsync(ListWorkflowInvocationsRequest, CallSettings)

public override PagedAsyncEnumerable<ListWorkflowInvocationsResponse, WorkflowInvocation> ListWorkflowInvocationsAsync(ListWorkflowInvocationsRequest request, CallSettings callSettings = null)

Lists WorkflowInvocations in a given Repository.

Parameters
Name Description
request ListWorkflowInvocationsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListWorkflowInvocationsResponseWorkflowInvocation

A pageable asynchronous sequence of WorkflowInvocation resources.
Overrides

ListWorkspaces(ListWorkspacesRequest, CallSettings)

public override PagedEnumerable<ListWorkspacesResponse, Workspace> ListWorkspaces(ListWorkspacesRequest request, CallSettings callSettings = null)

Lists Workspaces in a given Repository.

Parameters
Name Description
request ListWorkspacesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListWorkspacesResponseWorkspace

A pageable sequence of Workspace resources.
Overrides

ListWorkspacesAsync(ListWorkspacesRequest, CallSettings)

public override PagedAsyncEnumerable<ListWorkspacesResponse, Workspace> ListWorkspacesAsync(ListWorkspacesRequest request, CallSettings callSettings = null)

Lists Workspaces in a given Repository.

Parameters
Name Description
request ListWorkspacesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListWorkspacesResponseWorkspace

A pageable asynchronous sequence of Workspace resources.
Overrides

MakeDirectory(MakeDirectoryRequest, CallSettings)

public override MakeDirectoryResponse MakeDirectory(MakeDirectoryRequest request, CallSettings callSettings = null)

Creates a directory inside a Workspace.

Parameters
Name Description
request MakeDirectoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
MakeDirectoryResponse

The RPC response.
Overrides

MakeDirectoryAsync(MakeDirectoryRequest, CallSettings)

public override Task<MakeDirectoryResponse> MakeDirectoryAsync(MakeDirectoryRequest request, CallSettings callSettings = null)

Creates a directory inside a Workspace.

Parameters
Name Description
request MakeDirectoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskMakeDirectoryResponse

A Task containing the RPC response.
Overrides

MoveDirectory(MoveDirectoryRequest, CallSettings)

public override MoveDirectoryResponse MoveDirectory(MoveDirectoryRequest request, CallSettings callSettings = null)

Moves a directory (inside a Workspace), and all of its contents, to a new location.

Parameters
Name Description
request MoveDirectoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
MoveDirectoryResponse

The RPC response.
Overrides

MoveDirectoryAsync(MoveDirectoryRequest, CallSettings)

public override Task<MoveDirectoryResponse> MoveDirectoryAsync(MoveDirectoryRequest request, CallSettings callSettings = null)

Moves a directory (inside a Workspace), and all of its contents, to a new location.

Parameters
Name Description
request MoveDirectoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskMoveDirectoryResponse

A Task containing the RPC response.
Overrides

MoveFile(MoveFileRequest, CallSettings)

public override MoveFileResponse MoveFile(MoveFileRequest request, CallSettings callSettings = null)

Moves a file (inside a Workspace) to a new location.

Parameters
Name Description
request MoveFileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
MoveFileResponse

The RPC response.
Overrides

MoveFileAsync(MoveFileRequest, CallSettings)

public override Task<MoveFileResponse> MoveFileAsync(MoveFileRequest request, CallSettings callSettings = null)

Moves a file (inside a Workspace) to a new location.

Parameters
Name Description
request MoveFileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskMoveFileResponse

A Task containing the RPC response.
Overrides

PullGitCommits(PullGitCommitsRequest, CallSettings)

public override PullGitCommitsResponse PullGitCommits(PullGitCommitsRequest request, CallSettings callSettings = null)

Pulls Git commits from the Repository's remote into a Workspace.

Parameters
Name Description
request PullGitCommitsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PullGitCommitsResponse

The RPC response.
Overrides

PullGitCommitsAsync(PullGitCommitsRequest, CallSettings)

public override Task<PullGitCommitsResponse> PullGitCommitsAsync(PullGitCommitsRequest request, CallSettings callSettings = null)

Pulls Git commits from the Repository's remote into a Workspace.

Parameters
Name Description
request PullGitCommitsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPullGitCommitsResponse

A Task containing the RPC response.
Overrides

PushGitCommits(PushGitCommitsRequest, CallSettings)

public override PushGitCommitsResponse PushGitCommits(PushGitCommitsRequest request, CallSettings callSettings = null)

Pushes Git commits from a Workspace to the Repository's remote.

Parameters
Name Description
request PushGitCommitsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PushGitCommitsResponse

The RPC response.
Overrides

PushGitCommitsAsync(PushGitCommitsRequest, CallSettings)

public override Task<PushGitCommitsResponse> PushGitCommitsAsync(PushGitCommitsRequest request, CallSettings callSettings = null)

Pushes Git commits from a Workspace to the Repository's remote.

Parameters
Name Description
request PushGitCommitsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPushGitCommitsResponse

A Task containing the RPC response.
Overrides

QueryCompilationResultActions(QueryCompilationResultActionsRequest, CallSettings)

public override PagedEnumerable<QueryCompilationResultActionsResponse, CompilationResultAction> QueryCompilationResultActions(QueryCompilationResultActionsRequest request, CallSettings callSettings = null)

Returns CompilationResultActions in a given CompilationResult.

Parameters
Name Description
request QueryCompilationResultActionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableQueryCompilationResultActionsResponseCompilationResultAction

A pageable sequence of CompilationResultAction resources.
Overrides

QueryCompilationResultActionsAsync(QueryCompilationResultActionsRequest, CallSettings)

public override PagedAsyncEnumerable<QueryCompilationResultActionsResponse, CompilationResultAction> QueryCompilationResultActionsAsync(QueryCompilationResultActionsRequest request, CallSettings callSettings = null)

Returns CompilationResultActions in a given CompilationResult.

Parameters
Name Description
request QueryCompilationResultActionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableQueryCompilationResultActionsResponseCompilationResultAction

A pageable asynchronous sequence of CompilationResultAction resources.
Overrides

QueryDirectoryContents(QueryDirectoryContentsRequest, CallSettings)

public override PagedEnumerable<QueryDirectoryContentsResponse, DirectoryEntry> QueryDirectoryContents(QueryDirectoryContentsRequest request, CallSettings callSettings = null)

Returns the contents of a given Workspace directory.

Parameters
Name Description
request QueryDirectoryContentsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableQueryDirectoryContentsResponseDirectoryEntry

A pageable sequence of DirectoryEntry resources.
Overrides

QueryDirectoryContentsAsync(QueryDirectoryContentsRequest, CallSettings)

public override PagedAsyncEnumerable<QueryDirectoryContentsResponse, DirectoryEntry> QueryDirectoryContentsAsync(QueryDirectoryContentsRequest request, CallSettings callSettings = null)

Returns the contents of a given Workspace directory.

Parameters
Name Description
request QueryDirectoryContentsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableQueryDirectoryContentsResponseDirectoryEntry

A pageable asynchronous sequence of DirectoryEntry resources.
Overrides

QueryRepositoryDirectoryContents(QueryRepositoryDirectoryContentsRequest, CallSettings)

public override PagedEnumerable<QueryRepositoryDirectoryContentsResponse, DirectoryEntry> QueryRepositoryDirectoryContents(QueryRepositoryDirectoryContentsRequest request, CallSettings callSettings = null)

Returns the contents of a given Repository directory. The Repository must not have a value for git_remote_settings.url.

Parameters
Name Description
request QueryRepositoryDirectoryContentsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableQueryRepositoryDirectoryContentsResponseDirectoryEntry

A pageable sequence of DirectoryEntry resources.
Overrides

QueryRepositoryDirectoryContentsAsync(QueryRepositoryDirectoryContentsRequest, CallSettings)

public override PagedAsyncEnumerable<QueryRepositoryDirectoryContentsResponse, DirectoryEntry> QueryRepositoryDirectoryContentsAsync(QueryRepositoryDirectoryContentsRequest request, CallSettings callSettings = null)

Returns the contents of a given Repository directory. The Repository must not have a value for git_remote_settings.url.

Parameters
Name Description
request QueryRepositoryDirectoryContentsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableQueryRepositoryDirectoryContentsResponseDirectoryEntry

A pageable asynchronous sequence of DirectoryEntry resources.
Overrides

QueryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest, CallSettings)

public override PagedEnumerable<QueryWorkflowInvocationActionsResponse, WorkflowInvocationAction> QueryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest request, CallSettings callSettings = null)

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Parameters
Name Description
request QueryWorkflowInvocationActionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableQueryWorkflowInvocationActionsResponseWorkflowInvocationAction

A pageable sequence of WorkflowInvocationAction resources.
Overrides

QueryWorkflowInvocationActionsAsync(QueryWorkflowInvocationActionsRequest, CallSettings)

public override PagedAsyncEnumerable<QueryWorkflowInvocationActionsResponse, WorkflowInvocationAction> QueryWorkflowInvocationActionsAsync(QueryWorkflowInvocationActionsRequest request, CallSettings callSettings = null)

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Parameters
Name Description
request QueryWorkflowInvocationActionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableQueryWorkflowInvocationActionsResponseWorkflowInvocationAction

A pageable asynchronous sequence of WorkflowInvocationAction resources.
Overrides

ReadFile(ReadFileRequest, CallSettings)

public override ReadFileResponse ReadFile(ReadFileRequest request, CallSettings callSettings = null)

Returns the contents of a file (inside a Workspace).

Parameters
Name Description
request ReadFileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ReadFileResponse

The RPC response.
Overrides

ReadFileAsync(ReadFileRequest, CallSettings)

public override Task<ReadFileResponse> ReadFileAsync(ReadFileRequest request, CallSettings callSettings = null)

Returns the contents of a file (inside a Workspace).

Parameters
Name Description
request ReadFileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskReadFileResponse

A Task containing the RPC response.
Overrides

ReadRepositoryFile(ReadRepositoryFileRequest, CallSettings)

public override ReadRepositoryFileResponse ReadRepositoryFile(ReadRepositoryFileRequest request, CallSettings callSettings = null)

Returns the contents of a file (inside a Repository). The Repository must not have a value for git_remote_settings.url.

Parameters
Name Description
request ReadRepositoryFileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ReadRepositoryFileResponse

The RPC response.
Overrides

ReadRepositoryFileAsync(ReadRepositoryFileRequest, CallSettings)

public override Task<ReadRepositoryFileResponse> ReadRepositoryFileAsync(ReadRepositoryFileRequest request, CallSettings callSettings = null)

Returns the contents of a file (inside a Repository). The Repository must not have a value for git_remote_settings.url.

Parameters
Name Description
request ReadRepositoryFileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskReadRepositoryFileResponse

A Task containing the RPC response.
Overrides

RemoveDirectory(RemoveDirectoryRequest, CallSettings)

public override RemoveDirectoryResponse RemoveDirectory(RemoveDirectoryRequest request, CallSettings callSettings = null)

Deletes a directory (inside a Workspace) and all of its contents.

Parameters
Name Description
request RemoveDirectoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
RemoveDirectoryResponse

The RPC response.
Overrides

RemoveDirectoryAsync(RemoveDirectoryRequest, CallSettings)

public override Task<RemoveDirectoryResponse> RemoveDirectoryAsync(RemoveDirectoryRequest request, CallSettings callSettings = null)

Deletes a directory (inside a Workspace) and all of its contents.

Parameters
Name Description
request RemoveDirectoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRemoveDirectoryResponse

A Task containing the RPC response.
Overrides

RemoveFile(RemoveFileRequest, CallSettings)

public override RemoveFileResponse RemoveFile(RemoveFileRequest request, CallSettings callSettings = null)

Deletes a file (inside a Workspace).

Parameters
Name Description
request RemoveFileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
RemoveFileResponse

The RPC response.
Overrides

RemoveFileAsync(RemoveFileRequest, CallSettings)

public override Task<RemoveFileResponse> RemoveFileAsync(RemoveFileRequest request, CallSettings callSettings = null)

Deletes a file (inside a Workspace).

Parameters
Name Description
request RemoveFileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRemoveFileResponse

A Task containing the RPC response.
Overrides

ResetWorkspaceChanges(ResetWorkspaceChangesRequest, CallSettings)

public override ResetWorkspaceChangesResponse ResetWorkspaceChanges(ResetWorkspaceChangesRequest request, CallSettings callSettings = null)

Performs a Git reset for uncommitted files in a Workspace.

Parameters
Name Description
request ResetWorkspaceChangesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ResetWorkspaceChangesResponse

The RPC response.
Overrides

ResetWorkspaceChangesAsync(ResetWorkspaceChangesRequest, CallSettings)

public override Task<ResetWorkspaceChangesResponse> ResetWorkspaceChangesAsync(ResetWorkspaceChangesRequest request, CallSettings callSettings = null)

Performs a Git reset for uncommitted files in a Workspace.

Parameters
Name Description
request ResetWorkspaceChangesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskResetWorkspaceChangesResponse

A Task containing the RPC response.
Overrides

SearchFiles(SearchFilesRequest, CallSettings)

public override PagedEnumerable<SearchFilesResponse, SearchResult> SearchFiles(SearchFilesRequest request, CallSettings callSettings = null)

Finds the contents of a given Workspace directory by filter.

Parameters
Name Description
request SearchFilesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableSearchFilesResponseSearchResult

A pageable sequence of SearchResult resources.
Overrides

SearchFilesAsync(SearchFilesRequest, CallSettings)

public override PagedAsyncEnumerable<SearchFilesResponse, SearchResult> SearchFilesAsync(SearchFilesRequest request, CallSettings callSettings = null)

Finds the contents of a given Workspace directory by filter.

Parameters
Name Description
request SearchFilesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableSearchFilesResponseSearchResult

A pageable asynchronous sequence of SearchResult resources.
Overrides

UpdateConfig(UpdateConfigRequest, CallSettings)

public override Config UpdateConfig(UpdateConfigRequest request, CallSettings callSettings = null)

Update default config for a given project and location.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

Parameters
Name Description
request UpdateConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Config

The RPC response.
Overrides

UpdateConfigAsync(UpdateConfigRequest, CallSettings)

public override Task<Config> UpdateConfigAsync(UpdateConfigRequest request, CallSettings callSettings = null)

Update default config for a given project and location.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

Parameters
Name Description
request UpdateConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskConfig

A Task containing the RPC response.
Overrides

UpdateReleaseConfig(UpdateReleaseConfigRequest, CallSettings)

public override ReleaseConfig UpdateReleaseConfig(UpdateReleaseConfigRequest request, CallSettings callSettings = null)

Updates a single ReleaseConfig.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

Parameters
Name Description
request UpdateReleaseConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ReleaseConfig

The RPC response.
Overrides

UpdateReleaseConfigAsync(UpdateReleaseConfigRequest, CallSettings)

public override Task<ReleaseConfig> UpdateReleaseConfigAsync(UpdateReleaseConfigRequest request, CallSettings callSettings = null)

Updates a single ReleaseConfig.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

Parameters
Name Description
request UpdateReleaseConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskReleaseConfig

A Task containing the RPC response.
Overrides

UpdateRepository(UpdateRepositoryRequest, CallSettings)

public override Repository UpdateRepository(UpdateRepositoryRequest request, CallSettings callSettings = null)

Updates a single Repository.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

Parameters
Name Description
request UpdateRepositoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Repository

The RPC response.
Overrides

UpdateRepositoryAsync(UpdateRepositoryRequest, CallSettings)

public override Task<Repository> UpdateRepositoryAsync(UpdateRepositoryRequest request, CallSettings callSettings = null)

Updates a single Repository.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

Parameters
Name Description
request UpdateRepositoryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRepository

A Task containing the RPC response.
Overrides

UpdateWorkflowConfig(UpdateWorkflowConfigRequest, CallSettings)

public override WorkflowConfig UpdateWorkflowConfig(UpdateWorkflowConfigRequest request, CallSettings callSettings = null)

Updates a single WorkflowConfig.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

Parameters
Name Description
request UpdateWorkflowConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
WorkflowConfig

The RPC response.
Overrides

UpdateWorkflowConfigAsync(UpdateWorkflowConfigRequest, CallSettings)

public override Task<WorkflowConfig> UpdateWorkflowConfigAsync(UpdateWorkflowConfigRequest request, CallSettings callSettings = null)

Updates a single WorkflowConfig.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

Parameters
Name Description
request UpdateWorkflowConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskWorkflowConfig

A Task containing the RPC response.
Overrides

WriteFile(WriteFileRequest, CallSettings)

public override WriteFileResponse WriteFile(WriteFileRequest request, CallSettings callSettings = null)

Writes to a file (inside a Workspace).

Parameters
Name Description
request WriteFileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
WriteFileResponse

The RPC response.
Overrides

WriteFileAsync(WriteFileRequest, CallSettings)

public override Task<WriteFileResponse> WriteFileAsync(WriteFileRequest request, CallSettings callSettings = null)

Writes to a file (inside a Workspace).

Parameters
Name Description
request WriteFileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskWriteFileResponse

A Task containing the RPC response.
Overrides