Close httplib2 connections.
Deletes a file and all of its content. It is only allowed on generic repositories. The returned operation will complete once the file has been deleted.
Download a file.
download_media(name, x__xgafv=None)
Download a file.
Gets a file.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists files.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a file.
upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)
Directly uploads a file to a repository. The returned Operation will complete once the resources are uploaded.
close()
Close httplib2 connections.
delete(name, x__xgafv=None)
Deletes a file and all of its content. It is only allowed on generic repositories. The returned operation will complete once the file has been deleted.
Args:
name: string, Required. The name of the file to delete. (required)
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.
},
}
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.
"annotations": { # Optional. Client specified annotations.
"a_key": "A String",
},
"createTime": "A String", # Output only. The time when the File was created.
"fetchTime": "A String", # Output only. The time when the last attempt to refresh the file's data was made. Only set when the repository is remote.
"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, orderBy=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*`" ``
orderBy: string, The field to order the results by.
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.
"annotations": { # Optional. Client specified annotations.
"a_key": "A String",
},
"createTime": "A String", # Output only. The time when the File was created.
"fetchTime": "A String", # Output only. The time when the last attempt to refresh the file's data was made. Only set when the repository is remote.
"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.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a file.
Args:
name: 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. (required)
body: object, The request body.
The object takes the form of:
{ # Files store content that is potentially associated with Packages or Versions.
"annotations": { # Optional. Client specified annotations.
"a_key": "A String",
},
"createTime": "A String", # Output only. The time when the File was created.
"fetchTime": "A String", # Output only. The time when the last attempt to refresh the file's data was made. Only set when the repository is remote.
"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.
}
updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
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.
"annotations": { # Optional. Client specified annotations.
"a_key": "A String",
},
"createTime": "A String", # Output only. The time when the File was created.
"fetchTime": "A String", # Output only. The time when the last attempt to refresh the file's data was made. Only set when the repository is remote.
"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.
}
upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)
Directly uploads a file to a repository. The returned Operation will complete once the resources are uploaded.
Args:
parent: string, Required. The resource name of the repository where the file will be uploaded. (required)
body: object, The request body.
The object takes the form of:
{ # The request to upload a file.
"fileId": "A String", # Optional. The ID of the file. If left empty will default to sha256 digest of the content uploaded.
}
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
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 upload a generic artifact.
"operation": { # This resource represents a long-running operation that is the result of a network API call. # Operation that will be returned to the user.
"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.
},
},
}