Blame - docs/dyn/apigee_v1.organizations.instances.html - platform/external/python/google-api-python-client

blob: 0e7ba96a0112209362e29ae460501495b6dda335 [file] [log] [blame]

Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -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="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.instances.html">instances</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="apigee_v1.organizations.instances.attachments.html">attachments()</a></code>
				79	</p>
				80	<p class="firstline">Returns the attachments Resource.</p>
				81
				82	<p class="toc_element">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	83	<code><a href="apigee_v1.organizations.instances.canaryevaluations.html">canaryevaluations()</a></code>
				84	</p>
				85	<p class="firstline">Returns the canaryevaluations Resource.</p>
				86
				87	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	88	<code><a href="#close">close()</a></code></p>
				89	<p class="firstline">Close httplib2 connections.</p>
				90	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	91	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	92	<p class="firstline">Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. Note: Not supported for Apigee hybrid.</p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	93	<p class="toc_element">
				94	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	95	<p class="firstline">Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. Note: Not supported for Apigee hybrid.</p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	96	<p class="toc_element">
				97	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	98	<p class="firstline">Gets the details for an Apigee runtime instance. Note: Not supported for Apigee hybrid.</p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	99	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	100	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	101	<p class="firstline">Lists all Apigee runtime instances for the organization. Note: Not supported for Apigee hybrid.</p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	102	<p class="toc_element">
				103	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				104	<p class="firstline">Retrieves the next page of results.</p>
				105	<p class="toc_element">
				106	<code><a href="#reportStatus">reportStatus(instance, body=None, x__xgafv=None)</a></code></p>
				107	<p class="firstline">Reports the latest status for a runtime instance.</p>
				108	<h3>Method Details</h3>
				109	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	110	<code class="details" id="close">close()</code>
				111	<pre>Close httplib2 connections.</pre>
				112	</div>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	113
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	114	<div class="method">
				115	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
				116	<pre>Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. Note: Not supported for Apigee hybrid.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	117
				118	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	119	parent: string, Required. Name of the organization. Use the following structure in your request: `organizations/{org}`. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	120	body: object, The request body.
				121	The object takes the form of:
				122
				123	{ # Apigee runtime instance.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	124	"createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch.
				125	"description": "A String", # Optional. Description of the instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	126	"diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption.
				127	"displayName": "A String", # Optional. Display name for the instance.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	128	"host": "A String", # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	129	"lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
				130	"location": "A String", # Required. Compute Engine location where the instance resides.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	131	"name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	132	"port": "A String", # Output only. Port number of the exposed Apigee endpoint.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	133	"state": "A String", # Output only. State of the instance. Values other than ACTIVE means the resource is not ready to use.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	134	}
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	135
				136	x__xgafv: string, V1 error format.
				137	Allowed values
				138	1 - v1 error format
				139	2 - v2 error format
				140
				141	Returns:
				142	An object of the form:
				143
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	144	{ # 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^]	145	"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.
				146	"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.
				147	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				148	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				149	{
				150	"a_key": "", # Properties of the object. Contains field @type with type URL.
				151	},
				152	],
				153	"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.
				154	},
				155	"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.
				156	"a_key": "", # Properties of the object. Contains field @type with type URL.
				157	},
				158	"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}`.
				159	"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`.
				160	"a_key": "", # Properties of the object. Contains field @type with type URL.
				161	},
				162	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	163	</div>
				164
				165	<div class="method">
				166	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	167	<pre>Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. Note: Not supported for Apigee hybrid.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	168
				169	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	170	name: string, Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	171	x__xgafv: string, V1 error format.
				172	Allowed values
				173	1 - v1 error format
				174	2 - v2 error format
				175
				176	Returns:
				177	An object of the form:
				178
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	179	{ # 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^]	180	"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.
				181	"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.
				182	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				183	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				184	{
				185	"a_key": "", # Properties of the object. Contains field @type with type URL.
				186	},
				187	],
				188	"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.
				189	},
				190	"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.
				191	"a_key": "", # Properties of the object. Contains field @type with type URL.
				192	},
				193	"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}`.
				194	"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`.
				195	"a_key": "", # Properties of the object. Contains field @type with type URL.
				196	},
				197	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	198	</div>
				199
				200	<div class="method">
				201	<code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	202	<pre>Gets the details for an Apigee runtime instance. Note: Not supported for Apigee hybrid.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	203
				204	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	205	name: string, Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	206	x__xgafv: string, V1 error format.
				207	Allowed values
				208	1 - v1 error format
				209	2 - v2 error format
				210
				211	Returns:
				212	An object of the form:
				213
				214	{ # Apigee runtime instance.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	215	"createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch.
				216	"description": "A String", # Optional. Description of the instance.
				217	"diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption.
				218	"displayName": "A String", # Optional. Display name for the instance.
				219	"host": "A String", # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.
				220	"lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
				221	"location": "A String", # Required. Compute Engine location where the instance resides.
				222	"name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
				223	"port": "A String", # Output only. Port number of the exposed Apigee endpoint.
				224	"state": "A String", # Output only. State of the instance. Values other than ACTIVE means the resource is not ready to use.
				225	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	226	</div>
				227
				228	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	229	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	230	<pre>Lists all Apigee runtime instances for the organization. Note: Not supported for Apigee hybrid.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	231
				232	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	233	parent: string, Required. Name of the organization. Use the following structure in your request: `organizations/{org}`. (required)
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	234	pageSize: integer, Maximum number of instances to return. Defaults to 25.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	235	pageToken: string, Page token, returned from a previous ListInstances call, that you can use to retrieve the next page of content.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	236	x__xgafv: string, V1 error format.
				237	Allowed values
				238	1 - v1 error format
				239	2 - v2 error format
				240
				241	Returns:
				242	An object of the form:
				243
				244	{ # Response for ListInstances.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	245	"instances": [ # Instances in the specified organization.
				246	{ # Apigee runtime instance.
				247	"createdAt": "A String", # Output only. Time the instance was created in milliseconds since epoch.
				248	"description": "A String", # Optional. Description of the instance.
				249	"diskEncryptionKeyName": "A String", # Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption.
				250	"displayName": "A String", # Optional. Display name for the instance.
				251	"host": "A String", # Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.
				252	"lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch.
				253	"location": "A String", # Required. Compute Engine location where the instance resides.
				254	"name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
				255	"port": "A String", # Output only. Port number of the exposed Apigee endpoint.
				256	"state": "A String", # Output only. State of the instance. Values other than ACTIVE means the resource is not ready to use.
				257	},
				258	],
				259	"nextPageToken": "A String", # Page token that you can include in a ListInstance request to retrieve the next page of content. If omitted, no subsequent pages exist.
				260	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	261	</div>
				262
				263	<div class="method">
				264	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				265	<pre>Retrieves the next page of results.
				266
				267	Args:
				268	previous_request: The request for the previous page. (required)
				269	previous_response: The response from the request for the previous page. (required)
				270
				271	Returns:
				272	A request object that you can call 'execute()' on to request the next
				273	page. Returns None if there are no more items in the collection.
				274	</pre>
				275	</div>
				276
				277	<div class="method">
				278	<code class="details" id="reportStatus">reportStatus(instance, body=None, x__xgafv=None)</code>
				279	<pre>Reports the latest status for a runtime instance.
				280
				281	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	282	instance: string, The name of the instance reporting this status. For SaaS the request will be rejected if no instance exists under this name. Format is organizations/{org}/instances/{instance} (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	283	body: object, The request body.
				284	The object takes the form of:
				285
				286	{ # Request for ReportInstanceStatus.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	287	"instanceUid": "A String", # A unique ID for the instance which is guaranteed to be unique in case the user installs multiple hybrid runtimes with the same instance ID.
				288	"reportTime": "A String", # The time the report was generated in the runtime. Used to prevent an old status from overwriting a newer one. An instance should space out it's status reports so that clock skew does not play a factor.
				289	"resources": [ # Status for config resources
				290	{ # The status of a resource loaded in the runtime.
				291	"resource": "A String", # The resource name. Currently only two resources are supported: EnvironmentGroup - organizations/{org}/envgroups/{envgroup} EnvironmentConfig - organizations/{org}/environments/{environment}/deployedConfig
				292	"revisions": [ # Revisions of the resource currently deployed in the instance.
				293	{ # The status of a specific resource revision.
				294	"errors": [ # Errors reported when attempting to load this revision.
				295	{ # Details on why a resource update failed in the runtime.
				296	"code": "A String", # Status code.
				297	"message": "A String", # User-friendly error message.
				298	"resource": "A String", # The sub resource specific to this error (e.g. a proxy deployed within the EnvironmentConfig). If empty the error refers to the top level resource.
				299	"type": "A String", # A string that uniquely identifies the type of error. This provides a more reliable means to deduplicate errors across revisions and instances.
				300	},
				301	],
				302	"jsonSpec": "A String", # The json content of the resource revision.
				303	"replicas": 42, # The number of replicas that have successfully loaded this revision.
				304	"revisionId": "A String", # The revision of the resource.
				305	},
				306	],
				307	"totalReplicas": 42, # The total number of replicas that should have this resource.
				308	"uid": "A String", # The uid of the resource. In the unexpected case that the instance has multiple uids for the same name, they should be reported under separate ResourceStatuses.
				309	},
				310	],
				311	}
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	312
				313	x__xgafv: string, V1 error format.
				314	Allowed values
				315	1 - v1 error format
				316	2 - v2 error format
				317
				318	Returns:
				319	An object of the form:
				320
				321	{ # Placeholder for future enhancements to status reporting protocol
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	322	}</pre>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	323	</div>
				324
				325	</body></html>