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

blob: fda0a4f3d28769f2b1dda049d5c8c9a65634978f [file] [log] [blame]

yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[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.executions.html">executions</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, executionId=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Creates a new Scheduled Notebook in a given project and location.</p>
				83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes execution</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 executions</p>
				89	<p class="toc_element">
				90	<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
				91	<p class="firstline">Lists executions in a given project and location</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, executionId=None, x__xgafv=None)</code>
				103	<pre>Creates a new Scheduled Notebook in a given project and location.
				104
				105	Args:
				106	parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required)
				107	body: object, The request body.
				108	The object takes the form of:
				109
				110	{ # The definition of a single executed notebook.
				111	"createTime": "A String", # Output only. Time the Execution was instantiated.
				112	"description": "A String", # A brief description of this execution.
				113	"displayName": "A String", # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.
				114	"executionTemplate": { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc.
				115	"acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
				116	"coreCount": "A String", # Count of cores of this accelerator.
				117	"type": "A String", # Type of this accelerator.
				118	},
				119	"containerImageUri": "A String", # Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
				120	"inputNotebookFile": "A String", # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
				121	"labels": { # Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions.
				122	"a_key": "A String",
				123	},
				124	"masterType": "A String", # Specifies the type of virtual machine to use for your training job's master worker. You must specify this field when `scaleTier` is set to `CUSTOM`. You can use certain Compute Engine machine types directly in this field. The following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` Alternatively, you can use the following legacy machine types: - `standard` - `large_model` - `complex_model_s` - `complex_model_m` - `complex_model_l` - `standard_gpu` - `complex_model_m_gpu` - `complex_model_l_gpu` - `standard_p100` - `complex_model_m_p100` - `standard_v100` - `large_model_v100` - `complex_model_m_v100` - `complex_model_l_v100` Finally, if you want to use a TPU for training, specify `cloud_tpu` in this field. Learn more about the [special configuration options for training with TPU.
				125	"outputNotebookFolder": "A String", # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks
				126	"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.
				127	"paramsYamlFile": "A String", # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
				128	"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	129	"serviceAccount": "A String", # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	130	},
				131	"name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/execution/{execution_id}
				132	"outputNotebookFile": "A String", # Output notebook file generated by this execution
				133	"state": "A String", # Output only. State of the underlying AI Platform job.
				134	"updateTime": "A String", # Output only. Time the Execution was last updated.
				135	}
				136
				137	executionId: string, Required. User-defined unique ID of this execution.
				138	x__xgafv: string, V1 error format.
				139	Allowed values
				140	1 - v1 error format
				141	2 - v2 error format
				142
				143	Returns:
				144	An object of the form:
				145
				146	{ # This resource represents a long-running operation that is the result of a network API call.
				147	"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.
				148	"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.
				149	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				150	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				151	{
				152	"a_key": "", # Properties of the object. Contains field @type with type URL.
				153	},
				154	],
				155	"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.
				156	},
				157	"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.
				158	"a_key": "", # Properties of the object. Contains field @type with type URL.
				159	},
				160	"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}`.
				161	"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`.
				162	"a_key": "", # Properties of the object. Contains field @type with type URL.
				163	},
				164	}</pre>
				165	</div>
				166
				167	<div class="method">
				168	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				169	<pre>Deletes execution
				170
				171	Args:
				172	name: string, Required. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}` (required)
				173	x__xgafv: string, V1 error format.
				174	Allowed values
				175	1 - v1 error format
				176	2 - v2 error format
				177
				178	Returns:
				179	An object of the form:
				180
				181	{ # This resource represents a long-running operation that is the result of a network API call.
				182	"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.
				183	"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.
				184	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				185	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				186	{
				187	"a_key": "", # Properties of the object. Contains field @type with type URL.
				188	},
				189	],
				190	"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.
				191	},
				192	"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.
				193	"a_key": "", # Properties of the object. Contains field @type with type URL.
				194	},
				195	"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}`.
				196	"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`.
				197	"a_key": "", # Properties of the object. Contains field @type with type URL.
				198	},
				199	}</pre>
				200	</div>
				201
				202	<div class="method">
				203	<code class="details" id="get">get(name, x__xgafv=None)</code>
				204	<pre>Gets details of executions
				205
				206	Args:
				207	name: string, Required. Format: `projects/{project_id}/locations/{location}/schedules/{execution_id}` (required)
				208	x__xgafv: string, V1 error format.
				209	Allowed values
				210	1 - v1 error format
				211	2 - v2 error format
				212
				213	Returns:
				214	An object of the form:
				215
				216	{ # The definition of a single executed notebook.
				217	"createTime": "A String", # Output only. Time the Execution was instantiated.
				218	"description": "A String", # A brief description of this execution.
				219	"displayName": "A String", # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.
				220	"executionTemplate": { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc.
				221	"acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
				222	"coreCount": "A String", # Count of cores of this accelerator.
				223	"type": "A String", # Type of this accelerator.
				224	},
				225	"containerImageUri": "A String", # Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
				226	"inputNotebookFile": "A String", # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
				227	"labels": { # Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions.
				228	"a_key": "A String",
				229	},
				230	"masterType": "A String", # Specifies the type of virtual machine to use for your training job's master worker. You must specify this field when `scaleTier` is set to `CUSTOM`. You can use certain Compute Engine machine types directly in this field. The following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` Alternatively, you can use the following legacy machine types: - `standard` - `large_model` - `complex_model_s` - `complex_model_m` - `complex_model_l` - `standard_gpu` - `complex_model_m_gpu` - `complex_model_l_gpu` - `standard_p100` - `complex_model_m_p100` - `standard_v100` - `large_model_v100` - `complex_model_m_v100` - `complex_model_l_v100` Finally, if you want to use a TPU for training, specify `cloud_tpu` in this field. Learn more about the [special configuration options for training with TPU.
				231	"outputNotebookFolder": "A String", # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks
				232	"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.
				233	"paramsYamlFile": "A String", # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
				234	"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	235	"serviceAccount": "A String", # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	236	},
				237	"name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/execution/{execution_id}
				238	"outputNotebookFile": "A String", # Output notebook file generated by this execution
				239	"state": "A String", # Output only. State of the underlying AI Platform job.
				240	"updateTime": "A String", # Output only. Time the Execution was last updated.
				241	}</pre>
				242	</div>
				243
				244	<div class="method">
				245	<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
				246	<pre>Lists executions in a given project and location
				247
				248	Args:
				249	parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required)
yoshi-code-bot	9e2cde2	2021-04-29 03:48:05 -0700	[diff] [blame]	250	filter: string, Filter applied to resulting executions. Currently only supports filtering executions by a specified schedule_id. Format: "schedule_id="
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	251	orderBy: string, Sort by field.
				252	pageSize: integer, Maximum return size of the list call.
				253	pageToken: string, A previous returned page token that can be used to continue listing from the last result.
				254	x__xgafv: string, V1 error format.
				255	Allowed values
				256	1 - v1 error format
				257	2 - v2 error format
				258
				259	Returns:
				260	An object of the form:
				261
				262	{ # Response for listing scheduled notebook executions
				263	"executions": [ # A list of returned instances.
				264	{ # The definition of a single executed notebook.
				265	"createTime": "A String", # Output only. Time the Execution was instantiated.
				266	"description": "A String", # A brief description of this execution.
				267	"displayName": "A String", # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.
				268	"executionTemplate": { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc.
				269	"acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
				270	"coreCount": "A String", # Count of cores of this accelerator.
				271	"type": "A String", # Type of this accelerator.
				272	},
				273	"containerImageUri": "A String", # Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
				274	"inputNotebookFile": "A String", # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
				275	"labels": { # Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions.
				276	"a_key": "A String",
				277	},
				278	"masterType": "A String", # Specifies the type of virtual machine to use for your training job's master worker. You must specify this field when `scaleTier` is set to `CUSTOM`. You can use certain Compute Engine machine types directly in this field. The following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` Alternatively, you can use the following legacy machine types: - `standard` - `large_model` - `complex_model_s` - `complex_model_m` - `complex_model_l` - `standard_gpu` - `complex_model_m_gpu` - `complex_model_l_gpu` - `standard_p100` - `complex_model_m_p100` - `standard_v100` - `large_model_v100` - `complex_model_m_v100` - `complex_model_l_v100` Finally, if you want to use a TPU for training, specify `cloud_tpu` in this field. Learn more about the [special configuration options for training with TPU.
				279	"outputNotebookFolder": "A String", # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks
				280	"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.
				281	"paramsYamlFile": "A String", # Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
				282	"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	283	"serviceAccount": "A String", # The email address of a service account to use when running the execution. You must have the `iam.serviceAccounts.actAs` permission for the specified service account.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	284	},
				285	"name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/execution/{execution_id}
				286	"outputNotebookFile": "A String", # Output notebook file generated by this execution
				287	"state": "A String", # Output only. State of the underlying AI Platform job.
				288	"updateTime": "A String", # Output only. Time the Execution was last updated.
				289	},
				290	],
				291	"nextPageToken": "A String", # Page token that can be used to continue listing from the last result in the next list call.
				292	"unreachable": [ # Executions IDs that could not be reached. For example, ['projects/{project_id}/location/{location}/executions/imagenet_test1', 'projects/{project_id}/location/{location}/executions/classifier_train1'].
				293	"A String",
				294	],
				295	}</pre>
				296	</div>
				297
				298	<div class="method">
				299	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				300	<pre>Retrieves the next page of results.
				301
				302	Args:
				303	previous_request: The request for the previous page. (required)
				304	previous_response: The response from the request for the previous page. (required)
				305
				306	Returns:
				307	A request object that you can call 'execute()' on to request the next
				308	page. Returns None if there are no more items in the collection.
				309	</pre>
				310	</div>
				311
				312	</body></html>