Dataform API . projects . locations . repositories . workspaces

close()

Close httplib2 connections.

commit(name, body=None, x__xgafv=None)

Applies a Git commit for uncommitted files in a Workspace.

Args:
  name: string, Required. The workspace's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # `CommitWorkspaceChanges` request message.
  "author": { # Represents the author of a Git commit. # Required. The commit's author.
    "emailAddress": "A String", # Required. The commit author's email address.
    "name": "A String", # Required. The commit author's name.
  },
  "commitMessage": "A String", # Optional. The commit's message.
  "paths": [ # Optional. Full file paths to commit including filename, rooted at workspace root. If left empty, all files will be committed.
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

create(parent, body=None, workspaceId=None, x__xgafv=None)

Creates a new Workspace in a given Repository.

Args:
  parent: string, Required. The repository in which to create the workspace. Must be in the format `projects/*/locations/*/repositories/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a Dataform Git workspace.
  "name": "A String", # Output only. The workspace's name.
}

  workspaceId: string, Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a Dataform Git workspace.
  "name": "A String", # Output only. The workspace's name.
}

delete(name, x__xgafv=None)

Deletes a single Workspace.

Args:
  name: string, Required. The workspace resource's name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

fetchFileDiff(workspace, path=None, x__xgafv=None)

Fetches Git diff for an uncommitted file in a Workspace.

Args:
  workspace: string, Required. The workspace's name. (required)
  path: string, Required. The file's full path including filename, relative to the workspace root.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `FetchFileDiff` response message.
  "formattedDiff": "A String", # The raw formatted Git diff for the file.
}

fetchFileGitStatuses(name, x__xgafv=None)

Fetches Git statuses for the files in a Workspace.

Args:
  name: string, Required. The workspace's name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `FetchFileGitStatuses` response message.
  "uncommittedFileChanges": [ # A list of all files which have uncommitted Git changes. There will only be a single entry for any given file.
    { # Represents the Git state of a file with uncommitted changes.
      "path": "A String", # The file's full path including filename, relative to the workspace root.
      "state": "A String", # Indicates the status of the file.
    },
  ],
}

fetchGitAheadBehind(name, remoteBranch=None, x__xgafv=None)

Fetches Git ahead/behind against a remote branch.

Args:
  name: string, Required. The workspace's name. (required)
  remoteBranch: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `FetchGitAheadBehind` response message.
  "commitsAhead": 42, # The number of commits in the remote branch that are not in the workspace.
  "commitsBehind": 42, # The number of commits in the workspace that are not in the remote branch.
}

get(name, x__xgafv=None)

Fetches a single Workspace.

Args:
  name: string, Required. The workspace's name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a Dataform Git workspace.
  "name": "A String", # Output only. The workspace's name.
}

installNpmPackages(workspace, body=None, x__xgafv=None)

Installs dependency NPM packages (inside a Workspace).

Args:
  workspace: string, Required. The workspace's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # `InstallNpmPackages` request message.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `InstallNpmPackages` response message.
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists Workspaces in a given Repository.

Args:
  parent: string, Required. The repository in which to list workspaces. Must be in the format `projects/*/locations/*/repositories/*`. (required)
  filter: string, Optional. Filter for the returned list.
  orderBy: string, 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.
  pageSize: integer, Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  pageToken: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `ListWorkspaces` response message.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "unreachable": [ # Locations which could not be reached.
    "A String",
  ],
  "workspaces": [ # List of workspaces.
    { # Represents a Dataform Git workspace.
      "name": "A String", # Output only. The workspace's name.
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

makeDirectory(workspace, body=None, x__xgafv=None)

Creates a directory inside a Workspace.

Args:
  workspace: string, Required. The workspace's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # `MakeDirectory` request message.
  "path": "A String", # Required. The directory's full path including directory name, relative to the workspace root.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `MakeDirectory` response message.
}

moveDirectory(workspace, body=None, x__xgafv=None)

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

Args:
  workspace: string, Required. The workspace's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # `MoveDirectory` request message.
  "newPath": "A String", # Required. The new path for the directory including directory name, rooted at workspace root.
  "path": "A String", # Required. The directory's full path including directory name, relative to the workspace root.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `MoveDirectory` response message.
}

moveFile(workspace, body=None, x__xgafv=None)

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

Args:
  workspace: string, Required. The workspace's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # `MoveFile` request message.
  "newPath": "A String", # Required. The file's new path including filename, relative to the workspace root.
  "path": "A String", # Required. The file's full path including filename, relative to the workspace root.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `MoveFile` response message.
}

pull(name, body=None, x__xgafv=None)

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

Args:
  name: string, Required. The workspace's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # `PullGitCommits` request message.
  "author": { # Represents the author of a Git commit. # Required. The author of any merge commit which may be created as a result of merging fetched Git commits into this workspace.
    "emailAddress": "A String", # Required. The commit author's email address.
    "name": "A String", # Required. The commit author's name.
  },
  "remoteBranch": "A String", # Optional. The name of the branch in the Git remote from which to pull commits. If left unset, the repository's default branch name will be used.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

push(name, body=None, x__xgafv=None)

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

Args:
  name: string, Required. The workspace's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # `PushGitCommits` request message.
  "remoteBranch": "A String", # Optional. The name of the branch in the Git remote to which commits should be pushed. If left unset, the repository's default branch name will be used.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

queryDirectoryContents(workspace, pageSize=None, pageToken=None, path=None, x__xgafv=None)

Returns the contents of a given Workspace directory.

Args:
  workspace: string, Required. The workspace's name. (required)
  pageSize: integer, Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  pageToken: string, 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, Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `QueryDirectoryContents` response message.
  "directoryEntries": [ # List of entries in the directory.
    { # Represents a single entry in a workspace directory.
      "directory": "A String", # A child directory in the directory.
      "file": "A String", # A file in the directory.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

queryDirectoryContents_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

readFile(workspace, path=None, x__xgafv=None)

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

Args:
  workspace: string, Required. The workspace's name. (required)
  path: string, Required. The file's full path including filename, relative to the workspace root.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `ReadFile` response message.
  "fileContents": "A String", # The file's contents.
}

removeDirectory(workspace, body=None, x__xgafv=None)

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

Args:
  workspace: string, Required. The workspace's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # `RemoveDirectory` request message.
  "path": "A String", # Required. The directory's full path including directory name, relative to the workspace root.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

removeFile(workspace, body=None, x__xgafv=None)

Deletes a file (inside a Workspace).

Args:
  workspace: string, Required. The workspace's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # `RemoveFile` request message.
  "path": "A String", # Required. The file's full path including filename, relative to the workspace root.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

reset(name, body=None, x__xgafv=None)

Performs a Git reset for uncommitted files in a Workspace.

Args:
  name: string, Required. The workspace's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # `ResetWorkspaceChanges` request message.
  "clean": True or False, # Optional. If set to true, untracked files will be deleted.
  "paths": [ # Optional. Full file paths to reset back to their committed state including filename, rooted at workspace root. If left empty, all files will be reset.
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

writeFile(workspace, body=None, x__xgafv=None)

Writes to a file (inside a Workspace).

Args:
  workspace: string, Required. The workspace's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # `WriteFile` request message.
  "contents": "A String", # Required. The file's contents.
  "path": "A String", # Required. The file.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `WriteFile` response message.
}