Artifact Registry API . projects . locations . repositories . files

Instance Methods

close()

Close httplib2 connections.

download(name, x__xgafv=None)

Download a file.

download_media(name, x__xgafv=None)

Download a file.

get(name, x__xgafv=None)

Gets a file.

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

Lists files.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
download(name, x__xgafv=None)
Download a file.

Args:
  name: string, Required. The name of the file to download. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response to download a file.
}
download_media(name, x__xgafv=None)
Download a file.

Args:
  name: string, Required. The name of the file to download. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  The media object as a string.

    
get(name, x__xgafv=None)
Gets a file.

Args:
  name: string, Required. The name of the file to retrieve. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Files store content that is potentially associated with Packages or Versions.
  "createTime": "A String", # Output only. The time when the File was created.
  "hashes": [ # The hashes of the file content.
    { # A hash of file content.
      "type": "A String", # The algorithm used to compute the hash value.
      "value": "A String", # The hash value.
    },
  ],
  "name": "A String", # The name of the file, for example: `projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt`. If the file ID part contains slashes, they are escaped.
  "owner": "A String", # The name of the Package or Version that owns this file, if any.
  "sizeBytes": "A String", # The size of the File in bytes.
  "updateTime": "A String", # Output only. The time when the File was last updated.
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists files.

Args:
  parent: string, Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1 (required)
  filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name `my_file.txt` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file*"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` To filter the results of your request to files with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request: * `"annotations.external_link:external_link_value"` To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * `"annotations.external_link"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * `` "annotations.`external.link`:`https://example.com/my-file`" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` "annotations.*_link:`*example.com*`" ``
  pageSize: integer, The maximum number of files to return. Maximum page size is 1,000.
  pageToken: string, The next_page_token value returned from a previous list request, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response from listing files.
  "files": [ # The files returned.
    { # Files store content that is potentially associated with Packages or Versions.
      "createTime": "A String", # Output only. The time when the File was created.
      "hashes": [ # The hashes of the file content.
        { # A hash of file content.
          "type": "A String", # The algorithm used to compute the hash value.
          "value": "A String", # The hash value.
        },
      ],
      "name": "A String", # The name of the file, for example: `projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt`. If the file ID part contains slashes, they are escaped.
      "owner": "A String", # The name of the Package or Version that owns this file, if any.
      "sizeBytes": "A String", # The size of the File in bytes.
      "updateTime": "A String", # Output only. The time when the File was last updated.
    },
  ],
  "nextPageToken": "A String", # The token to retrieve the next page of files, or empty if there are no more files to return.
}
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.