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

blob: c55630938624b75710303e3466aa7da0ebb961ea [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>
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	82	<p class="firstline">Creates a new Execution in a given project and location.</p>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	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>
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	103	<pre>Creates a new Execution in a given project and location.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	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.
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	115	"acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus) to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	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
yoshi-code-bot	cdf480e	2021-08-17 00:20:40 -0700	[diff] [blame]	120	"dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	121	"cluster": "A String", # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
yoshi-code-bot	cdf480e	2021-08-17 00:20:40 -0700	[diff] [blame]	122	},
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	123	"inputNotebookFile": "A String", # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: `gs://{bucket_name}/{folder}/{notebook_file_name}` Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
yoshi-code-bot	cdf480e	2021-08-17 00:20:40 -0700	[diff] [blame]	124	"jobType": "A String", # The type of Job to be used on this execution.
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	125	"kernelSpec": "A String", # Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does not match the name in the input notebook file.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	126	"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.
				127	"a_key": "A String",
				128	},
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	129	"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](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	130	"outputNotebookFolder": "A String", # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: `gs://{bucket_name}/{folder}` Ex: `gs://notebook_user/scheduled_notebooks`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	131	"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	132	"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`
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	133	"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	134	"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	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	135	"vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	136	"env": { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
				137	"a_key": "A String",
				138	},
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	139	"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. If left unspecified, the job is not peered with any network.
				140	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	141	},
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	142	"jobUri": "A String", # Output only. The URI of the external job used to execute the notebook.
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	143	"name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	144	"outputNotebookFile": "A String", # Output notebook file generated by this execution
				145	"state": "A String", # Output only. State of the underlying AI Platform job.
				146	"updateTime": "A String", # Output only. Time the Execution was last updated.
				147	}
				148
				149	executionId: string, Required. User-defined unique ID of this execution.
				150	x__xgafv: string, V1 error format.
				151	Allowed values
				152	1 - v1 error format
				153	2 - v2 error format
				154
				155	Returns:
				156	An object of the form:
				157
				158	{ # This resource represents a long-running operation that is the result of a network API call.
				159	"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.
				160	"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.
				161	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				162	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				163	{
				164	"a_key": "", # Properties of the object. Contains field @type with type URL.
				165	},
				166	],
				167	"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.
				168	},
				169	"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.
				170	"a_key": "", # Properties of the object. Contains field @type with type URL.
				171	},
				172	"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}`.
				173	"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`.
				174	"a_key": "", # Properties of the object. Contains field @type with type URL.
				175	},
				176	}</pre>
				177	</div>
				178
				179	<div class="method">
				180	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				181	<pre>Deletes execution
				182
				183	Args:
				184	name: string, Required. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}` (required)
				185	x__xgafv: string, V1 error format.
				186	Allowed values
				187	1 - v1 error format
				188	2 - v2 error format
				189
				190	Returns:
				191	An object of the form:
				192
				193	{ # This resource represents a long-running operation that is the result of a network API call.
				194	"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.
				195	"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.
				196	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				197	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				198	{
				199	"a_key": "", # Properties of the object. Contains field @type with type URL.
				200	},
				201	],
				202	"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.
				203	},
				204	"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.
				205	"a_key": "", # Properties of the object. Contains field @type with type URL.
				206	},
				207	"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}`.
				208	"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`.
				209	"a_key": "", # Properties of the object. Contains field @type with type URL.
				210	},
				211	}</pre>
				212	</div>
				213
				214	<div class="method">
				215	<code class="details" id="get">get(name, x__xgafv=None)</code>
				216	<pre>Gets details of executions
				217
				218	Args:
yoshi-code-bot	b539cc4	2021-08-03 00:20:27 -0700	[diff] [blame]	219	name: string, Required. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}` (required)
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	220	x__xgafv: string, V1 error format.
				221	Allowed values
				222	1 - v1 error format
				223	2 - v2 error format
				224
				225	Returns:
				226	An object of the form:
				227
				228	{ # The definition of a single executed notebook.
				229	"createTime": "A String", # Output only. Time the Execution was instantiated.
				230	"description": "A String", # A brief description of this execution.
				231	"displayName": "A String", # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.
				232	"executionTemplate": { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc.
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	233	"acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus) to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	234	"coreCount": "A String", # Count of cores of this accelerator.
				235	"type": "A String", # Type of this accelerator.
				236	},
				237	"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
yoshi-code-bot	cdf480e	2021-08-17 00:20:40 -0700	[diff] [blame]	238	"dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	239	"cluster": "A String", # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
yoshi-code-bot	cdf480e	2021-08-17 00:20:40 -0700	[diff] [blame]	240	},
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	241	"inputNotebookFile": "A String", # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: `gs://{bucket_name}/{folder}/{notebook_file_name}` Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
yoshi-code-bot	cdf480e	2021-08-17 00:20:40 -0700	[diff] [blame]	242	"jobType": "A String", # The type of Job to be used on this execution.
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	243	"kernelSpec": "A String", # Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does not match the name in the input notebook file.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	244	"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.
				245	"a_key": "A String",
				246	},
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	247	"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](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	248	"outputNotebookFolder": "A String", # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: `gs://{bucket_name}/{folder}` Ex: `gs://notebook_user/scheduled_notebooks`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	249	"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	250	"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`
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	251	"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	252	"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	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	253	"vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	254	"env": { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
				255	"a_key": "A String",
				256	},
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	257	"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. If left unspecified, the job is not peered with any network.
				258	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	259	},
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	260	"jobUri": "A String", # Output only. The URI of the external job used to execute the notebook.
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	261	"name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	262	"outputNotebookFile": "A String", # Output notebook file generated by this execution
				263	"state": "A String", # Output only. State of the underlying AI Platform job.
				264	"updateTime": "A String", # Output only. Time the Execution was last updated.
				265	}</pre>
				266	</div>
				267
				268	<div class="method">
				269	<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
				270	<pre>Lists executions in a given project and location
				271
				272	Args:
				273	parent: string, Required. Format: `parent=projects/{project_id}/locations/{location}` (required)
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	274	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]	275	orderBy: string, Sort by field.
				276	pageSize: integer, Maximum return size of the list call.
				277	pageToken: string, A previous returned page token that can be used to continue listing from the last result.
				278	x__xgafv: string, V1 error format.
				279	Allowed values
				280	1 - v1 error format
				281	2 - v2 error format
				282
				283	Returns:
				284	An object of the form:
				285
				286	{ # Response for listing scheduled notebook executions
				287	"executions": [ # A list of returned instances.
				288	{ # The definition of a single executed notebook.
				289	"createTime": "A String", # Output only. Time the Execution was instantiated.
				290	"description": "A String", # A brief description of this execution.
				291	"displayName": "A String", # Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.
				292	"executionTemplate": { # The description a notebook execution workload. # execute metadata including name, hardware spec, region, labels, etc.
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	293	"acceleratorConfig": { # Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus) to find a valid combination. TPUs are not supported. # Configuration (count and accelerator type) for hardware running notebook execution.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	294	"coreCount": "A String", # Count of cores of this accelerator.
				295	"type": "A String", # Type of this accelerator.
				296	},
				297	"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
yoshi-code-bot	cdf480e	2021-08-17 00:20:40 -0700	[diff] [blame]	298	"dataprocParameters": { # Parameters used in Dataproc JobType executions. # Parameters used in Dataproc JobType executions.
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	299	"cluster": "A String", # URI for cluster used to run Dataproc execution. Format: `projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}`
yoshi-code-bot	cdf480e	2021-08-17 00:20:40 -0700	[diff] [blame]	300	},
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	301	"inputNotebookFile": "A String", # Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: `gs://{bucket_name}/{folder}/{notebook_file_name}` Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
yoshi-code-bot	cdf480e	2021-08-17 00:20:40 -0700	[diff] [blame]	302	"jobType": "A String", # The type of Job to be used on this execution.
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	303	"kernelSpec": "A String", # Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does not match the name in the input notebook file.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	304	"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.
				305	"a_key": "A String",
				306	},
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	307	"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](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	308	"outputNotebookFolder": "A String", # Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: `gs://{bucket_name}/{folder}` Ex: `gs://notebook_user/scheduled_notebooks`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	309	"parameters": "A String", # Parameters used within the 'input_notebook_file' notebook.
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	310	"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`
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	311	"scaleTier": "A String", # Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	312	"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	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	313	"vertexAiParameters": { # Parameters used in Vertex AI JobType executions. # Parameters used in Vertex AI JobType executions.
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	314	"env": { # Environment variables. At most 100 environment variables can be specified and unique. Example: GCP_BUCKET=gs://my-bucket/samples/
				315	"a_key": "A String",
				316	},
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	317	"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. If left unspecified, the job is not peered with any network.
				318	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	319	},
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	320	"jobUri": "A String", # Output only. The URI of the external job used to execute the notebook.
yoshi-code-bot	312da31	2021-09-21 00:22:28 -0700	[diff] [blame]	321	"name": "A String", # Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	322	"outputNotebookFile": "A String", # Output notebook file generated by this execution
				323	"state": "A String", # Output only. State of the underlying AI Platform job.
				324	"updateTime": "A String", # Output only. Time the Execution was last updated.
				325	},
				326	],
				327	"nextPageToken": "A String", # Page token that can be used to continue listing from the last result in the next list call.
yoshi-code-bot	12d387c	2021-10-26 00:24:32 -0700	[diff] [blame]	328	"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']
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	329	"A String",
				330	],
				331	}</pre>
				332	</div>
				333
				334	<div class="method">
				335	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				336	<pre>Retrieves the next page of results.
				337
				338	Args:
				339	previous_request: The request for the previous page. (required)
				340	previous_response: The response from the request for the previous page. (required)
				341
				342	Returns:
				343	A request object that you can call 'execute()' on to request the next
				344	page. Returns None if there are no more items in the collection.
				345	</pre>
				346	</div>
				347
				348	</body></html>