Skip to content

Commit 7a4f54c

Browse files
feat(artifactregistry): update the api
#### artifactregistry:v1 The following keys were added: - resources.projects.resources.locations.resources.repositories.resources.genericArtifacts.methods.upload (Total Keys: 18) - schemas.GenericArtifact (Total Keys: 10) - schemas.UploadGenericArtifactMediaResponse (Total Keys: 3) - schemas.UploadGenericArtifactMetadata (Total Keys: 2) - schemas.UploadGenericArtifactRequest (Total Keys: 7)
1 parent e78cd3e commit 7a4f54c

File tree

3 files changed

+264
-3
lines changed

3 files changed

+264
-3
lines changed
Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
<html><body>
2+
<style>
3+
4+
body, h1, h2, h3, div, span, p, pre, a {
5+
margin: 0;
6+
padding: 0;
7+
border: 0;
8+
font-weight: inherit;
9+
font-style: inherit;
10+
font-size: 100%;
11+
font-family: inherit;
12+
vertical-align: baseline;
13+
}
14+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, h2, h3 {
50+
border-bottom: solid #CCC 1px;
51+
}
52+
53+
.toc_element {
54+
margin-top: 0.5em;
55+
}
56+
57+
.firstline {
58+
margin-left: 2 em;
59+
}
60+
61+
.method {
62+
margin-top: 1em;
63+
border: solid 1px #CCC;
64+
padding: 1em;
65+
background: #EEE;
66+
}
67+
68+
.details {
69+
font-weight: bold;
70+
font-size: 14px;
71+
}
72+
73+
</style>
74+
75+
<h1><a href="artifactregistry_v1.html">Artifact Registry API</a> . <a href="artifactregistry_v1.projects.html">projects</a> . <a href="artifactregistry_v1.projects.locations.html">locations</a> . <a href="artifactregistry_v1.projects.locations.repositories.html">repositories</a> . <a href="artifactregistry_v1.projects.locations.repositories.genericArtifacts.html">genericArtifacts</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#close">close()</a></code></p>
79+
<p class="firstline">Close httplib2 connections.</p>
80+
<p class="toc_element">
81+
<code><a href="#upload">upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Directly uploads a Generic artifact. The returned Operation will complete once the resources are uploaded. Package, Version, and File resources are created based on the uploaded artifact. Uploaded artifacts that conflict with existing resources will raise an ALREADY_EXISTS error.</p>
83+
<h3>Method Details</h3>
84+
<div class="method">
85+
<code class="details" id="close">close()</code>
86+
<pre>Close httplib2 connections.</pre>
87+
</div>
88+
89+
<div class="method">
90+
<code class="details" id="upload">upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</code>
91+
<pre>Directly uploads a Generic artifact. The returned Operation will complete once the resources are uploaded. Package, Version, and File resources are created based on the uploaded artifact. Uploaded artifacts that conflict with existing resources will raise an ALREADY_EXISTS error.
92+
93+
Args:
94+
parent: string, The resource name of the repository where the generic artifact will be uploaded. (required)
95+
body: object, The request body.
96+
The object takes the form of:
97+
98+
{ # The request to upload a generic artifact. The created GenericArtifact will have the resource name {parent}/genericArtifacts/package_id:version_id. The created file will have the resource name {parent}/files/package_id:version_id:filename.
99+
&quot;filename&quot;: &quot;A String&quot;, # The name of the file of the generic artifact to be uploaded. E.g. &quot;example-file.zip&quot; The filename should only include letters, numbers, and url safe characters, i.e. [a-zA-Z0-9-_.~@].
100+
&quot;name&quot;: &quot;A String&quot;, # Deprecated. Use package_id, version_id and filename instead. The resource name of the generic artifact. E.g. &quot;projects/math/locations/us/repositories/operations/genericArtifacts/addition/1.0.0/add.py&quot;
101+
&quot;packageId&quot;: &quot;A String&quot;, # The ID of the package of the generic artifact. If the package does not exist, a new package will be created. E.g. &quot;pkg-1&quot; The package_id must start with a letter, end with a letter or number, only contain letters, numbers, hyphens and periods i.e. [a-z0-9-.], and cannot exceed 256 characters.
102+
&quot;versionId&quot;: &quot;A String&quot;, # The ID of the version of the generic artifact. If the version does not exist, a new version will be created. E.g.&quot;1.0.0&quot; The version_id must start and end with a letter or number, can only contain lowercase letters, numbers, hyphens and periods, i.e. [a-z0-9-.] and cannot exceed a total of 128 characters. While &quot;latest&quot; is a well-known name for the latest version of a package, it is not yet supported and is reserved for future use. Creating a version called &quot;latest&quot; is not allowed.
103+
}
104+
105+
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
106+
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
107+
x__xgafv: string, V1 error format.
108+
Allowed values
109+
1 - v1 error format
110+
2 - v2 error format
111+
112+
Returns:
113+
An object of the form:
114+
115+
{ # The response to upload a generic artifact.
116+
&quot;operation&quot;: { # This resource represents a long-running operation that is the result of a network API call. # Operation that will be returned to the user.
117+
&quot;done&quot;: 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.
118+
&quot;error&quot;: { # 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.
119+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
120+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
121+
{
122+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
123+
},
124+
],
125+
&quot;message&quot;: &quot;A String&quot;, # 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.
126+
},
127+
&quot;metadata&quot;: { # 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.
128+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
129+
},
130+
&quot;name&quot;: &quot;A String&quot;, # 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}`.
131+
&quot;response&quot;: { # 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`.
132+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
133+
},
134+
},
135+
}</pre>
136+
</div>
137+
138+
</body></html>

docs/dyn/artifactregistry_v1.projects.locations.repositories.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,11 @@ <h2>Instance Methods</h2>
8989
</p>
9090
<p class="firstline">Returns the files Resource.</p>
9191

92+
<p class="toc_element">
93+
<code><a href="artifactregistry_v1.projects.locations.repositories.genericArtifacts.html">genericArtifacts()</a></code>
94+
</p>
95+
<p class="firstline">Returns the genericArtifacts Resource.</p>
96+
9297
<p class="toc_element">
9398
<code><a href="artifactregistry_v1.projects.locations.repositories.goModules.html">goModules()</a></code>
9499
</p>

googleapiclient/discovery_cache/documents/artifactregistry.v1.json

Lines changed: 121 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -842,6 +842,54 @@
842842
}
843843
}
844844
},
845+
"genericArtifacts": {
846+
"methods": {
847+
"upload": {
848+
"description": "Directly uploads a Generic artifact. The returned Operation will complete once the resources are uploaded. Package, Version, and File resources are created based on the uploaded artifact. Uploaded artifacts that conflict with existing resources will raise an ALREADY_EXISTS error.",
849+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/genericArtifacts:create",
850+
"httpMethod": "POST",
851+
"id": "artifactregistry.projects.locations.repositories.genericArtifacts.upload",
852+
"mediaUpload": {
853+
"accept": [
854+
"*/*"
855+
],
856+
"protocols": {
857+
"resumable": {
858+
"multipart": true,
859+
"path": "/resumable/upload/v1/{+parent}/genericArtifacts:create"
860+
},
861+
"simple": {
862+
"multipart": true,
863+
"path": "/upload/v1/{+parent}/genericArtifacts:create"
864+
}
865+
}
866+
},
867+
"parameterOrder": [
868+
"parent"
869+
],
870+
"parameters": {
871+
"parent": {
872+
"description": "The resource name of the repository where the generic artifact will be uploaded.",
873+
"location": "path",
874+
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
875+
"required": true,
876+
"type": "string"
877+
}
878+
},
879+
"path": "v1/{+parent}/genericArtifacts:create",
880+
"request": {
881+
"$ref": "UploadGenericArtifactRequest"
882+
},
883+
"response": {
884+
"$ref": "UploadGenericArtifactMediaResponse"
885+
},
886+
"scopes": [
887+
"https://www.googleapis.com/auth/cloud-platform"
888+
],
889+
"supportsMediaUpload": true
890+
}
891+
}
892+
},
845893
"goModules": {
846894
"methods": {
847895
"upload": {
@@ -1734,7 +1782,7 @@
17341782
}
17351783
}
17361784
},
1737-
"revision": "20240412",
1785+
"revision": "20240425",
17381786
"rootUrl": "https://artifactregistry.googleapis.com/",
17391787
"schemas": {
17401788
"AptArtifact": {
@@ -2076,6 +2124,33 @@
20762124
},
20772125
"type": "object"
20782126
},
2127+
"GenericArtifact": {
2128+
"description": "GenericArtifact represents a generic artifact",
2129+
"id": "GenericArtifact",
2130+
"properties": {
2131+
"createTime": {
2132+
"description": "Output only. The time when the Generic module is created.",
2133+
"format": "google-datetime",
2134+
"readOnly": true,
2135+
"type": "string"
2136+
},
2137+
"name": {
2138+
"description": "Resource name of the generic artifact. project, location, repository, package_id and version_id create a unique generic artifact. i.e. \"projects/test-project/locations/us-west4/repositories/test-repo/ genericArtifacts/package_id:version_id\"",
2139+
"type": "string"
2140+
},
2141+
"updateTime": {
2142+
"description": "Output only. The time when the Generic module is updated.",
2143+
"format": "google-datetime",
2144+
"readOnly": true,
2145+
"type": "string"
2146+
},
2147+
"version": {
2148+
"description": "The version of the generic artifact.",
2149+
"type": "string"
2150+
}
2151+
},
2152+
"type": "object"
2153+
},
20792154
"GoModule": {
20802155
"description": "GoModule represents a Go module.",
20812156
"id": "GoModule",
@@ -3192,7 +3267,8 @@ false
31923267
"GOOGET",
31933268
"PYTHON",
31943269
"KFP",
3195-
"GO"
3270+
"GO",
3271+
"GENERIC"
31963272
],
31973273
"enumDescriptions": [
31983274
"Unspecified package format.",
@@ -3204,7 +3280,8 @@ false
32043280
"GooGet package format.",
32053281
"Python package format.",
32063282
"Kubeflow Pipelines package format.",
3207-
"Go package format."
3283+
"Go package format.",
3284+
"Generic package format."
32083285
],
32093286
"type": "string"
32103287
},
@@ -3391,6 +3468,47 @@ false
33913468
},
33923469
"type": "object"
33933470
},
3471+
"UploadGenericArtifactMediaResponse": {
3472+
"description": "The response to upload a generic artifact.",
3473+
"id": "UploadGenericArtifactMediaResponse",
3474+
"properties": {
3475+
"operation": {
3476+
"$ref": "Operation",
3477+
"description": "Operation that will be returned to the user."
3478+
}
3479+
},
3480+
"type": "object"
3481+
},
3482+
"UploadGenericArtifactMetadata": {
3483+
"description": "The operation metadata for uploading generic artifacts.",
3484+
"id": "UploadGenericArtifactMetadata",
3485+
"properties": {},
3486+
"type": "object"
3487+
},
3488+
"UploadGenericArtifactRequest": {
3489+
"description": "The request to upload a generic artifact. The created GenericArtifact will have the resource name {parent}/genericArtifacts/package_id:version_id. The created file will have the resource name {parent}/files/package_id:version_id:filename.",
3490+
"id": "UploadGenericArtifactRequest",
3491+
"properties": {
3492+
"filename": {
3493+
"description": "The name of the file of the generic artifact to be uploaded. E.g. \"example-file.zip\" The filename should only include letters, numbers, and url safe characters, i.e. [a-zA-Z0-9-_.~@].",
3494+
"type": "string"
3495+
},
3496+
"name": {
3497+
"deprecated": true,
3498+
"description": "Deprecated. Use package_id, version_id and filename instead. The resource name of the generic artifact. E.g. \"projects/math/locations/us/repositories/operations/genericArtifacts/addition/1.0.0/add.py\"",
3499+
"type": "string"
3500+
},
3501+
"packageId": {
3502+
"description": "The ID of the package of the generic artifact. If the package does not exist, a new package will be created. E.g. \"pkg-1\" The package_id must start with a letter, end with a letter or number, only contain letters, numbers, hyphens and periods i.e. [a-z0-9-.], and cannot exceed 256 characters.",
3503+
"type": "string"
3504+
},
3505+
"versionId": {
3506+
"description": "The ID of the version of the generic artifact. If the version does not exist, a new version will be created. E.g.\"1.0.0\" The version_id must start and end with a letter or number, can only contain lowercase letters, numbers, hyphens and periods, i.e. [a-z0-9-.] and cannot exceed a total of 128 characters. While \"latest\" is a well-known name for the latest version of a package, it is not yet supported and is reserved for future use. Creating a version called \"latest\" is not allowed.",
3507+
"type": "string"
3508+
}
3509+
},
3510+
"type": "object"
3511+
},
33943512
"UploadGoModuleMediaResponse": {
33953513
"description": "The response to upload a Go module.",
33963514
"id": "UploadGoModuleMediaResponse",

0 commit comments

Comments
 (0)