0.18.0 (latest) 0.17.1 0.16.0 0.15.3 0.12.0 0.11.0 0.10.1 0.9.2 0.8.1 0.7.0 0.6.0 0.5.1 0.4.7 0.3.0 0.2.3 0.1.6

> [!WARNING]
> **Beta**
>
>
> This library is covered by the [Pre-GA Offerings Terms](https://docs.cloud.google.com/terms/service-terms#1)
> of the Terms of Service. Pre-GA libraries might have limited support,
> and changes to pre-GA libraries might not be compatible with other pre-GA versions.
> For more information, see the
> [launch stage descriptions](https://docs.cloud.google.com/products#product-launch-stages).

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

`CheckoutWorkspaceBranch` request message.

Generated from protobuf message `google.cloud.dataform.v1beta1.CheckoutWorkspaceBranchRequest`

## Namespace

Google \\ Cloud \\ Dataform \\ V1beta1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` Required. The workspace resource name. Format: projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace} |
| `↳ branch` | `string` Required. The name of the branch in the Git repository to which the workspace should be checked out. |
| `↳ create_if_not_exists` | `bool` Optional. If set to true and the branch does not exist, it will be created. Otherwise, an error will be thrown. |
| `↳ source_branch` | `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. |

### getName

Required. The workspace resource name.

Format:
projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

Required. The workspace resource name.

Format:
projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getBranch

Required. The name of the branch in the Git repository to which the
workspace should be checked out.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setBranch

Required. The name of the branch in the Git repository to which the
workspace should be checked out.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCreateIfNotExists

Optional. If set to true and the branch does not exist, it will be created.

Otherwise, an error will be thrown.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setCreateIfNotExists

Optional. If set to true and the branch does not exist, it will be created.

Otherwise, an error will be thrown.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSourceBranch

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** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setSourceBranch

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |