Dataform API . projects . locations . repositories

Instance Methods

compilationResults()

Returns the compilationResults Resource.

releaseConfigs()

Returns the releaseConfigs Resource.

workflowConfigs()

Returns the workflowConfigs Resource.

workflowInvocations()

Returns the workflowInvocations Resource.

workspaces()

Returns the workspaces Resource.

close()

Close httplib2 connections.

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

Creates a new Repository in a given project and location.

delete(name, force=None, x__xgafv=None)

Deletes a single Repository.

fetchRemoteBranches(name, x__xgafv=None)

Fetches a Repository's remote branches.

get(name, x__xgafv=None)

Fetches a single Repository.

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

Lists Repositories in a given project and location.

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a single Repository.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, repositoryId=None, x__xgafv=None)
Creates a new Repository in a given project and location.

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

{ # Represents a Dataform Git repository.
  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
    "authenticationTokenSecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    "defaultBranch": "A String", # Required. The Git remote's default branch name.
    "tokenStatus": "A String", # Output only. Indicates the status of the Git access token.
    "url": "A String", # Required. The Git remote's URL.
  },
  "name": "A String", # Output only. The repository's name.
  "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
}

  repositoryId: string, Required. The ID to use for the repository, which will become the final component of the repository'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 repository.
  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
    "authenticationTokenSecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    "defaultBranch": "A String", # Required. The Git remote's default branch name.
    "tokenStatus": "A String", # Output only. Indicates the status of the Git access token.
    "url": "A String", # Required. The Git remote's URL.
  },
  "name": "A String", # Output only. The repository's name.
  "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
}
delete(name, force=None, x__xgafv=None)
Deletes a single Repository.

Args:
  name: string, Required. The repository's name. (required)
  force: boolean, 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.)
  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); }
}
fetchRemoteBranches(name, x__xgafv=None)
Fetches a Repository's remote branches.

Args:
  name: string, Required. The repository'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:

    { # `FetchRemoteBranches` response message.
  "branches": [ # The remote repository's branch names.
    "A String",
  ],
}
get(name, x__xgafv=None)
Fetches a single Repository.

Args:
  name: string, Required. The repository'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 repository.
  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
    "authenticationTokenSecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    "defaultBranch": "A String", # Required. The Git remote's default branch name.
    "tokenStatus": "A String", # Output only. Indicates the status of the Git access token.
    "url": "A String", # Required. The Git remote's URL.
  },
  "name": "A String", # Output only. The repository's name.
  "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Repositories in a given project and location.

Args:
  parent: string, Required. The location in which to list repositories. Must be in the format `projects/*/locations/*`. (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 repositories 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 `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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # `ListRepositories` 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.
  "repositories": [ # List of repositories.
    { # Represents a Dataform Git repository.
      "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
        "authenticationTokenSecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
        "defaultBranch": "A String", # Required. The Git remote's default branch name.
        "tokenStatus": "A String", # Output only. Indicates the status of the Git access token.
        "url": "A String", # Required. The Git remote's URL.
      },
      "name": "A String", # Output only. The repository's name.
      "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
    },
  ],
  "unreachable": [ # Locations which could not be reached.
    "A String",
  ],
}
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.
        
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a single Repository.

Args:
  name: string, Output only. The repository's name. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a Dataform Git repository.
  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
    "authenticationTokenSecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    "defaultBranch": "A String", # Required. The Git remote's default branch name.
    "tokenStatus": "A String", # Output only. Indicates the status of the Git access token.
    "url": "A String", # Required. The Git remote's URL.
  },
  "name": "A String", # Output only. The repository's name.
  "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
}

  updateMask: string, Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.
  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 repository.
  "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
    "authenticationTokenSecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
    "defaultBranch": "A String", # Required. The Git remote's default branch name.
    "tokenStatus": "A String", # Output only. Indicates the status of the Git access token.
    "url": "A String", # Required. The Git remote's URL.
  },
  "name": "A String", # Output only. The repository's name.
  "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
}