Cloud Build API . projects . locations . connections . repositories

Instance Methods

accessReadToken(repository, body=None, x__xgafv=None)

Fetches read token of a given repository.

accessReadWriteToken(repository, body=None, x__xgafv=None)

Fetches read/write token of a given repository.

batchCreate(parent, body=None, x__xgafv=None)

Creates multiple repositories inside a connection.

close()

Close httplib2 connections.

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

Creates a Repository.

delete(name, etag=None, validateOnly=None, x__xgafv=None)

Deletes a single repository.

fetchGitRefs(repository, pageSize=None, pageToken=None, refType=None, x__xgafv=None)

Fetch the list of branches or tags for a given repository.

fetchGitRefs_next()

Retrieves the next page of results.

get(name, x__xgafv=None)

Gets details of a single repository.

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

Lists Repositories in a given connection.

list_next()

Retrieves the next page of results.

Method Details

accessReadToken(repository, body=None, x__xgafv=None)
Fetches read token of a given repository.

Args:
  repository: string, Required. The resource name of the repository in the format `projects/*/locations/*/connections/*/repositories/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message for fetching SCM read token.
}

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

Returns:
  An object of the form:

    { # Message for responding to get read token.
  "expirationTime": "A String", # Expiration timestamp. Can be empty if unknown or non-expiring.
  "token": "A String", # The token content.
}
accessReadWriteToken(repository, body=None, x__xgafv=None)
Fetches read/write token of a given repository.

Args:
  repository: string, Required. The resource name of the repository in the format `projects/*/locations/*/connections/*/repositories/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message for fetching SCM read/write token.
}

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

Returns:
  An object of the form:

    { # Message for responding to get read/write token.
  "expirationTime": "A String", # Expiration timestamp. Can be empty if unknown or non-expiring.
  "token": "A String", # The token content.
}
batchCreate(parent, body=None, x__xgafv=None)
Creates multiple repositories inside a connection.

Args:
  parent: string, Required. The connection to contain all the repositories being created. Format: projects/*/locations/*/connections/* The parent field in the CreateRepositoryRequest messages must either be empty or match this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message for creating repositoritories in batch.
  "requests": [ # Required. The request messages specifying the repositories to create.
    { # Message for creating a Repository.
      "parent": "A String", # Required. The connection to contain the repository. If the request is part of a BatchCreateRepositoriesRequest, this field should be empty or match the parent specified there.
      "repository": { # A repository associated to a parent connection. # Required. The repository to create.
        "annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
          "a_key": "A String",
        },
        "createTime": "A String", # Output only. Server assigned timestamp for when the connection was created.
        "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
        "name": "A String", # Immutable. Resource name of the repository, in the format `projects/*/locations/*/connections/*/repositories/*`.
        "remoteUri": "A String", # Required. Git Clone HTTPS URI.
        "updateTime": "A String", # Output only. Server assigned timestamp for when the connection was updated.
        "webhookId": "A String", # Output only. External ID of the webhook created for the repository.
      },
      "repositoryId": "A String", # Required. The ID to use for the repository, which will become the final component of the repository's resource name. This ID should be unique in the connection. Allows alphanumeric characters and any of -._~%!$&'()*+,;=@.
    },
  ],
}

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

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
close()
Close httplib2 connections.
create(parent, body=None, repositoryId=None, x__xgafv=None)
Creates a Repository.

Args:
  parent: string, Required. The connection to contain the repository. If the request is part of a BatchCreateRepositoriesRequest, this field should be empty or match the parent specified there. (required)
  body: object, The request body.
    The object takes the form of:

{ # A repository associated to a parent connection.
  "annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
    "a_key": "A String",
  },
  "createTime": "A String", # Output only. Server assigned timestamp for when the connection was created.
  "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  "name": "A String", # Immutable. Resource name of the repository, in the format `projects/*/locations/*/connections/*/repositories/*`.
  "remoteUri": "A String", # Required. Git Clone HTTPS URI.
  "updateTime": "A String", # Output only. Server assigned timestamp for when the connection was updated.
  "webhookId": "A String", # Output only. External ID of the webhook created for the repository.
}

  repositoryId: string, Required. The ID to use for the repository, which will become the final component of the repository's resource name. This ID should be unique in the connection. Allows alphanumeric characters and any of -._~%!$&'()*+,;=@.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
delete(name, etag=None, validateOnly=None, x__xgafv=None)
Deletes a single repository.

Args:
  name: string, Required. The name of the Repository to delete. Format: `projects/*/locations/*/connections/*/repositories/*`. (required)
  etag: string, The current etag of the repository. If an etag is provided and does not match the current etag of the repository, deletion will be blocked and an ABORTED error will be returned.
  validateOnly: boolean, If set, validate the request, but do not actually post it.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
fetchGitRefs(repository, pageSize=None, pageToken=None, refType=None, x__xgafv=None)
Fetch the list of branches or tags for a given repository.

Args:
  repository: string, Required. The resource name of the repository in the format `projects/*/locations/*/connections/*/repositories/*`. (required)
  pageSize: integer, Optional. Number of results to return in the list. Default to 20.
  pageToken: string, Optional. Page start.
  refType: string, Type of refs to fetch
    Allowed values
      REF_TYPE_UNSPECIFIED - No type specified.
      TAG - To fetch tags.
      BRANCH - To fetch branches.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for fetching git refs
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
  "refNames": [ # Name of the refs fetched.
    "A String",
  ],
}
fetchGitRefs_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.
        
get(name, x__xgafv=None)
Gets details of a single repository.

Args:
  name: string, Required. The name of the Repository to retrieve. Format: `projects/*/locations/*/connections/*/repositories/*`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A repository associated to a parent connection.
  "annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
    "a_key": "A String",
  },
  "createTime": "A String", # Output only. Server assigned timestamp for when the connection was created.
  "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  "name": "A String", # Immutable. Resource name of the repository, in the format `projects/*/locations/*/connections/*/repositories/*`.
  "remoteUri": "A String", # Required. Git Clone HTTPS URI.
  "updateTime": "A String", # Output only. Server assigned timestamp for when the connection was updated.
  "webhookId": "A String", # Output only. External ID of the webhook created for the repository.
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Repositories in a given connection.

Args:
  parent: string, Required. The parent, which owns this collection of Repositories. Format: `projects/*/locations/*/connections/*`. (required)
  filter: string, A filter expression that filters resources listed in the response. Expressions must follow API improvement proposal [AIP-160](https://google.aip.dev/160). e.g. `remote_uri:"https://github.com*"`.
  pageSize: integer, Number of results to return in the list.
  pageToken: string, Page start.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to listing Repositories.
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
  "repositories": [ # The list of Repositories.
    { # A repository associated to a parent connection.
      "annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
        "a_key": "A String",
      },
      "createTime": "A String", # Output only. Server assigned timestamp for when the connection was created.
      "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
      "name": "A String", # Immutable. Resource name of the repository, in the format `projects/*/locations/*/connections/*/repositories/*`.
      "remoteUri": "A String", # Required. Git Clone HTTPS URI.
      "updateTime": "A String", # Output only. Server assigned timestamp for when the connection was updated.
      "webhookId": "A String", # Output only. External ID of the webhook created for the repository.
    },
  ],
}
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.