Class: Google::Apis::DataformV1beta1::DataformService

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

Overview

Dataform API

Examples:

require 'google/apis/dataform_v1beta1'

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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeDataformService

Returns a new instance of DataformService.



45
46
47
48
49
50
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 45

def initialize
  super('https://dataform.googleapis.com/', '',
        client_name: 'google-apis-dataform_v1beta1',
        client_version: Google::Apis::DataformV1beta1::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.



38
39
40
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 38

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.



43
44
45
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

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

Requests cancellation of a running WorkflowInvocation.

Parameters:

  • name (String)

    Required. The workflow invocation resource's name.

  • cancel_workflow_invocation_request_object (Google::Apis::DataformV1beta1::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



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

def cancel_workflow_invocation(name, cancel_workflow_invocation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.request_representation = Google::Apis::DataformV1beta1::CancelWorkflowInvocationRequest::Representation
  command.request_object = cancel_workflow_invocation_request_object
  command.response_representation = Google::Apis::DataformV1beta1::Empty::Representation
  command.response_class = Google::Apis::DataformV1beta1::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

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

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::DataformV1beta1::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



150
151
152
153
154
155
156
157
158
159
160
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 150

def commit_repository_changes(name, commit_repository_changes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:commit', options)
  command.request_representation = Google::Apis::DataformV1beta1::CommitRepositoryChangesRequest::Representation
  command.request_object = commit_repository_changes_request_object
  command.response_representation = Google::Apis::DataformV1beta1::Empty::Representation
  command.response_class = Google::Apis::DataformV1beta1::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

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

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::DataformV1beta1::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



1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1407

def commit_workspace_changes(name, commit_workspace_changes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:commit', options)
  command.request_representation = Google::Apis::DataformV1beta1::CommitWorkspaceChangesRequest::Representation
  command.request_object = commit_workspace_changes_request_object
  command.response_representation = Google::Apis::DataformV1beta1::Empty::Representation
  command.response_class = Google::Apis::DataformV1beta1::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

#compute_project_location_repository_access_token_status(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1beta1::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



182
183
184
185
186
187
188
189
190
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 182

def compute_project_location_repository_access_token_status(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}:computeAccessTokenStatus', options)
  command.response_representation = Google::Apis::DataformV1beta1::ComputeRepositoryAccessTokenStatusResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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_repository(parent, repository_object = nil, repository_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1beta1::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::DataformV1beta1::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



217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 217

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, 'v1beta1/{+parent}/repositories', options)
  command.request_representation = Google::Apis::DataformV1beta1::Repository::Representation
  command.request_object = repository_object
  command.response_representation = Google::Apis::DataformV1beta1::Repository::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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::DataformV1beta1::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



685
686
687
688
689
690
691
692
693
694
695
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 685

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, 'v1beta1/{+parent}/compilationResults', options)
  command.request_representation = Google::Apis::DataformV1beta1::CompilationResult::Representation
  command.request_object = compilation_result_object
  command.response_representation = Google::Apis::DataformV1beta1::CompilationResult::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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::DataformV1beta1::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



839
840
841
842
843
844
845
846
847
848
849
850
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 839

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, 'v1beta1/{+parent}/releaseConfigs', options)
  command.request_representation = Google::Apis::DataformV1beta1::ReleaseConfig::Representation
  command.request_object = release_config_object
  command.response_representation = Google::Apis::DataformV1beta1::ReleaseConfig::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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::DataformV1beta1::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



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1016

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, 'v1beta1/{+parent}/workflowConfigs', options)
  command.request_representation = Google::Apis::DataformV1beta1::WorkflowConfig::Representation
  command.request_object = workflow_config_object
  command.response_representation = Google::Apis::DataformV1beta1::WorkflowConfig::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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::DataformV1beta1::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



1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1223

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, 'v1beta1/{+parent}/workflowInvocations', options)
  command.request_representation = Google::Apis::DataformV1beta1::WorkflowInvocation::Representation
  command.request_object = workflow_invocation_object
  command.response_representation = Google::Apis::DataformV1beta1::WorkflowInvocation::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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::DataformV1beta1::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



1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1444

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, 'v1beta1/{+parent}/workspaces', options)
  command.request_representation = Google::Apis::DataformV1beta1::Workspace::Representation
  command.request_object = workspace_object
  command.response_representation = Google::Apis::DataformV1beta1::Workspace::Representation
  command.response_class = Google::Apis::DataformV1beta1::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

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

Deletes a single Repository.

Parameters:

  • name (String)

    Required. The repository's name.

  • force (Boolean) (defaults to: nil)

    If set to true, any child resources of this repository will also be deleted. ( Otherwise, the request will only succeed if the repository has no child resources.)

  • 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



254
255
256
257
258
259
260
261
262
263
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 254

def delete_project_location_repository(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1beta1::Empty::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



872
873
874
875
876
877
878
879
880
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 872

def delete_project_location_repository_release_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1beta1::Empty::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



1049
1050
1051
1052
1053
1054
1055
1056
1057
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1049

def delete_project_location_repository_workflow_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1beta1::Empty::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



1255
1256
1257
1258
1259
1260
1261
1262
1263
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1255

def delete_project_location_repository_workflow_invocation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1beta1::Empty::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



1477
1478
1479
1480
1481
1482
1483
1484
1485
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1477

def delete_project_location_repository_workspace(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1beta1::Empty::Representation
  command.response_class = Google::Apis::DataformV1beta1::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

#fetch_project_location_repository_history(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1beta1::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 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



295
296
297
298
299
300
301
302
303
304
305
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 295

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, 'v1beta1/{+name}:fetchHistory', options)
  command.response_representation = Google::Apis::DataformV1beta1::FetchRepositoryHistoryResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



327
328
329
330
331
332
333
334
335
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 327

def fetch_project_location_repository_remote_branches(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}:fetchRemoteBranches', options)
  command.response_representation = Google::Apis::DataformV1beta1::FetchRemoteBranchesResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1510

def fetch_project_location_repository_workspace_file_diff(workspace, path: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+workspace}:fetchFileDiff', options)
  command.response_representation = Google::Apis::DataformV1beta1::FetchFileDiffResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



1541
1542
1543
1544
1545
1546
1547
1548
1549
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1541

def fetch_project_location_repository_workspace_file_git_statuses(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}:fetchFileGitStatuses', options)
  command.response_representation = Google::Apis::DataformV1beta1::FetchFileGitStatusesResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1575

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, 'v1beta1/{+name}:fetchGitAheadBehind', options)
  command.response_representation = Google::Apis::DataformV1beta1::FetchGitAheadBehindResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



72
73
74
75
76
77
78
79
80
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 72

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1beta1::Location::Representation
  command.response_class = Google::Apis::DataformV1beta1::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_repository(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1beta1::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



357
358
359
360
361
362
363
364
365
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 357

def get_project_location_repository(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1beta1::Repository::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



717
718
719
720
721
722
723
724
725
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 717

def get_project_location_repository_compilation_result(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1beta1::CompilationResult::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



401
402
403
404
405
406
407
408
409
410
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 401

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, 'v1beta1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::DataformV1beta1::Policy::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



902
903
904
905
906
907
908
909
910
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 902

def get_project_location_repository_release_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1beta1::ReleaseConfig::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



1079
1080
1081
1082
1083
1084
1085
1086
1087
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1079

def get_project_location_repository_workflow_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1beta1::WorkflowConfig::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



1285
1286
1287
1288
1289
1290
1291
1292
1293
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1285

def get_project_location_repository_workflow_invocation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1beta1::WorkflowInvocation::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



1606
1607
1608
1609
1610
1611
1612
1613
1614
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1606

def get_project_location_repository_workspace(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::DataformV1beta1::Workspace::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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



1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1650

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, 'v1beta1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::DataformV1beta1::Policy::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::InstallNpmPackagesResponse

Installs dependency NPM packages (inside a Workspace).

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • install_npm_packages_request_object (Google::Apis::DataformV1beta1::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



1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1682

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, 'v1beta1/{+workspace}:installNpmPackages', options)
  command.request_representation = Google::Apis::DataformV1beta1::InstallNpmPackagesRequest::Representation
  command.request_object = install_npm_packages_request_object
  command.response_representation = Google::Apis::DataformV1beta1::InstallNpmPackagesResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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_repositories(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1beta1::ListRepositoriesResponse

Lists Repositories in a given project and location.

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



448
449
450
451
452
453
454
455
456
457
458
459
460
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 448

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, 'v1beta1/{+parent}/repositories', options)
  command.response_representation = Google::Apis::DataformV1beta1::ListRepositoriesResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1beta1::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/*.

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



757
758
759
760
761
762
763
764
765
766
767
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 757

def list_project_location_repository_compilation_results(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/compilationResults', options)
  command.response_representation = Google::Apis::DataformV1beta1::ListCompilationResultsResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::ListCompilationResultsResponse
  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_release_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1beta1::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 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



942
943
944
945
946
947
948
949
950
951
952
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 942

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, 'v1beta1/{+parent}/releaseConfigs', options)
  command.response_representation = Google::Apis::DataformV1beta1::ListReleaseConfigsResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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 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



1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1119

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, 'v1beta1/{+parent}/workflowConfigs', options)
  command.response_representation = Google::Apis::DataformV1beta1::ListWorkflowConfigsResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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 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



1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1331

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, 'v1beta1/{+parent}/workflowInvocations', options)
  command.response_representation = Google::Apis::DataformV1beta1::ListWorkflowInvocationsResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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 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



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

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, 'v1beta1/{+parent}/workspaces', options)
  command.response_representation = Google::Apis::DataformV1beta1::ListWorkspacesResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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, filter: nil, include_unrevealed_locations: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1beta1::ListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String)

    The resource that owns the locations collection, if applicable.

  • 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.

  • include_unrevealed_locations (Boolean) (defaults to: nil)

    If true, the returned list will include locations which are not yet revealed.

  • 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



114
115
116
117
118
119
120
121
122
123
124
125
126
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 114

def list_project_locations(name, filter: nil, include_unrevealed_locations: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/locations', options)
  command.response_representation = Google::Apis::DataformV1beta1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['includeUnrevealedLocations'] = include_unrevealed_locations unless include_unrevealed_locations.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::DataformV1beta1::MakeDirectoryResponse

Creates a directory inside a Workspace.

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • make_directory_request_object (Google::Apis::DataformV1beta1::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



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

def make_workspace_directory(workspace, make_directory_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+workspace}:makeDirectory', options)
  command.request_representation = Google::Apis::DataformV1beta1::MakeDirectoryRequest::Representation
  command.request_object = make_directory_request_object
  command.response_representation = Google::Apis::DataformV1beta1::MakeDirectoryResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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_workspace_directory(workspace, move_directory_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1beta1::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::DataformV1beta1::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



1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1798

def move_workspace_directory(workspace, move_directory_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+workspace}:moveDirectory', options)
  command.request_representation = Google::Apis::DataformV1beta1::MoveDirectoryRequest::Representation
  command.request_object = move_directory_request_object
  command.response_representation = Google::Apis::DataformV1beta1::MoveDirectoryResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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::DataformV1beta1::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



1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1831

def move_workspace_file(workspace, move_file_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+workspace}:moveFile', options)
  command.request_representation = Google::Apis::DataformV1beta1::MoveFileRequest::Representation
  command.request_object = move_file_request_object
  command.response_representation = Google::Apis::DataformV1beta1::MoveFileResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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_repository(name, repository_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1beta1::Repository

Updates a single Repository.

Parameters:

  • name (String)

    Output only. The repository's name.

  • repository_object (Google::Apis::DataformV1beta1::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



486
487
488
489
490
491
492
493
494
495
496
497
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 486

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, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::DataformV1beta1::Repository::Representation
  command.request_object = repository_object
  command.response_representation = Google::Apis::DataformV1beta1::Repository::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::ReleaseConfig

Updates a single ReleaseConfig.

Parameters:

  • name (String)

    Output only. The release config's name.

  • release_config_object (Google::Apis::DataformV1beta1::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



978
979
980
981
982
983
984
985
986
987
988
989
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 978

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, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::DataformV1beta1::ReleaseConfig::Representation
  command.request_object = release_config_object
  command.response_representation = Google::Apis::DataformV1beta1::ReleaseConfig::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::WorkflowConfig

Updates a single WorkflowConfig.

Parameters:

  • name (String)

    Output only. The workflow config's name.

  • workflow_config_object (Google::Apis::DataformV1beta1::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



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1155

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, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::DataformV1beta1::WorkflowConfig::Representation
  command.request_object = workflow_config_object
  command.response_representation = Google::Apis::DataformV1beta1::WorkflowConfig::Representation
  command.response_class = Google::Apis::DataformV1beta1::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

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

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::DataformV1beta1::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



1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1864

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, 'v1beta1/{+name}:pull', options)
  command.request_representation = Google::Apis::DataformV1beta1::PullGitCommitsRequest::Representation
  command.request_object = pull_git_commits_request_object
  command.response_representation = Google::Apis::DataformV1beta1::Empty::Representation
  command.response_class = Google::Apis::DataformV1beta1::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

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

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::DataformV1beta1::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



1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1897

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, 'v1beta1/{+name}:push', options)
  command.request_representation = Google::Apis::DataformV1beta1::PushGitCommitsRequest::Representation
  command.request_object = push_git_commits_request_object
  command.response_representation = Google::Apis::DataformV1beta1::Empty::Representation
  command.response_class = Google::Apis::DataformV1beta1::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

#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::DataformV1beta1::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 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



801
802
803
804
805
806
807
808
809
810
811
812
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 801

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, 'v1beta1/{+name}:query', options)
  command.response_representation = Google::Apis::DataformV1beta1::QueryCompilationResultActionsResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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 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



535
536
537
538
539
540
541
542
543
544
545
546
547
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 535

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, 'v1beta1/{+name}:queryDirectoryContents', options)
  command.response_representation = Google::Apis::DataformV1beta1::QueryRepositoryDirectoryContentsResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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 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



1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1374

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, 'v1beta1/{+name}:query', options)
  command.response_representation = Google::Apis::DataformV1beta1::QueryWorkflowInvocationActionsResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1beta1::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 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.

  • 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



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

def query_project_location_repository_workspace_directory_contents(workspace, page_size: nil, page_token: nil, path: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+workspace}:queryDirectoryContents', options)
  command.response_representation = Google::Apis::DataformV1beta1::QueryDirectoryContentsResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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['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::DataformV1beta1::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



575
576
577
578
579
580
581
582
583
584
585
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 575

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, 'v1beta1/{+name}:readFile', options)
  command.response_representation = Google::Apis::DataformV1beta1::ReadRepositoryFileResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1beta1::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.

  • 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



1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 1976

def read_project_location_repository_workspace_file(workspace, path: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+workspace}:readFile', options)
  command.response_representation = Google::Apis::DataformV1beta1::ReadFileResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::ReadFileResponse
  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

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

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::DataformV1beta1::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



2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 2008

def remove_workspace_directory(workspace, remove_directory_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+workspace}:removeDirectory', options)
  command.request_representation = Google::Apis::DataformV1beta1::RemoveDirectoryRequest::Representation
  command.request_object = remove_directory_request_object
  command.response_representation = Google::Apis::DataformV1beta1::Empty::Representation
  command.response_class = Google::Apis::DataformV1beta1::Empty
  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::DataformV1beta1::Empty

Deletes a file (inside a Workspace).

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • remove_file_request_object (Google::Apis::DataformV1beta1::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



2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 2041

def remove_workspace_file(workspace, remove_file_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+workspace}:removeFile', options)
  command.request_representation = Google::Apis::DataformV1beta1::RemoveFileRequest::Representation
  command.request_object = remove_file_request_object
  command.response_representation = Google::Apis::DataformV1beta1::Empty::Representation
  command.response_class = Google::Apis::DataformV1beta1::Empty
  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::DataformV1beta1::Empty

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::DataformV1beta1::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



2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 2074

def reset_workspace_changes(name, reset_workspace_changes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:reset', options)
  command.request_representation = Google::Apis::DataformV1beta1::ResetWorkspaceChangesRequest::Representation
  command.request_object = reset_workspace_changes_request_object
  command.response_representation = Google::Apis::DataformV1beta1::Empty::Representation
  command.response_class = Google::Apis::DataformV1beta1::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

#set_repository_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1beta1::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::DataformV1beta1::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



612
613
614
615
616
617
618
619
620
621
622
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 612

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, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataformV1beta1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataformV1beta1::Policy::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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::DataformV1beta1::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



2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 2111

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, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::DataformV1beta1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::DataformV1beta1::Policy::Representation
  command.response_class = Google::Apis::DataformV1beta1::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_repository_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataformV1beta1::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::DataformV1beta1::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



651
652
653
654
655
656
657
658
659
660
661
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 651

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, 'v1beta1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataformV1beta1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataformV1beta1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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::DataformV1beta1::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::DataformV1beta1::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



2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 2150

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, 'v1beta1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::DataformV1beta1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::DataformV1beta1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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

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

Writes to a file (inside a Workspace).

Parameters:

  • workspace (String)

    Required. The workspace's name.

  • write_file_request_object (Google::Apis::DataformV1beta1::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



2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
# File 'lib/google/apis/dataform_v1beta1/service.rb', line 2183

def write_workspace_file(workspace, write_file_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+workspace}:writeFile', options)
  command.request_representation = Google::Apis::DataformV1beta1::WriteFileRequest::Representation
  command.request_object = write_file_request_object
  command.response_representation = Google::Apis::DataformV1beta1::WriteFileResponse::Representation
  command.response_class = Google::Apis::DataformV1beta1::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