Blame - docs/dyn/workflows_v1.projects.locations.workflows.html - platform/external/python/google-api-python-client

blob: 7a80c9c123878d7a4baef0198db401a771201e47 [file] [log] [blame]

yoshi-code-bot	6970659	2021-03-03 03:54:02 -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="workflows_v1.html">Workflows API</a> . <a href="workflows_v1.projects.html">projects</a> . <a href="workflows_v1.projects.locations.html">locations</a> . <a href="workflows_v1.projects.locations.workflows.html">workflows</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, workflowId=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return ALREADY_EXISTS error.</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 workflow with the specified name. This method also cancels and deletes all running executions of the workflow.</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 Workflow.</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 Workflows in a given project and location. The default order is not specified.</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	<p class="toc_element">
				96	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				97	<p class="firstline">Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions.</p>
				98	<h3>Method Details</h3>
				99	<div class="method">
				100	<code class="details" id="close">close()</code>
				101	<pre>Close httplib2 connections.</pre>
				102	</div>
				103
				104	<div class="method">
				105	<code class="details" id="create">create(parent, body=None, workflowId=None, x__xgafv=None)</code>
				106	<pre>Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return ALREADY_EXISTS error.
				107
				108	Args:
				109	parent: string, Required. Project and location in which the workflow should be created. Format: projects/{project}/locations/{location} (required)
				110	body: object, The request body.
				111	The object takes the form of:
				112
				113	{ # Workflow program to be executed by Workflows.
				114	"createTime": "A String", # Output only. The timestamp of when the workflow was created.
				115	"description": "A String", # Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
				116	"labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.
				117	"a_key": "A String",
				118	},
				119	"name": "A String", # The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
				120	"revisionCreateTime": "A String", # Output only. The timestamp that the latest revision of the workflow was created.
				121	"revisionId": "A String", # Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	122	"serviceAccount": "A String", # The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. The `{account}` value can be the `email` address or the `unique_id` of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	123	"sourceContents": "A String", # Workflow code to be executed. The size limit is 128KB.
yoshi-code-bot	6970659	2021-03-03 03:54:02 -0800	[diff] [blame]	124	"state": "A String", # Output only. State of the workflow deployment.
				125	"updateTime": "A String", # Output only. The last update timestamp of the workflow.
				126	}
				127
				128	workflowId: string, Required. The ID of the workflow to be created. It has to fulfill the following requirements: * Must contain only letters, numbers, underscores and hyphens. * Must start with a letter. * Must be between 1-64 characters. * Must end with a number or a letter. * Must be unique within the customer project and location.
				129	x__xgafv: string, V1 error format.
				130	Allowed values
				131	1 - v1 error format
				132	2 - v2 error format
				133
				134	Returns:
				135	An object of the form:
				136
				137	{ # This resource represents a long-running operation that is the result of a network API call.
				138	"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.
				139	"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.
				140	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				141	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				142	{
				143	"a_key": "", # Properties of the object. Contains field @type with type URL.
				144	},
				145	],
				146	"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.
				147	},
				148	"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.
				149	"a_key": "", # Properties of the object. Contains field @type with type URL.
				150	},
				151	"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}`.
				152	"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`.
				153	"a_key": "", # Properties of the object. Contains field @type with type URL.
				154	},
				155	}</pre>
				156	</div>
				157
				158	<div class="method">
				159	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				160	<pre>Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.
				161
				162	Args:
				163	name: string, Required. Name of the workflow to be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow} (required)
				164	x__xgafv: string, V1 error format.
				165	Allowed values
				166	1 - v1 error format
				167	2 - v2 error format
				168
				169	Returns:
				170	An object of the form:
				171
				172	{ # This resource represents a long-running operation that is the result of a network API call.
				173	"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.
				174	"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.
				175	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				176	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				177	{
				178	"a_key": "", # Properties of the object. Contains field @type with type URL.
				179	},
				180	],
				181	"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.
				182	},
				183	"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.
				184	"a_key": "", # Properties of the object. Contains field @type with type URL.
				185	},
				186	"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}`.
				187	"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`.
				188	"a_key": "", # Properties of the object. Contains field @type with type URL.
				189	},
				190	}</pre>
				191	</div>
				192
				193	<div class="method">
				194	<code class="details" id="get">get(name, x__xgafv=None)</code>
				195	<pre>Gets details of a single Workflow.
				196
				197	Args:
				198	name: string, Required. Name of the workflow which information should be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow} (required)
				199	x__xgafv: string, V1 error format.
				200	Allowed values
				201	1 - v1 error format
				202	2 - v2 error format
				203
				204	Returns:
				205	An object of the form:
				206
				207	{ # Workflow program to be executed by Workflows.
				208	"createTime": "A String", # Output only. The timestamp of when the workflow was created.
				209	"description": "A String", # Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
				210	"labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.
				211	"a_key": "A String",
				212	},
				213	"name": "A String", # The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
				214	"revisionCreateTime": "A String", # Output only. The timestamp that the latest revision of the workflow was created.
				215	"revisionId": "A String", # Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	216	"serviceAccount": "A String", # The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. The `{account}` value can be the `email` address or the `unique_id` of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	217	"sourceContents": "A String", # Workflow code to be executed. The size limit is 128KB.
yoshi-code-bot	6970659	2021-03-03 03:54:02 -0800	[diff] [blame]	218	"state": "A String", # Output only. State of the workflow deployment.
				219	"updateTime": "A String", # Output only. The last update timestamp of the workflow.
				220	}</pre>
				221	</div>
				222
				223	<div class="method">
				224	<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
				225	<pre>Lists Workflows in a given project and location. The default order is not specified.
				226
				227	Args:
				228	parent: string, Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location} (required)
				229	filter: string, Filter to restrict results to specific workflows.
				230	orderBy: string, Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a " desc" suffix. If not specified, the results will be returned in an unspecified order.
				231	pageSize: integer, Maximum number of workflows to return per call. The service may return fewer than this value. If the value is not specified, a default value of 500 will be used. The maximum permitted value is 1000 and values greater than 1000 will be coerced down to 1000.
				232	pageToken: string, A page token, received from a previous `ListWorkflows` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflows` must match the call that provided the page token.
				233	x__xgafv: string, V1 error format.
				234	Allowed values
				235	1 - v1 error format
				236	2 - v2 error format
				237
				238	Returns:
				239	An object of the form:
				240
				241	{ # Response for the ListWorkflows method.
				242	"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
				243	"unreachable": [ # Unreachable resources.
				244	"A String",
				245	],
				246	"workflows": [ # The workflows which match the request.
				247	{ # Workflow program to be executed by Workflows.
				248	"createTime": "A String", # Output only. The timestamp of when the workflow was created.
				249	"description": "A String", # Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
				250	"labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.
				251	"a_key": "A String",
				252	},
				253	"name": "A String", # The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
				254	"revisionCreateTime": "A String", # Output only. The timestamp that the latest revision of the workflow was created.
				255	"revisionId": "A String", # Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	256	"serviceAccount": "A String", # The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. The `{account}` value can be the `email` address or the `unique_id` of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	257	"sourceContents": "A String", # Workflow code to be executed. The size limit is 128KB.
yoshi-code-bot	6970659	2021-03-03 03:54:02 -0800	[diff] [blame]	258	"state": "A String", # Output only. State of the workflow deployment.
				259	"updateTime": "A String", # Output only. The last update timestamp of the workflow.
				260	},
				261	],
				262	}</pre>
				263	</div>
				264
				265	<div class="method">
				266	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				267	<pre>Retrieves the next page of results.
				268
				269	Args:
				270	previous_request: The request for the previous page. (required)
				271	previous_response: The response from the request for the previous page. (required)
				272
				273	Returns:
				274	A request object that you can call 'execute()' on to request the next
				275	page. Returns None if there are no more items in the collection.
				276	</pre>
				277	</div>
				278
				279	<div class="method">
				280	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				281	<pre>Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions.
				282
				283	Args:
				284	name: string, The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow} (required)
				285	body: object, The request body.
				286	The object takes the form of:
				287
				288	{ # Workflow program to be executed by Workflows.
				289	"createTime": "A String", # Output only. The timestamp of when the workflow was created.
				290	"description": "A String", # Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
				291	"labels": { # Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.
				292	"a_key": "A String",
				293	},
				294	"name": "A String", # The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
				295	"revisionCreateTime": "A String", # Output only. The timestamp that the latest revision of the workflow was created.
				296	"revisionId": "A String", # Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.
yoshi-code-bot	3e4b5db	2021-08-10 00:22:29 -0700	[diff] [blame]	297	"serviceAccount": "A String", # The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. The `{account}` value can be the `email` address or the `unique_id` of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	298	"sourceContents": "A String", # Workflow code to be executed. The size limit is 128KB.
yoshi-code-bot	6970659	2021-03-03 03:54:02 -0800	[diff] [blame]	299	"state": "A String", # Output only. State of the workflow deployment.
				300	"updateTime": "A String", # Output only. The last update timestamp of the workflow.
				301	}
				302
				303	updateMask: string, List of fields to be updated. If not present, the entire workflow will be updated.
				304	x__xgafv: string, V1 error format.
				305	Allowed values
				306	1 - v1 error format
				307	2 - v2 error format
				308
				309	Returns:
				310	An object of the form:
				311
				312	{ # This resource represents a long-running operation that is the result of a network API call.
				313	"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.
				314	"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.
				315	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				316	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				317	{
				318	"a_key": "", # Properties of the object. Contains field @type with type URL.
				319	},
				320	],
				321	"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.
				322	},
				323	"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.
				324	"a_key": "", # Properties of the object. Contains field @type with type URL.
				325	},
				326	"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}`.
				327	"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`.
				328	"a_key": "", # Properties of the object. Contains field @type with type URL.
				329	},
				330	}</pre>
				331	</div>
				332
				333	</body></html>