Blame - docs/dyn/notebooks_v1.projects.locations.environments.html - platform/external/python/google-api-python-client

blob: 75a363a06ef63fcf78a1cee5120894ae9ceb199d [file] [log] [blame]

Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	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="notebooks_v1.html">Notebooks API</a> . <a href="notebooks_v1.projects.html">projects</a> . <a href="notebooks_v1.projects.locations.html">locations</a> . <a href="notebooks_v1.projects.locations.environments.html">environments</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="#create">create(parent, body=None, environmentId=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Creates a new Environment.</p>
				83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes a single Environment.</p>
				86	<p class="toc_element">
				87	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Gets details of a single Environment.</p>
				89	<p class="toc_element">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	90	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	91	<p class="firstline">Lists environments in a project.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<h3>Method Details</h3>
				96	<div class="method">
				97	<code class="details" id="close">close()</code>
				98	<pre>Close httplib2 connections.</pre>
				99	</div>
				100
				101	<div class="method">
				102	<code class="details" id="create">create(parent, body=None, environmentId=None, x__xgafv=None)</code>
				103	<pre>Creates a new Environment.
				104
				105	Args:
				106	parent: string, Required. Format: `projects/{project_id}/locations/{location}` (required)
				107	body: object, The request body.
				108	The object takes the form of:
				109
				110	{ # Definition of a software environment that is used to start a notebook instance.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	111	"containerImage": { # Definition of a container image for starting a notebook instance with the environment installed in a container. # Use a container image to start the notebook instance.
				112	"repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
				113	"tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.
				114	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	115	"createTime": "A String", # Output only. The time at which this environment was created.
				116	"description": "A String", # A brief description of this environment.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	117	"displayName": "A String", # Display name of this environment for the UI.
				118	"name": "A String", # Output only. Name of this environment. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	119	"postStartupScript": "A String", # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: `"gs://path-to-file/file-name"`
				120	"vmImage": { # Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. # Use a Compute Engine VM image to start the notebook instance.
				121	"imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used.
				122	"imageName": "A String", # Use VM image name to find the image.
				123	"project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}`
				124	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	125	}
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	126
				127	environmentId: string, Required. User-defined unique ID of this environment. The `environment_id` must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.
				128	x__xgafv: string, V1 error format.
				129	Allowed values
				130	1 - v1 error format
				131	2 - v2 error format
				132
				133	Returns:
				134	An object of the form:
				135
				136	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	137	"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.
				138	"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.
				139	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				140	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				141	{
				142	"a_key": "", # Properties of the object. Contains field @type with type URL.
				143	},
				144	],
				145	"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.
				146	},
				147	"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.
				148	"a_key": "", # Properties of the object. Contains field @type with type URL.
				149	},
				150	"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}`.
				151	"response": { # The normal response of the operation in case of success. 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`.
				152	"a_key": "", # Properties of the object. Contains field @type with type URL.
				153	},
				154	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	155	</div>
				156
				157	<div class="method">
				158	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				159	<pre>Deletes a single Environment.
				160
				161	Args:
				162	name: string, Required. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}` (required)
				163	x__xgafv: string, V1 error format.
				164	Allowed values
				165	1 - v1 error format
				166	2 - v2 error format
				167
				168	Returns:
				169	An object of the form:
				170
				171	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	172	"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.
				173	"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.
				174	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				175	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				176	{
				177	"a_key": "", # Properties of the object. Contains field @type with type URL.
				178	},
				179	],
				180	"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.
				181	},
				182	"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.
				183	"a_key": "", # Properties of the object. Contains field @type with type URL.
				184	},
				185	"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}`.
				186	"response": { # The normal response of the operation in case of success. 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`.
				187	"a_key": "", # Properties of the object. Contains field @type with type URL.
				188	},
				189	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	190	</div>
				191
				192	<div class="method">
				193	<code class="details" id="get">get(name, x__xgafv=None)</code>
				194	<pre>Gets details of a single Environment.
				195
				196	Args:
				197	name: string, Required. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}` (required)
				198	x__xgafv: string, V1 error format.
				199	Allowed values
				200	1 - v1 error format
				201	2 - v2 error format
				202
				203	Returns:
				204	An object of the form:
				205
				206	{ # Definition of a software environment that is used to start a notebook instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	207	"containerImage": { # Definition of a container image for starting a notebook instance with the environment installed in a container. # Use a container image to start the notebook instance.
				208	"repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
				209	"tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.
				210	},
				211	"createTime": "A String", # Output only. The time at which this environment was created.
				212	"description": "A String", # A brief description of this environment.
				213	"displayName": "A String", # Display name of this environment for the UI.
				214	"name": "A String", # Output only. Name of this environment. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`
				215	"postStartupScript": "A String", # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: `"gs://path-to-file/file-name"`
				216	"vmImage": { # Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. # Use a Compute Engine VM image to start the notebook instance.
				217	"imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used.
				218	"imageName": "A String", # Use VM image name to find the image.
				219	"project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}`
				220	},
				221	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	222	</div>
				223
				224	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	225	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	226	<pre>Lists environments in a project.
				227
				228	Args:
				229	parent: string, Required. Format: `projects/{project_id}/locations/{location}` (required)
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	230	pageSize: integer, Maximum return size of the list call.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	231	pageToken: string, A previous returned page token that can be used to continue listing from the last result.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	232	x__xgafv: string, V1 error format.
				233	Allowed values
				234	1 - v1 error format
				235	2 - v2 error format
				236
				237	Returns:
				238	An object of the form:
				239
				240	{ # Response for listing environments.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	241	"environments": [ # A list of returned environments.
				242	{ # Definition of a software environment that is used to start a notebook instance.
				243	"containerImage": { # Definition of a container image for starting a notebook instance with the environment installed in a container. # Use a container image to start the notebook instance.
				244	"repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
				245	"tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	246	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	247	"createTime": "A String", # Output only. The time at which this environment was created.
				248	"description": "A String", # A brief description of this environment.
				249	"displayName": "A String", # Display name of this environment for the UI.
				250	"name": "A String", # Output only. Name of this environment. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`
				251	"postStartupScript": "A String", # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: `"gs://path-to-file/file-name"`
				252	"vmImage": { # Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. # Use a Compute Engine VM image to start the notebook instance.
				253	"imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used.
				254	"imageName": "A String", # Use VM image name to find the image.
				255	"project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}`
				256	},
				257	},
				258	],
				259	"nextPageToken": "A String", # A page token that can be used to continue listing from the last result in the next list call.
				260	"unreachable": [ # Locations that could not be reached.
				261	"A String",
				262	],
				263	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	264	</div>
				265
				266	<div class="method">
				267	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				268	<pre>Retrieves the next page of results.
				269
				270	Args:
				271	previous_request: The request for the previous page. (required)
				272	previous_response: The response from the request for the previous page. (required)
				273
				274	Returns:
				275	A request object that you can call 'execute()' on to request the next
				276	page. Returns None if there are no more items in the collection.
				277	</pre>
				278	</div>
				279
				280	</body></html>