Skip to content

Commit

Permalink
feat(notebooks): update the api
Browse files Browse the repository at this point in the history
#### notebooks:v1

The following keys were added:
- resources.projects.resources.locations.resources.instances.methods.isUpgradeable.parameters.type (Total Keys: 2)
- resources.projects.resources.locations.resources.instances.methods.updateMetadataItems (Total Keys: 12)
- schemas.UpdateInstanceMetadataItemsRequest (Total Keys: 4)
- schemas.UpdateInstanceMetadataItemsResponse (Total Keys: 4)
- schemas.UpgradeInstanceInternalRequest.properties.type.type (Total Keys: 1)
- schemas.UpgradeInstanceRequest.properties.type.type (Total Keys: 1)
  • Loading branch information
yoshi-automation committed Jan 11, 2022
1 parent 288618f commit 6658409
Show file tree
Hide file tree
Showing 3 changed files with 162 additions and 8 deletions.
48 changes: 45 additions & 3 deletions docs/dyn/notebooks_v1.projects.locations.instances.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ <h2>Instance Methods</h2>
<code><a href="#getInstanceHealth">getInstanceHealth(name, x__xgafv=None)</a></code></p>
<p class="firstline">Check if a notebook instance is healthy.</p>
<p class="toc_element">
<code><a href="#isUpgradeable">isUpgradeable(notebookInstance, x__xgafv=None)</a></code></p>
<code><a href="#isUpgradeable">isUpgradeable(notebookInstance, type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Check if a notebook instance is upgradable.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Expand Down Expand Up @@ -137,6 +137,9 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#updateConfig">updateConfig(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update Notebook Instance configurations.</p>
<p class="toc_element">
<code><a href="#updateMetadataItems">updateMetadataItems(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Add/update metadata items for an instance.</p>
<p class="toc_element">
<code><a href="#updateShieldedInstanceConfig">updateShieldedInstanceConfig(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the Shielded instance configuration of a single Instance.</p>
Expand Down Expand Up @@ -449,7 +452,7 @@ <h3>Method Details</h3>

Args:
resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
Expand Down Expand Up @@ -501,11 +504,18 @@ <h3>Method Details</h3>
</div>

<div class="method">
<code class="details" id="isUpgradeable">isUpgradeable(notebookInstance, x__xgafv=None)</code>
<code class="details" id="isUpgradeable">isUpgradeable(notebookInstance, type=None, x__xgafv=None)</code>
<pre>Check if a notebook instance is upgradable.

Args:
notebookInstance: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
type: string, Optional. The optional UpgradeType. Setting this field will search for additional compute images to upgrade this instance.
Allowed values
UPGRADE_TYPE_UNSPECIFIED - Upgrade type is not specified.
UPGRADE_FRAMEWORK - Upgrade ML framework.
UPGRADE_OS - Upgrade Operating System.
UPGRADE_CUDA - Upgrade CUDA.
UPGRADE_ALL - Upgrade All (OS, Framework and CUDA).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
Expand Down Expand Up @@ -1176,6 +1186,36 @@ <h3>Method Details</h3>
}</pre>
</div>

<div class="method">
<code class="details" id="updateMetadataItems">updateMetadataItems(name, body=None, x__xgafv=None)</code>
<pre>Add/update metadata items for an instance.

Args:
name: string, Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
body: object, The request body.
The object takes the form of:

{ # Request for adding/changing metadata items for an instance.
&quot;items&quot;: { # Metadata items to add/update for the instance.
&quot;a_key&quot;: &quot;A String&quot;,
},
}

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

Returns:
An object of the form:

{ # Response for adding/changing metadata items for an instance.
&quot;items&quot;: { # Map of items that were added/updated to/in the metadata.
&quot;a_key&quot;: &quot;A String&quot;,
},
}</pre>
</div>

<div class="method">
<code class="details" id="updateShieldedInstanceConfig">updateShieldedInstanceConfig(name, body=None, x__xgafv=None)</code>
<pre>Updates the Shielded instance configuration of a single Instance.
Expand Down Expand Up @@ -1232,6 +1272,7 @@ <h3>Method Details</h3>
The object takes the form of:

{ # Request for upgrading a notebook instance
&quot;type&quot;: &quot;A String&quot;, # Optional. The optional UpgradeType. Setting this field will search for additional compute images to upgrade this instance.
}

x__xgafv: string, V1 error format.
Expand Down Expand Up @@ -1273,6 +1314,7 @@ <h3>Method Details</h3>
The object takes the form of:

{ # Request for upgrading a notebook instance from within the VM
&quot;type&quot;: &quot;A String&quot;, # Optional. The optional UpgradeType. Setting this field will search for additional compute images to upgrade this instance.
&quot;vmId&quot;: &quot;A String&quot;, # Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
}

Expand Down
2 changes: 1 addition & 1 deletion docs/dyn/notebooks_v1.projects.locations.runtimes.html
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ <h3>Method Details</h3>

Args:
resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
Expand Down
120 changes: 116 additions & 4 deletions googleapiclient/discovery_cache/documents/notebooks.v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -528,7 +528,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
Expand Down Expand Up @@ -589,6 +589,25 @@
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
},
"type": {
"description": "Optional. The optional UpgradeType. Setting this field will search for additional compute images to upgrade this instance.",
"enum": [
"UPGRADE_TYPE_UNSPECIFIED",
"UPGRADE_FRAMEWORK",
"UPGRADE_OS",
"UPGRADE_CUDA",
"UPGRADE_ALL"
],
"enumDescriptions": [
"Upgrade type is not specified.",
"Upgrade ML framework.",
"Upgrade Operating System.",
"Upgrade CUDA.",
"Upgrade All (OS, Framework and CUDA)."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+notebookInstance}:isUpgradeable",
Expand Down Expand Up @@ -971,6 +990,34 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateMetadataItems": {
"description": "Add/update metadata items for an instance.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:updateMetadataItems",
"httpMethod": "PATCH",
"id": "notebooks.projects.locations.instances.updateMetadataItems",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:updateMetadataItems",
"request": {
"$ref": "UpdateInstanceMetadataItemsRequest"
},
"response": {
"$ref": "UpdateInstanceMetadataItemsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateShieldedInstanceConfig": {
"description": "Updates the Shielded instance configuration of a single Instance.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:updateShieldedInstanceConfig",
Expand Down Expand Up @@ -1275,7 +1322,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
Expand Down Expand Up @@ -1696,7 +1743,7 @@
}
}
},
"revision": "20211019",
"revision": "20220104",
"rootUrl": "https://notebooks.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
Expand Down Expand Up @@ -3526,6 +3573,34 @@
},
"type": "object"
},
"UpdateInstanceMetadataItemsRequest": {
"description": "Request for adding/changing metadata items for an instance.",
"id": "UpdateInstanceMetadataItemsRequest",
"properties": {
"items": {
"additionalProperties": {
"type": "string"
},
"description": "Metadata items to add/update for the instance.",
"type": "object"
}
},
"type": "object"
},
"UpdateInstanceMetadataItemsResponse": {
"description": "Response for adding/changing metadata items for an instance.",
"id": "UpdateInstanceMetadataItemsResponse",
"properties": {
"items": {
"additionalProperties": {
"type": "string"
},
"description": "Map of items that were added/updated to/in the metadata.",
"type": "object"
}
},
"type": "object"
},
"UpdateShieldedInstanceConfigRequest": {
"description": "Request for updating the Shielded Instance config for a notebook instance. You can only use this method on a stopped instance",
"id": "UpdateShieldedInstanceConfigRequest",
Expand Down Expand Up @@ -3611,6 +3686,24 @@
"description": "Request for upgrading a notebook instance from within the VM",
"id": "UpgradeInstanceInternalRequest",
"properties": {
"type": {
"description": "Optional. The optional UpgradeType. Setting this field will search for additional compute images to upgrade this instance.",
"enum": [
"UPGRADE_TYPE_UNSPECIFIED",
"UPGRADE_FRAMEWORK",
"UPGRADE_OS",
"UPGRADE_CUDA",
"UPGRADE_ALL"
],
"enumDescriptions": [
"Upgrade type is not specified.",
"Upgrade ML framework.",
"Upgrade Operating System.",
"Upgrade CUDA.",
"Upgrade All (OS, Framework and CUDA)."
],
"type": "string"
},
"vmId": {
"description": "Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity",
"type": "string"
Expand All @@ -3621,7 +3714,26 @@
"UpgradeInstanceRequest": {
"description": "Request for upgrading a notebook instance",
"id": "UpgradeInstanceRequest",
"properties": {},
"properties": {
"type": {
"description": "Optional. The optional UpgradeType. Setting this field will search for additional compute images to upgrade this instance.",
"enum": [
"UPGRADE_TYPE_UNSPECIFIED",
"UPGRADE_FRAMEWORK",
"UPGRADE_OS",
"UPGRADE_CUDA",
"UPGRADE_ALL"
],
"enumDescriptions": [
"Upgrade type is not specified.",
"Upgrade ML framework.",
"Upgrade Operating System.",
"Upgrade CUDA.",
"Upgrade All (OS, Framework and CUDA)."
],
"type": "string"
}
},
"type": "object"
},
"VertexAIParameters": {
Expand Down

0 comments on commit 6658409

Please sign in to comment.