Dataform V1beta1 API - Class Google::Cloud::Dataform::V1beta1::CheckoutWorkspaceBranchRequest (v1.3.0)

Reference documentation and code samples for the Dataform V1beta1 API class Google::Cloud::Dataform::V1beta1::CheckoutWorkspaceBranchRequest.

CheckoutWorkspaceBranch request message.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#branch

def branch() -> ::String
Returns
  • (::String) — Required. The name of the branch in the Git repository to which the workspace should be checked out.

#branch=

def branch=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the branch in the Git repository to which the workspace should be checked out.
Returns
  • (::String) — Required. The name of the branch in the Git repository to which the workspace should be checked out.

#create_if_not_exists

def create_if_not_exists() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set to true and the branch does not exist, it will be created. Otherwise, an error will be thrown.

#create_if_not_exists=

def create_if_not_exists=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If set to true and the branch does not exist, it will be created. Otherwise, an error will be thrown.
Returns
  • (::Boolean) — Optional. If set to true and the branch does not exist, it will be created. Otherwise, an error will be thrown.

#name

def name() -> ::String
Returns
  • (::String) — Required. The workspace resource name. Format: projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The workspace resource name. Format: projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}
Returns
  • (::String) — Required. The workspace resource name. Format: projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}

#source_branch

def source_branch() -> ::String
Returns
  • (::String) — Optional. The name of the branch in the Git repository from which the new branch should be created. If left unset, the workspace's current branch name will be used. Accepts only branch names from FetchWorkspaceBranches response, and can only be set if create_if_not_exists is true. Oherwise, an error will be thrown.

#source_branch=

def source_branch=(value) -> ::String
Parameter
  • value (::String) — Optional. The name of the branch in the Git repository from which the new branch should be created. If left unset, the workspace's current branch name will be used. Accepts only branch names from FetchWorkspaceBranches response, and can only be set if create_if_not_exists is true. Oherwise, an error will be thrown.
Returns
  • (::String) — Optional. The name of the branch in the Git repository from which the new branch should be created. If left unset, the workspace's current branch name will be used. Accepts only branch names from FetchWorkspaceBranches response, and can only be set if create_if_not_exists is true. Oherwise, an error will be thrown.