Class: Google::Apis::DataformV1::DataformService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/dataform_v1/service.rb

Overview

Dataform API

Service to develop, version control, and operationalize SQL pipelines in BigQuery.

Examples:

require 'google/apis/dataform_v1'

Dataform = Google::Apis::DataformV1 # Alias the module
service = Dataform::DataformService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =
"https://dataform.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeDataformService

Returns a new instance of DataformService.



48
49
50
51
52
53
# File 'lib/google/apis/dataform_v1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-dataform_v1',
        client_version: Google::Apis::DataformV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



41
42
43
# File 'lib/google/apis/dataform_v1/service.rb', line 41

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



46
47
48
# File 'lib/google/apis/dataform_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1 , corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::DataformV1::CancelOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



666
667
668
669
670
671
672
673
674
675
676
# File 'lib/google/apis/dataform_v1/service.rb', line 666

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::DataformV1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::DataformV1::Empty::Representation
  command.response_class = Google::Apis::DataformV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_workflow_invocation(name, cancel_workflow_invocation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::CancelWorkflowInvocationResponse

Requests cancellation of a running WorkflowInvocation.

Parameters:

  • name (String)

    Required. The workflow invocation resource's name.

  • cancel_workflow_invocation_request_object (Google::Apis::DataformV1::CancelWorkflowInvocationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
# File 'lib/google/apis/dataform_v1/service.rb', line 1907

def cancel_workflow_invocation(name, cancel_workflow_invocation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::DataformV1::CancelWorkflowInvocationRequest::Representation
  command.request_object = cancel_workflow_invocation_request_object
  command.response_representation = Google::Apis::DataformV1::CancelWorkflowInvocationResponse::Representation
  command.response_class = Google::Apis::DataformV1::CancelWorkflowInvocationResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#commit_repository_changes(name, commit_repository_changes_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::CommitRepositoryChangesResponse

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

Parameters:

  • name (String)

    Required. The repository's name.

  • commit_repository_changes_request_object (Google::Apis::DataformV1::CommitRepositoryChangesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



813
814
815
816
817
818
819
820
821
822
823
# File 'lib/google/apis/dataform_v1/service.rb', line 813

def commit_repository_changes(name, commit_repository_changes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:commit', options)
  command.request_representation = Google::Apis::DataformV1::CommitRepositoryChangesRequest::Representation
  command.request_object = commit_repository_changes_request_object
  command.response_representation = Google::Apis::DataformV1::CommitRepositoryChangesResponse::Representation
  command.response_class = Google::Apis::DataformV1::CommitRepositoryChangesResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#commit_workspace_changes(name, commit_workspace_changes_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::CommitWorkspaceChangesResponse

Applies a Git commit for uncommitted files in a Workspace.

Parameters:

  • name (String)

    Required. The workspace's name.

  • commit_workspace_changes_request_object (Google::Apis::DataformV1::CommitWorkspaceChangesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
# File 'lib/google/apis/dataform_v1/service.rb', line 2125

def commit_workspace_changes(name, commit_workspace_changes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:commit', options)
  command.request_representation = Google::Apis::DataformV1::CommitWorkspaceChangesRequest::Representation
  command.request_object = commit_workspace_changes_request_object
  command.response_representation = Google::Apis::DataformV1::CommitWorkspaceChangesResponse::Representation
  command.response_class = Google::Apis::DataformV1::CommitWorkspaceChangesResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#compute_project_location_repository_access_token_status(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ComputeRepositoryAccessTokenStatusResponse

Computes a Repository's Git access token status.

Parameters:

  • name (String)

    Required. The repository's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



845
846
847
848
849
850
851
852
853
# File 'lib/google/apis/dataform_v1/service.rb', line 845

def compute_project_location_repository_access_token_status(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:computeAccessTokenStatus', options)
  command.response_representation = Google::Apis::DataformV1::ComputeRepositoryAccessTokenStatusResponse::Representation
  command.response_class = Google::Apis::DataformV1::ComputeRepositoryAccessTokenStatusResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_folder(parent, folder_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Folder

Creates a new Folder in a given project and location.

Parameters:

  • parent (String)

    Required. The location in which to create the Folder. Must be in the format projects/*/locations/*.

  • folder_object (Google::Apis::DataformV1::Folder) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



286
287
288
289
290
291
292
293
294
295
296
# File 'lib/google/apis/dataform_v1/service.rb', line 286

def create_project_location_folder(parent, folder_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/folders', options)
  command.request_representation = Google::Apis::DataformV1::Folder::Representation
  command.request_object = folder_object
  command.response_representation = Google::Apis::DataformV1::Folder::Representation
  command.response_class = Google::Apis::DataformV1::Folder
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_repository(parent, repository_object = nil, repository_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Repository

Creates a new Repository in a given project and location.

Parameters:

  • parent (String)

    Required. The location in which to create the repository. Must be in the format projects/*/locations/*.

  • repository_object (Google::Apis::DataformV1::Repository) (defaults to: nil)
  • repository_id (String) (defaults to: nil)

    Required. The ID to use for the repository, which will become the final component of the repository's resource name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



880
881
882
883
884
885
886
887
888
889
890
891
# File 'lib/google/apis/dataform_v1/service.rb', line 880

def create_project_location_repository(parent, repository_object = nil, repository_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/repositories', options)
  command.request_representation = Google::Apis::DataformV1::Repository::Representation
  command.request_object = repository_object
  command.response_representation = Google::Apis::DataformV1::Repository::Representation
  command.response_class = Google::Apis::DataformV1::Repository
  command.params['parent'] = parent unless parent.nil?
  command.query['repositoryId'] = repository_id unless repository_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_repository_compilation_result(parent, compilation_result_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::CompilationResult

Creates a new CompilationResult in a given project and location.

Parameters:

  • parent (String)

    Required. The repository in which to create the compilation result. Must be in the format projects/*/locations/*/repositories/*.

  • compilation_result_object (Google::Apis::DataformV1::CompilationResult) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'lib/google/apis/dataform_v1/service.rb', line 1389

def create_project_location_repository_compilation_result(parent, compilation_result_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/compilationResults', options)
  command.request_representation = Google::Apis::DataformV1::CompilationResult::Representation
  command.request_object = compilation_result_object
  command.response_representation = Google::Apis::DataformV1::CompilationResult::Representation
  command.response_class = Google::Apis::DataformV1::CompilationResult
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_repository_release_config(parent, release_config_object = nil, release_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ReleaseConfig

Creates a new ReleaseConfig in a given Repository.

Parameters:

  • parent (String)

    Required. The repository in which to create the release config. Must be in the format projects/*/locations/*/repositories/*.

  • release_config_object (Google::Apis::DataformV1::ReleaseConfig) (defaults to: nil)
  • release_config_id (String) (defaults to: nil)

    Required. The ID to use for the release config, which will become the final component of the release config's resource name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
# File 'lib/google/apis/dataform_v1/service.rb', line 1551

def create_project_location_repository_release_config(parent, release_config_object = nil, release_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/releaseConfigs', options)
  command.request_representation = Google::Apis::DataformV1::ReleaseConfig::Representation
  command.request_object = release_config_object
  command.response_representation = Google::Apis::DataformV1::ReleaseConfig::Representation
  command.response_class = Google::Apis::DataformV1::ReleaseConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['releaseConfigId'] = release_config_id unless release_config_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_repository_workflow_config(parent, workflow_config_object = nil, workflow_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::WorkflowConfig

Creates a new WorkflowConfig in a given Repository.

Parameters:

  • parent (String)

    Required. The repository in which to create the workflow config. Must be in the format projects/*/locations/*/repositories/*.

  • workflow_config_object (Google::Apis::DataformV1::WorkflowConfig) (defaults to: nil)
  • workflow_config_id (String) (defaults to: nil)

    Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
# File 'lib/google/apis/dataform_v1/service.rb', line 1731

def create_project_location_repository_workflow_config(parent, workflow_config_object = nil, workflow_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/workflowConfigs', options)
  command.request_representation = Google::Apis::DataformV1::WorkflowConfig::Representation
  command.request_object = workflow_config_object
  command.response_representation = Google::Apis::DataformV1::WorkflowConfig::Representation
  command.response_class = Google::Apis::DataformV1::WorkflowConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['workflowConfigId'] = workflow_config_id unless workflow_config_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_repository_workflow_invocation(parent, workflow_invocation_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::WorkflowInvocation

Creates a new WorkflowInvocation in a given Repository.

Parameters:

  • parent (String)

    Required. The repository in which to create the workflow invocation. Must be in the format projects/*/locations/*/repositories/*.

  • workflow_invocation_object (Google::Apis::DataformV1::WorkflowInvocation) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
# File 'lib/google/apis/dataform_v1/service.rb', line 1941

def create_project_location_repository_workflow_invocation(parent, workflow_invocation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/workflowInvocations', options)
  command.request_representation = Google::Apis::DataformV1::WorkflowInvocation::Representation
  command.request_object = workflow_invocation_object
  command.response_representation = Google::Apis::DataformV1::WorkflowInvocation::Representation
  command.response_class = Google::Apis::DataformV1::WorkflowInvocation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_repository_workspace(parent, workspace_object = nil, workspace_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Workspace

Creates a new Workspace in a given Repository.

Parameters:

  • parent (String)

    Required. The repository in which to create the workspace. Must be in the format projects/*/locations/*/repositories/*.

  • workspace_object (Google::Apis::DataformV1::Workspace) (defaults to: nil)
  • workspace_id (String) (defaults to: nil)

    Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
# File 'lib/google/apis/dataform_v1/service.rb', line 2162

def create_project_location_repository_workspace(parent, workspace_object = nil, workspace_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/workspaces', options)
  command.request_representation = Google::Apis::DataformV1::Workspace::Representation
  command.request_object = workspace_object
  command.response_representation = Google::Apis::DataformV1::Workspace::Representation
  command.response_class = Google::Apis::DataformV1::Workspace
  command.params['parent'] = parent unless parent.nil?
  command.query['workspaceId'] = workspace_id unless workspace_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_team_folder(parent, team_folder_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::TeamFolder

Creates a new TeamFolder in a given project and location.

Parameters:

  • parent (String)

    Required. The location in which to create the TeamFolder. Must be in the format projects/*/locations/*.

  • team_folder_object (Google::Apis::DataformV1::TeamFolder) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
# File 'lib/google/apis/dataform_v1/service.rb', line 2992

def create_project_location_team_folder(parent, team_folder_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/teamFolders', options)
  command.request_representation = Google::Apis::DataformV1::TeamFolder::Representation
  command.request_object = team_folder_object
  command.response_representation = Google::Apis::DataformV1::TeamFolder::Representation
  command.response_class = Google::Apis::DataformV1::TeamFolder
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_folder(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Empty

Deletes a single Folder.

Parameters:

  • name (String)

    Required. The Folder's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



318
319
320
321
322
323
324
325
326
# File 'lib/google/apis/dataform_v1/service.rb', line 318

def delete_project_location_folder(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::Empty::Representation
  command.response_class = Google::Apis::DataformV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_folder_tree(name, delete_folder_tree_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Operation

Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).

Parameters:

  • name (String)

    Required. The Folder's name. Format: projects/project/locations/location/ folders/folder

  • delete_folder_tree_request_object (Google::Apis::DataformV1::DeleteFolderTreeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



351
352
353
354
355
356
357
358
359
360
361
# File 'lib/google/apis/dataform_v1/service.rb', line 351

def delete_project_location_folder_tree(name, delete_folder_tree_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:deleteTree', options)
  command.request_representation = Google::Apis::DataformV1::DeleteFolderTreeRequest::Representation
  command.request_object = delete_folder_tree_request_object
  command.response_representation = Google::Apis::DataformV1::Operation::Representation
  command.response_class = Google::Apis::DataformV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



701
702
703
704
705
706
707
708
709
# File 'lib/google/apis/dataform_v1/service.rb', line 701

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::Empty::Representation
  command.response_class = Google::Apis::DataformV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_repository(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Empty

Deletes a single Repository.

Parameters:

  • name (String)

    Required. The repository's name.

  • force (Boolean) (defaults to: nil)

    Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. Note: This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail..

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



920
921
922
923
924
925
926
927
928
929
# File 'lib/google/apis/dataform_v1/service.rb', line 920

def delete_project_location_repository(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::Empty::Representation
  command.response_class = Google::Apis::DataformV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_repository_release_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Empty

Deletes a single ReleaseConfig.

Parameters:

  • name (String)

    Required. The release config's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1584
1585
1586
1587
1588
1589
1590
1591
1592
# File 'lib/google/apis/dataform_v1/service.rb', line 1584

def delete_project_location_repository_release_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::Empty::Representation
  command.response_class = Google::Apis::DataformV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_repository_workflow_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Empty

Deletes a single WorkflowConfig.

Parameters:

  • name (String)

    Required. The workflow config's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1764
1765
1766
1767
1768
1769
1770
1771
1772
# File 'lib/google/apis/dataform_v1/service.rb', line 1764

def delete_project_location_repository_workflow_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::Empty::Representation
  command.response_class = Google::Apis::DataformV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_repository_workflow_invocation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Empty

Deletes a single WorkflowInvocation.

Parameters:

  • name (String)

    Required. The workflow invocation resource's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1973
1974
1975
1976
1977
1978
1979
1980
1981
# File 'lib/google/apis/dataform_v1/service.rb', line 1973

def delete_project_location_repository_workflow_invocation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::Empty::Representation
  command.response_class = Google::Apis::DataformV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_repository_workspace(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Empty

Deletes a single Workspace.

Parameters:

  • name (String)

    Required. The workspace resource's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2195
2196
2197
2198
2199
2200
2201
2202
2203
# File 'lib/google/apis/dataform_v1/service.rb', line 2195

def delete_project_location_repository_workspace(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::Empty::Representation
  command.response_class = Google::Apis::DataformV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_team_folder(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Empty

Deletes a single TeamFolder.

Parameters:

  • name (String)

    Required. The TeamFolder's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3024
3025
3026
3027
3028
3029
3030
3031
3032
# File 'lib/google/apis/dataform_v1/service.rb', line 3024

def delete_project_location_team_folder(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::Empty::Representation
  command.response_class = Google::Apis::DataformV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_team_folder_tree(name, delete_team_folder_tree_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Operation

Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).

Parameters:

  • name (String)

    Required. The TeamFolder's name. Format: projects/project/locations/ location/teamFolders/team_folder

  • delete_team_folder_tree_request_object (Google::Apis::DataformV1::DeleteTeamFolderTreeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
# File 'lib/google/apis/dataform_v1/service.rb', line 3057

def delete_project_location_team_folder_tree(name, delete_team_folder_tree_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:deleteTree', options)
  command.request_representation = Google::Apis::DataformV1::DeleteTeamFolderTreeRequest::Representation
  command.request_object = delete_team_folder_tree_request_object
  command.response_representation = Google::Apis::DataformV1::Operation::Representation
  command.response_class = Google::Apis::DataformV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_project_location_repository_history(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::FetchRepositoryHistoryResponse

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

Parameters:

  • name (String)

    Required. The repository's name.

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous FetchRepositoryHistory call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FetchRepositoryHistory, with the exception of page_size, must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



961
962
963
964
965
966
967
968
969
970
971
# File 'lib/google/apis/dataform_v1/service.rb', line 961

def fetch_project_location_repository_history(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:fetchHistory', options)
  command.response_representation = Google::Apis::DataformV1::FetchRepositoryHistoryResponse::Representation
  command.response_class = Google::Apis::DataformV1::FetchRepositoryHistoryResponse
  command.params['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_project_location_repository_remote_branches(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::FetchRemoteBranchesResponse

Fetches a Repository's remote branches.

Parameters:

  • name (String)

    Required. The repository's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



993
994
995
996
997
998
999
1000
1001
# File 'lib/google/apis/dataform_v1/service.rb', line 993

def fetch_project_location_repository_remote_branches(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:fetchRemoteBranches', options)
  command.response_representation = Google::Apis::DataformV1::FetchRemoteBranchesResponse::Representation
  command.response_class = Google::Apis::DataformV1::FetchRemoteBranchesResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_project_location_repository_workspace_file_diff(workspace, path: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::FetchFileDiffResponse

Fetches Git diff for an uncommitted file in a Workspace.

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • path (String) (defaults to: nil)

    Required. The file's full path including filename, relative to the workspace root.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
# File 'lib/google/apis/dataform_v1/service.rb', line 2228

def fetch_project_location_repository_workspace_file_diff(workspace, path: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+workspace}:fetchFileDiff', options)
  command.response_representation = Google::Apis::DataformV1::FetchFileDiffResponse::Representation
  command.response_class = Google::Apis::DataformV1::FetchFileDiffResponse
  command.params['workspace'] = workspace unless workspace.nil?
  command.query['path'] = path unless path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_project_location_repository_workspace_file_git_statuses(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::FetchFileGitStatusesResponse

Fetches Git statuses for the files in a Workspace.

Parameters:

  • name (String)

    Required. The workspace's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2259
2260
2261
2262
2263
2264
2265
2266
2267
# File 'lib/google/apis/dataform_v1/service.rb', line 2259

def fetch_project_location_repository_workspace_file_git_statuses(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:fetchFileGitStatuses', options)
  command.response_representation = Google::Apis::DataformV1::FetchFileGitStatusesResponse::Representation
  command.response_class = Google::Apis::DataformV1::FetchFileGitStatusesResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_project_location_repository_workspace_git_ahead_behind(name, remote_branch: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::FetchGitAheadBehindResponse

Fetches Git ahead/behind against a remote branch.

Parameters:

  • name (String)

    Required. The workspace's name.

  • remote_branch (String) (defaults to: nil)

    Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
# File 'lib/google/apis/dataform_v1/service.rb', line 2293

def fetch_project_location_repository_workspace_git_ahead_behind(name, remote_branch: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:fetchGitAheadBehind', options)
  command.response_representation = Google::Apis::DataformV1::FetchGitAheadBehindResponse::Representation
  command.response_class = Google::Apis::DataformV1::FetchGitAheadBehindResponse
  command.params['name'] = name unless name.nil?
  command.query['remoteBranch'] = remote_branch unless remote_branch.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Location

Gets information about a location.

Parameters:

  • name (String)

    Resource name for the location.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



75
76
77
78
79
80
81
82
83
# File 'lib/google/apis/dataform_v1/service.rb', line 75

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::Location::Representation
  command.response_class = Google::Apis::DataformV1::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Config

Get default config for a given project and location.

Parameters:

  • name (String)

    Required. The config name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



105
106
107
108
109
110
111
112
113
# File 'lib/google/apis/dataform_v1/service.rb', line 105

def get_project_location_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::Config::Representation
  command.response_class = Google::Apis::DataformV1::Config
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_folder(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Folder

Fetches a single Folder.

Parameters:

  • name (String)

    Required. The Folder's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



383
384
385
386
387
388
389
390
391
# File 'lib/google/apis/dataform_v1/service.rb', line 383

def get_project_location_folder(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::Folder::Representation
  command.response_class = Google::Apis::DataformV1::Folder
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_folder_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil)

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



427
428
429
430
431
432
433
434
435
436
# File 'lib/google/apis/dataform_v1/service.rb', line 427

def get_project_location_folder_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::DataformV1::Policy::Representation
  command.response_class = Google::Apis::DataformV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



732
733
734
735
736
737
738
739
740
# File 'lib/google/apis/dataform_v1/service.rb', line 732

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::Operation::Representation
  command.response_class = Google::Apis::DataformV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_repository(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Repository

Fetches a single Repository.

Parameters:

  • name (String)

    Required. The repository's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1023
1024
1025
1026
1027
1028
1029
1030
1031
# File 'lib/google/apis/dataform_v1/service.rb', line 1023

def get_project_location_repository(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::Repository::Representation
  command.response_class = Google::Apis::DataformV1::Repository
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_repository_compilation_result(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::CompilationResult

Fetches a single CompilationResult.

Parameters:

  • name (String)

    Required. The compilation result's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1421
1422
1423
1424
1425
1426
1427
1428
1429
# File 'lib/google/apis/dataform_v1/service.rb', line 1421

def get_project_location_repository_compilation_result(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::CompilationResult::Representation
  command.response_class = Google::Apis::DataformV1::CompilationResult
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_repository_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil)

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
# File 'lib/google/apis/dataform_v1/service.rb', line 1067

def get_project_location_repository_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::DataformV1::Policy::Representation
  command.response_class = Google::Apis::DataformV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_repository_release_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ReleaseConfig

Fetches a single ReleaseConfig.

Parameters:

  • name (String)

    Required. The release config's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1614
1615
1616
1617
1618
1619
1620
1621
1622
# File 'lib/google/apis/dataform_v1/service.rb', line 1614

def get_project_location_repository_release_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::ReleaseConfig::Representation
  command.response_class = Google::Apis::DataformV1::ReleaseConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_repository_workflow_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::WorkflowConfig

Fetches a single WorkflowConfig.

Parameters:

  • name (String)

    Required. The workflow config's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1794
1795
1796
1797
1798
1799
1800
1801
1802
# File 'lib/google/apis/dataform_v1/service.rb', line 1794

def get_project_location_repository_workflow_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::WorkflowConfig::Representation
  command.response_class = Google::Apis::DataformV1::WorkflowConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_repository_workflow_invocation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::WorkflowInvocation

Fetches a single WorkflowInvocation.

Parameters:

  • name (String)

    Required. The workflow invocation resource's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2003
2004
2005
2006
2007
2008
2009
2010
2011
# File 'lib/google/apis/dataform_v1/service.rb', line 2003

def get_project_location_repository_workflow_invocation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::WorkflowInvocation::Representation
  command.response_class = Google::Apis::DataformV1::WorkflowInvocation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_repository_workspace(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Workspace

Fetches a single Workspace.

Parameters:

  • name (String)

    Required. The workspace's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2324
2325
2326
2327
2328
2329
2330
2331
2332
# File 'lib/google/apis/dataform_v1/service.rb', line 2324

def get_project_location_repository_workspace(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::Workspace::Representation
  command.response_class = Google::Apis::DataformV1::Workspace
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_repository_workspace_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil)

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
# File 'lib/google/apis/dataform_v1/service.rb', line 2368

def get_project_location_repository_workspace_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::DataformV1::Policy::Representation
  command.response_class = Google::Apis::DataformV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_team_folder(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::TeamFolder

Fetches a single TeamFolder.

Parameters:

  • name (String)

    Required. The TeamFolder's name.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3089
3090
3091
3092
3093
3094
3095
3096
3097
# File 'lib/google/apis/dataform_v1/service.rb', line 3089

def get_project_location_team_folder(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1::TeamFolder::Representation
  command.response_class = Google::Apis::DataformV1::TeamFolder
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_team_folder_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil)

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
# File 'lib/google/apis/dataform_v1/service.rb', line 3133

def get_project_location_team_folder_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::DataformV1::Policy::Representation
  command.response_class = Google::Apis::DataformV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#install_workspace_npm_packages(workspace, install_npm_packages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::InstallNpmPackagesResponse

Installs dependency NPM packages (inside a Workspace).

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • install_npm_packages_request_object (Google::Apis::DataformV1::InstallNpmPackagesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
# File 'lib/google/apis/dataform_v1/service.rb', line 2400

def install_workspace_npm_packages(workspace, install_npm_packages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+workspace}:installNpmPackages', options)
  command.request_representation = Google::Apis::DataformV1::InstallNpmPackagesRequest::Representation
  command.request_object = install_npm_packages_request_object
  command.response_representation = Google::Apis::DataformV1::InstallNpmPackagesResponse::Representation
  command.response_class = Google::Apis::DataformV1::InstallNpmPackagesResponse
  command.params['workspace'] = workspace unless workspace.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • return_partial_success (Boolean) (defaults to: nil)

    When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse. unreachable field. This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-". This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



777
778
779
780
781
782
783
784
785
786
787
788
789
# File 'lib/google/apis/dataform_v1/service.rb', line 777

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::DataformV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::DataformV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_repositories(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ListRepositoriesResponse

Lists Repositories in a given project and location. Note: This method can return repositories not shown in the Dataform UI.

Parameters:

  • parent (String)

    Required. The location in which to list repositories. Must be in the format projects/*/locations/*.

  • filter (String) (defaults to: nil)

    Optional. Filter for the returned list.

  • order_by (String) (defaults to: nil)

    Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous ListRepositories call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRepositories, with the exception of page_size, must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
# File 'lib/google/apis/dataform_v1/service.rb', line 1116

def list_project_location_repositories(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/repositories', options)
  command.response_representation = Google::Apis::DataformV1::ListRepositoriesResponse::Representation
  command.response_class = Google::Apis::DataformV1::ListRepositoriesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_repository_compilation_results(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ListCompilationResultsResponse

Lists CompilationResults in a given Repository.

Parameters:

  • parent (String)

    Required. The repository in which to list compilation results. Must be in the format projects/*/locations/*/repositories/*.

  • filter (String) (defaults to: nil)

    Optional. Filter for the returned list.

  • order_by (String) (defaults to: nil)

    Optional. This field only supports ordering by name and create_time. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous ListCompilationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListCompilationResults, with the exception of page_size, must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
# File 'lib/google/apis/dataform_v1/service.rb', line 1467

def list_project_location_repository_compilation_results(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/compilationResults', options)
  command.response_representation = Google::Apis::DataformV1::ListCompilationResultsResponse::Representation
  command.response_class = Google::Apis::DataformV1::ListCompilationResultsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_repository_release_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ListReleaseConfigsResponse

Lists ReleaseConfigs in a given Repository.

Parameters:

  • parent (String)

    Required. The repository in which to list release configs. Must be in the format projects/*/locations/*/repositories/*.

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of release configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous ListReleaseConfigs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListReleaseConfigs, with the exception of page_size, must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
# File 'lib/google/apis/dataform_v1/service.rb', line 1654

def list_project_location_repository_release_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/releaseConfigs', options)
  command.response_representation = Google::Apis::DataformV1::ListReleaseConfigsResponse::Representation
  command.response_class = Google::Apis::DataformV1::ListReleaseConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_repository_workflow_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ListWorkflowConfigsResponse

Lists WorkflowConfigs in a given Repository.

Parameters:

  • parent (String)

    Required. The repository in which to list workflow configs. Must be in the format projects/*/locations/*/repositories/*.

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous ListWorkflowConfigs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkflowConfigs, with the exception of page_size , must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
# File 'lib/google/apis/dataform_v1/service.rb', line 1834

def list_project_location_repository_workflow_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/workflowConfigs', options)
  command.response_representation = Google::Apis::DataformV1::ListWorkflowConfigsResponse::Representation
  command.response_class = Google::Apis::DataformV1::ListWorkflowConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_repository_workflow_invocations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ListWorkflowInvocationsResponse

Lists WorkflowInvocations in a given Repository.

Parameters:

  • parent (String)

    Required. The parent resource of the WorkflowInvocation type. Must be in the format projects/*/locations/*/repositories/*.

  • filter (String) (defaults to: nil)

    Optional. Filter for the returned list.

  • order_by (String) (defaults to: nil)

    Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous ListWorkflowInvocations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkflowInvocations, with the exception of page_size, must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
# File 'lib/google/apis/dataform_v1/service.rb', line 2049

def list_project_location_repository_workflow_invocations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/workflowInvocations', options)
  command.response_representation = Google::Apis::DataformV1::ListWorkflowInvocationsResponse::Representation
  command.response_class = Google::Apis::DataformV1::ListWorkflowInvocationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_repository_workspaces(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ListWorkspacesResponse

Lists Workspaces in a given Repository.

Parameters:

  • parent (String)

    Required. The repository in which to list workspaces. Must be in the format projects/*/locations/*/repositories/*.

  • filter (String) (defaults to: nil)

    Optional. Filter for the returned list.

  • order_by (String) (defaults to: nil)

    Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous ListWorkspaces call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkspaces, with the exception of page_size, must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
# File 'lib/google/apis/dataform_v1/service.rb', line 2448

def list_project_location_repository_workspaces(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/workspaces', options)
  command.response_representation = Google::Apis::DataformV1::ListWorkspacesResponse::Representation
  command.response_class = Google::Apis::DataformV1::ListWorkspacesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ListLocationsResponse

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ ListLocationsRequest.name] field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project- specific locations: If name follows the format projects/project`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as thename` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

Parameters:

  • name (String)

    The resource that owns the locations collection, if applicable.

  • extra_location_types (Array<String>, String) (defaults to: nil)

    Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

  • filter (String) (defaults to: nil)

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of results to return. If not set, the service selects a default.

  • page_token (String) (defaults to: nil)

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'lib/google/apis/dataform_v1/service.rb', line 157

def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::DataformV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::DataformV1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#make_workspace_directory(workspace, make_directory_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::MakeDirectoryResponse

Creates a directory inside a Workspace.

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • make_directory_request_object (Google::Apis::DataformV1::MakeDirectoryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
# File 'lib/google/apis/dataform_v1/service.rb', line 2483

def make_workspace_directory(workspace, make_directory_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+workspace}:makeDirectory', options)
  command.request_representation = Google::Apis::DataformV1::MakeDirectoryRequest::Representation
  command.request_object = make_directory_request_object
  command.response_representation = Google::Apis::DataformV1::MakeDirectoryResponse::Representation
  command.response_class = Google::Apis::DataformV1::MakeDirectoryResponse
  command.params['workspace'] = workspace unless workspace.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#move_folder(name, move_folder_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Operation

Moves a Folder to a new Folder, TeamFolder, or the root location.

Parameters:

  • name (String)

    Required. The full resource name of the Folder to move.

  • move_folder_request_object (Google::Apis::DataformV1::MoveFolderRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



459
460
461
462
463
464
465
466
467
468
469
# File 'lib/google/apis/dataform_v1/service.rb', line 459

def move_folder(name, move_folder_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:move', options)
  command.request_representation = Google::Apis::DataformV1::MoveFolderRequest::Representation
  command.request_object = move_folder_request_object
  command.response_representation = Google::Apis::DataformV1::Operation::Representation
  command.response_class = Google::Apis::DataformV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#move_repository(name, move_repository_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Operation

Moves a Repository to a new location.

Parameters:

  • name (String)

    Required. The full resource name of the repository to move.

  • move_repository_request_object (Google::Apis::DataformV1::MoveRepositoryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
# File 'lib/google/apis/dataform_v1/service.rb', line 1151

def move_repository(name, move_repository_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:move', options)
  command.request_representation = Google::Apis::DataformV1::MoveRepositoryRequest::Representation
  command.request_object = move_repository_request_object
  command.response_representation = Google::Apis::DataformV1::Operation::Representation
  command.response_class = Google::Apis::DataformV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#move_workspace_directory(workspace, move_directory_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::MoveDirectoryResponse

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

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • move_directory_request_object (Google::Apis::DataformV1::MoveDirectoryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
# File 'lib/google/apis/dataform_v1/service.rb', line 2517

def move_workspace_directory(workspace, move_directory_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+workspace}:moveDirectory', options)
  command.request_representation = Google::Apis::DataformV1::MoveDirectoryRequest::Representation
  command.request_object = move_directory_request_object
  command.response_representation = Google::Apis::DataformV1::MoveDirectoryResponse::Representation
  command.response_class = Google::Apis::DataformV1::MoveDirectoryResponse
  command.params['workspace'] = workspace unless workspace.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#move_workspace_file(workspace, move_file_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::MoveFileResponse

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

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • move_file_request_object (Google::Apis::DataformV1::MoveFileRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
# File 'lib/google/apis/dataform_v1/service.rb', line 2550

def move_workspace_file(workspace, move_file_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+workspace}:moveFile', options)
  command.request_representation = Google::Apis::DataformV1::MoveFileRequest::Representation
  command.request_object = move_file_request_object
  command.response_representation = Google::Apis::DataformV1::MoveFileResponse::Representation
  command.response_class = Google::Apis::DataformV1::MoveFileResponse
  command.params['workspace'] = workspace unless workspace.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_folder(name, folder_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Folder

Updates a single Folder.

Parameters:

  • name (String)

    Identifier. The Folder's name.

  • folder_object (Google::Apis::DataformV1::Folder) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Specifies the fields to be updated in the Folder. If left unset, all fields that can be updated, will be updated. A few fields cannot be updated and will be ignored if specified in the update_mask (e.g. parent_name, team_folder_name).

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



497
498
499
500
501
502
503
504
505
506
507
508
# File 'lib/google/apis/dataform_v1/service.rb', line 497

def patch_project_location_folder(name, folder_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DataformV1::Folder::Representation
  command.request_object = folder_object
  command.response_representation = Google::Apis::DataformV1::Folder::Representation
  command.response_class = Google::Apis::DataformV1::Folder
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_repository(name, repository_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Repository

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 (String)

    Identifier. The repository's name.

  • repository_object (Google::Apis::DataformV1::Repository) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
# File 'lib/google/apis/dataform_v1/service.rb', line 1190

def patch_project_location_repository(name, repository_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DataformV1::Repository::Representation
  command.request_object = repository_object
  command.response_representation = Google::Apis::DataformV1::Repository::Representation
  command.response_class = Google::Apis::DataformV1::Repository
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_repository_release_config(name, release_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ReleaseConfig

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 (String)

    Identifier. The release config's name.

  • release_config_object (Google::Apis::DataformV1::ReleaseConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
# File 'lib/google/apis/dataform_v1/service.rb', line 1693

def patch_project_location_repository_release_config(name, release_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DataformV1::ReleaseConfig::Representation
  command.request_object = release_config_object
  command.response_representation = Google::Apis::DataformV1::ReleaseConfig::Representation
  command.response_class = Google::Apis::DataformV1::ReleaseConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_repository_workflow_config(name, workflow_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::WorkflowConfig

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 (String)

    Identifier. The workflow config's name.

  • workflow_config_object (Google::Apis::DataformV1::WorkflowConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
# File 'lib/google/apis/dataform_v1/service.rb', line 1873

def patch_project_location_repository_workflow_config(name, workflow_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DataformV1::WorkflowConfig::Representation
  command.request_object = workflow_config_object
  command.response_representation = Google::Apis::DataformV1::WorkflowConfig::Representation
  command.response_class = Google::Apis::DataformV1::WorkflowConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_team_folder(name, team_folder_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::TeamFolder

Updates a single TeamFolder.

Parameters:

  • name (String)

    Identifier. The TeamFolder's name.

  • team_folder_object (Google::Apis::DataformV1::TeamFolder) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Specifies the fields to be updated in the Folder. If left unset, all fields will be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
# File 'lib/google/apis/dataform_v1/service.rb', line 3168

def patch_project_location_team_folder(name, team_folder_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DataformV1::TeamFolder::Representation
  command.request_object = team_folder_object
  command.response_representation = Google::Apis::DataformV1::TeamFolder::Representation
  command.response_class = Google::Apis::DataformV1::TeamFolder
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#pull_workspace_git_commits(name, pull_git_commits_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::PullGitCommitsResponse

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

Parameters:

  • name (String)

    Required. The workspace's name.

  • pull_git_commits_request_object (Google::Apis::DataformV1::PullGitCommitsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
# File 'lib/google/apis/dataform_v1/service.rb', line 2583

def pull_workspace_git_commits(name, pull_git_commits_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:pull', options)
  command.request_representation = Google::Apis::DataformV1::PullGitCommitsRequest::Representation
  command.request_object = pull_git_commits_request_object
  command.response_representation = Google::Apis::DataformV1::PullGitCommitsResponse::Representation
  command.response_class = Google::Apis::DataformV1::PullGitCommitsResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#push_workspace_git_commits(name, push_git_commits_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::PushGitCommitsResponse

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

Parameters:

  • name (String)

    Required. The workspace's name.

  • push_git_commits_request_object (Google::Apis::DataformV1::PushGitCommitsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
# File 'lib/google/apis/dataform_v1/service.rb', line 2616

def push_workspace_git_commits(name, push_git_commits_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:push', options)
  command.request_representation = Google::Apis::DataformV1::PushGitCommitsRequest::Representation
  command.request_object = push_git_commits_request_object
  command.response_representation = Google::Apis::DataformV1::PushGitCommitsResponse::Representation
  command.response_class = Google::Apis::DataformV1::PushGitCommitsResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_project_location_folder_folder_contents(folder, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::QueryFolderContentsResponse

Returns the contents of a given Folder.

Parameters:

  • folder (String)

    Required. Resource name of the Folder to list contents for. Format: projects// locations//folders/*

  • filter (String) (defaults to: nil)

    Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field. Example: * filter="display_name=" MyFolder""

  • order_by (String) (defaults to: nil)

    Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples: * orderBy=" display_name" * orderBy="display_name desc"

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous QueryFolderContents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryFolderContents, with the exception of page_size , must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'lib/google/apis/dataform_v1/service.rb', line 548

def query_project_location_folder_folder_contents(folder, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+folder}:queryFolderContents', options)
  command.response_representation = Google::Apis::DataformV1::QueryFolderContentsResponse::Representation
  command.response_class = Google::Apis::DataformV1::QueryFolderContentsResponse
  command.params['folder'] = folder unless folder.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_project_location_repository_compilation_result(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::QueryCompilationResultActionsResponse

Returns CompilationResultActions in a given CompilationResult.

Parameters:

  • name (String)

    Required. The compilation result's name.

  • filter (String) (defaults to: nil)

    Optional. Optional filter for the returned list. Filtering is only currently supported on the file_path field.

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous QueryCompilationResultActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryCompilationResultActions, with the exception of page_size, must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
# File 'lib/google/apis/dataform_v1/service.rb', line 1513

def query_project_location_repository_compilation_result(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:query', options)
  command.response_representation = Google::Apis::DataformV1::QueryCompilationResultActionsResponse::Representation
  command.response_class = Google::Apis::DataformV1::QueryCompilationResultActionsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_project_location_repository_directory_contents(name, commit_sha: nil, page_size: nil, page_token: nil, path: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::QueryRepositoryDirectoryContentsResponse

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

Parameters:

  • name (String)

    Required. The repository's name.

  • commit_sha (String) (defaults to: nil)

    Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD.

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous QueryRepositoryDirectoryContents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryRepositoryDirectoryContents, with the exception of page_size, must match the call that provided the page token.

  • path (String) (defaults to: nil)

    Optional. The directory's full path including directory name, relative to root. If left unset, the root is used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
# File 'lib/google/apis/dataform_v1/service.rb', line 1239

def query_project_location_repository_directory_contents(name, commit_sha: nil, page_size: nil, page_token: nil, path: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:queryDirectoryContents', options)
  command.response_representation = Google::Apis::DataformV1::QueryRepositoryDirectoryContentsResponse::Representation
  command.response_class = Google::Apis::DataformV1::QueryRepositoryDirectoryContentsResponse
  command.params['name'] = name unless name.nil?
  command.query['commitSha'] = commit_sha unless commit_sha.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['path'] = path unless path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_project_location_repository_workflow_invocation(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::QueryWorkflowInvocationActionsResponse

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Parameters:

  • name (String)

    Required. The workflow invocation's name.

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous QueryWorkflowInvocationActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryWorkflowInvocationActions, with the exception of page_size, must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
# File 'lib/google/apis/dataform_v1/service.rb', line 2092

def query_project_location_repository_workflow_invocation(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:query', options)
  command.response_representation = Google::Apis::DataformV1::QueryWorkflowInvocationActionsResponse::Representation
  command.response_class = Google::Apis::DataformV1::QueryWorkflowInvocationActionsResponse
  command.params['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_project_location_repository_workspace_directory_contents(workspace, page_size: nil, page_token: nil, path: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::QueryDirectoryContentsResponse

Returns the contents of a given Workspace directory.

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous QueryDirectoryContents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryDirectoryContents, with the exception of page_size, must match the call that provided the page token.

  • path (String) (defaults to: nil)

    Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.

  • view (String) (defaults to: nil)

    Optional. Specifies the metadata to return for each directory entry. If unspecified, the default is DIRECTORY_CONTENTS_VIEW_BASIC. Currently the DIRECTORY_CONTENTS_VIEW_METADATA view is not supported by CMEK-protected workspaces.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
# File 'lib/google/apis/dataform_v1/service.rb', line 2664

def query_project_location_repository_workspace_directory_contents(workspace, page_size: nil, page_token: nil, path: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+workspace}:queryDirectoryContents', options)
  command.response_representation = Google::Apis::DataformV1::QueryDirectoryContentsResponse::Representation
  command.response_class = Google::Apis::DataformV1::QueryDirectoryContentsResponse
  command.params['workspace'] = workspace unless workspace.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['path'] = path unless path.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_project_location_team_folder_contents(team_folder, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::QueryTeamFolderContentsResponse

Returns the contents of a given TeamFolder.

Parameters:

  • team_folder (String)

    Required. Resource name of the TeamFolder to list contents for. Format: projects/*/locations/*/teamFolders/*.

  • filter (String) (defaults to: nil)

    Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field. Example: * filter="display_name=" MyFolder""

  • order_by (String) (defaults to: nil)

    Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples: * orderBy="display_name" * orderBy="display_name desc"

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous QueryTeamFolderContents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryTeamFolderContents, with the exception of page_size, must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
# File 'lib/google/apis/dataform_v1/service.rb', line 3219

def query_project_location_team_folder_contents(team_folder, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+teamFolder}:queryContents', options)
  command.response_representation = Google::Apis::DataformV1::QueryTeamFolderContentsResponse::Representation
  command.response_class = Google::Apis::DataformV1::QueryTeamFolderContentsResponse
  command.params['teamFolder'] = team_folder unless team_folder.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_project_location_user_root_contents(location, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::QueryUserRootContentsResponse

Returns the contents of a caller's root folder in a given location. The root folder contains all resources that are created by the user and not contained in any other folder.

Parameters:

  • location (String)

    Required. Location of the user root folder to list contents for. Format: projects//locations/

  • filter (String) (defaults to: nil)

    Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field. Example: * filter="display_name=" MyFolder""

  • order_by (String) (defaults to: nil)

    Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), created_at, last_modified_at. Examples: * orderBy=" display_name" * orderBy="display_name desc"

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous QueryUserRootContents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryUserRootFolderContents, with the exception of page_size, must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/google/apis/dataform_v1/service.rb', line 211

def query_project_location_user_root_contents(location, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+location}:queryUserRootContents', options)
  command.response_representation = Google::Apis::DataformV1::QueryUserRootContentsResponse::Representation
  command.response_class = Google::Apis::DataformV1::QueryUserRootContentsResponse
  command.params['location'] = location unless location.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#read_project_location_repository_file(name, commit_sha: nil, path: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ReadRepositoryFileResponse

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

Parameters:

  • name (String)

    Required. The repository's name.

  • commit_sha (String) (defaults to: nil)

    Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD.

  • path (String) (defaults to: nil)

    Required. Full file path to read including filename, from repository root.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
# File 'lib/google/apis/dataform_v1/service.rb', line 1279

def read_project_location_repository_file(name, commit_sha: nil, path: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:readFile', options)
  command.response_representation = Google::Apis::DataformV1::ReadRepositoryFileResponse::Representation
  command.response_class = Google::Apis::DataformV1::ReadRepositoryFileResponse
  command.params['name'] = name unless name.nil?
  command.query['commitSha'] = commit_sha unless commit_sha.nil?
  command.query['path'] = path unless path.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#read_project_location_repository_workspace_file(workspace, path: nil, revision: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ReadFileResponse

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

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • path (String) (defaults to: nil)

    Required. The file's full path including filename, relative to the workspace root.

  • revision (String) (defaults to: nil)

    Optional. The Git revision of the file to return. If left empty, the current contents of path will be returned.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
# File 'lib/google/apis/dataform_v1/service.rb', line 2704

def read_project_location_repository_workspace_file(workspace, path: nil, revision: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+workspace}:readFile', options)
  command.response_representation = Google::Apis::DataformV1::ReadFileResponse::Representation
  command.response_class = Google::Apis::DataformV1::ReadFileResponse
  command.params['workspace'] = workspace unless workspace.nil?
  command.query['path'] = path unless path.nil?
  command.query['revision'] = revision unless revision.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#remove_workspace_directory(workspace, remove_directory_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::RemoveDirectoryResponse

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

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • remove_directory_request_object (Google::Apis::DataformV1::RemoveDirectoryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
# File 'lib/google/apis/dataform_v1/service.rb', line 2737

def remove_workspace_directory(workspace, remove_directory_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+workspace}:removeDirectory', options)
  command.request_representation = Google::Apis::DataformV1::RemoveDirectoryRequest::Representation
  command.request_object = remove_directory_request_object
  command.response_representation = Google::Apis::DataformV1::RemoveDirectoryResponse::Representation
  command.response_class = Google::Apis::DataformV1::RemoveDirectoryResponse
  command.params['workspace'] = workspace unless workspace.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#remove_workspace_file(workspace, remove_file_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::RemoveFileResponse

Deletes a file (inside a Workspace).

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • remove_file_request_object (Google::Apis::DataformV1::RemoveFileRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'lib/google/apis/dataform_v1/service.rb', line 2770

def remove_workspace_file(workspace, remove_file_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+workspace}:removeFile', options)
  command.request_representation = Google::Apis::DataformV1::RemoveFileRequest::Representation
  command.request_object = remove_file_request_object
  command.response_representation = Google::Apis::DataformV1::RemoveFileResponse::Representation
  command.response_class = Google::Apis::DataformV1::RemoveFileResponse
  command.params['workspace'] = workspace unless workspace.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_workspace_changes(name, reset_workspace_changes_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::ResetWorkspaceChangesResponse

Performs a Git reset for uncommitted files in a Workspace.

Parameters:

  • name (String)

    Required. The workspace's name.

  • reset_workspace_changes_request_object (Google::Apis::DataformV1::ResetWorkspaceChangesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
# File 'lib/google/apis/dataform_v1/service.rb', line 2803

def reset_workspace_changes(name, reset_workspace_changes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:reset', options)
  command.request_representation = Google::Apis::DataformV1::ResetWorkspaceChangesRequest::Representation
  command.request_object = reset_workspace_changes_request_object
  command.response_representation = Google::Apis::DataformV1::ResetWorkspaceChangesResponse::Representation
  command.response_class = Google::Apis::DataformV1::ResetWorkspaceChangesResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_repository_workspace_files(workspace, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::SearchFilesResponse

Finds the contents of a given Workspace directory by filter.

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • filter (String) (defaults to: nil)

    Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the path field. See https://google.aip.dev/ 160 for details.

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of search results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous SearchFilesRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchFilesRequest, with the exception of page_size, must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
# File 'lib/google/apis/dataform_v1/service.rb', line 2848

def search_project_location_repository_workspace_files(workspace, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+workspace}:searchFiles', options)
  command.response_representation = Google::Apis::DataformV1::SearchFilesResponse::Representation
  command.response_class = Google::Apis::DataformV1::SearchFilesResponse
  command.params['workspace'] = workspace unless workspace.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_team_folders(location, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::SearchTeamFoldersResponse

Returns all TeamFolders in a given location that the caller has access to and match the provided filter.

Parameters:

  • location (String)

    Required. Location in which to query TeamFolders. Format: projects/*/ locations/*.

  • filter (String) (defaults to: nil)

    Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field. Example: * filter="display_name=" MyFolder""

  • order_by (String) (defaults to: nil)

    Optional. Field to additionally sort results by. Supported keywords: display_name (default), create_time, last_modified_time. Examples: * orderBy="display_name" * orderBy="display_name desc"

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. Page token received from a previous SearchTeamFolders call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchTeamFolders, with the exception of page_size, must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'lib/google/apis/dataform_v1/service.rb', line 3272

def search_project_location_team_folders(location, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+location}/teamFolders:search', options)
  command.response_representation = Google::Apis::DataformV1::SearchTeamFoldersResponse::Representation
  command.response_class = Google::Apis::DataformV1::SearchTeamFoldersResponse
  command.params['location'] = location unless location.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_folder_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::DataformV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



587
588
589
590
591
592
593
594
595
596
597
# File 'lib/google/apis/dataform_v1/service.rb', line 587

def set_folder_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataformV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataformV1::Policy::Representation
  command.response_class = Google::Apis::DataformV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_repository_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::DataformV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
# File 'lib/google/apis/dataform_v1/service.rb', line 1316

def set_repository_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataformV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataformV1::Policy::Representation
  command.response_class = Google::Apis::DataformV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_team_folder_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::DataformV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
# File 'lib/google/apis/dataform_v1/service.rb', line 3311

def set_team_folder_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataformV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataformV1::Policy::Representation
  command.response_class = Google::Apis::DataformV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_workspace_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::DataformV1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
# File 'lib/google/apis/dataform_v1/service.rb', line 2886

def set_workspace_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataformV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataformV1::Policy::Representation
  command.response_class = Google::Apis::DataformV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_folder_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::DataformV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



626
627
628
629
630
631
632
633
634
635
636
# File 'lib/google/apis/dataform_v1/service.rb', line 626

def test_folder_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataformV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataformV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataformV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_repository_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::DataformV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/google/apis/dataform_v1/service.rb', line 1355

def test_repository_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataformV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataformV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataformV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_team_folder_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::DataformV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
# File 'lib/google/apis/dataform_v1/service.rb', line 3350

def test_team_folder_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataformV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataformV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataformV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_workspace_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::DataformV1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
# File 'lib/google/apis/dataform_v1/service.rb', line 2925

def test_workspace_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataformV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataformV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataformV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_config(name, config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::Config

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 (String)

    Identifier. The config name.

  • config_object (Google::Apis::DataformV1::Config) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Specifies the fields to be updated in the config.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/google/apis/dataform_v1/service.rb', line 251

def update_project_location_config(name, config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::DataformV1::Config::Representation
  command.request_object = config_object
  command.response_representation = Google::Apis::DataformV1::Config::Representation
  command.response_class = Google::Apis::DataformV1::Config
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#write_workspace_file(workspace, write_file_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1::WriteFileResponse

Writes to a file (inside a Workspace).

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • write_file_request_object (Google::Apis::DataformV1::WriteFileRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
# File 'lib/google/apis/dataform_v1/service.rb', line 2958

def write_workspace_file(workspace, write_file_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+workspace}:writeFile', options)
  command.request_representation = Google::Apis::DataformV1::WriteFileRequest::Representation
  command.request_object = write_file_request_object
  command.response_representation = Google::Apis::DataformV1::WriteFileResponse::Representation
  command.response_class = Google::Apis::DataformV1::WriteFileResponse
  command.params['workspace'] = workspace unless workspace.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end