Blame - docs/dyn/compute_alpha.interconnectLocations.html - platform/external/python/google-api-python-client

blob: 0148f0f25a1d6c7d6eff8e7f87f0aaa16b099b15 [file] [log] [blame]

Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.interconnectLocations.html">interconnectLocations</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	81	<code><a href="#get">get(project, interconnectLocation)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	82	<p class="firstline">Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.</p>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	83	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	84	<code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	85	<p class="firstline">Retrieves the list of interconnect locations available to the specified project.</p>
				86	<p class="toc_element">
				87	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				88	<p class="firstline">Retrieves the next page of results.</p>
				89	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	90	<code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	91	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				92	<h3>Method Details</h3>
				93	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	94	<code class="details" id="close">close()</code>
				95	<pre>Close httplib2 connections.</pre>
				96	</div>
				97
				98	<div class="method">
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	99	<code class="details" id="get">get(project, interconnectLocation)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	100	<pre>Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	101
				102	Args:
				103	project: string, Project ID for this request. (required)
				104	interconnectLocation: string, Name of the interconnect location to return. (required)
				105
				106	Returns:
				107	An object of the form:
				108
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	109	{ # Represents an Interconnect Attachment (VLAN) Location resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	110	#
				111	# You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.
				112	"address": "A String", # [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.
				113	"availabilityZone": "A String", # [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2".
				114	"city": "A String", # [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".
				115	"continent": "A String", # [Output Only] Continent for this location, which can take one of the following values:
				116	# - AFRICA
				117	# - ASIA_PAC
				118	# - EUROPE
				119	# - NORTH_AMERICA
				120	# - SOUTH_AMERICA
				121	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				122	"description": "A String", # [Output Only] An optional description of the resource.
				123	"facilityProvider": "A String", # [Output Only] The name of the provider for this facility (e.g., EQUINIX).
				124	"facilityProviderFacilityId": "A String", # [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).
				125	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				126	"kind": "compute#interconnectLocation", # [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.
				127	"name": "A String", # [Output Only] Name of the resource.
				128	"peeringdbFacilityId": "A String", # [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).
				129	"regionInfos": [ # [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.
				130	{ # Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.
				131	"expectedRttMs": "A String", # Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.
				132	"locationPresence": "A String", # Identifies the network presence of this location.
				133	"region": "A String", # URL for the region of this location.
				134	},
				135	],
				136	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				137	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				138	"status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values:
				139	# - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects.
				140	# - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.
				141	}</pre>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	142	</div>
				143
				144	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	145	<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	146	<pre>Retrieves the list of interconnect locations available to the specified project.
				147
				148	Args:
				149	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	150	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	151
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	152	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	153
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	154	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	155
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	156	To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
				157	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
				158	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				159
				160	You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
				161
				162	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				163	pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
				164	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	165
				166	Returns:
				167	An object of the form:
				168
				169	{ # Response to the list request, and contains a list of interconnect locations.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	170	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				171	"items": [ # A list of InterconnectLocation resources.
				172	{ # Represents an Interconnect Attachment (VLAN) Location resource.
				173	#
				174	# You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.
				175	"address": "A String", # [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.
				176	"availabilityZone": "A String", # [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2".
				177	"city": "A String", # [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".
				178	"continent": "A String", # [Output Only] Continent for this location, which can take one of the following values:
				179	# - AFRICA
				180	# - ASIA_PAC
				181	# - EUROPE
				182	# - NORTH_AMERICA
				183	# - SOUTH_AMERICA
				184	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				185	"description": "A String", # [Output Only] An optional description of the resource.
				186	"facilityProvider": "A String", # [Output Only] The name of the provider for this facility (e.g., EQUINIX).
				187	"facilityProviderFacilityId": "A String", # [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).
				188	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				189	"kind": "compute#interconnectLocation", # [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.
				190	"name": "A String", # [Output Only] Name of the resource.
				191	"peeringdbFacilityId": "A String", # [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).
				192	"regionInfos": [ # [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.
				193	{ # Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.
				194	"expectedRttMs": "A String", # Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.
				195	"locationPresence": "A String", # Identifies the network presence of this location.
				196	"region": "A String", # URL for the region of this location.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	197	},
				198	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	199	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				200	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				201	"status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values:
				202	# - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects.
				203	# - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	204	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	205	],
				206	"kind": "compute#interconnectLocationList", # [Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations.
				207	"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
				208	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				209	"warning": { # [Output Only] Informational warning message.
				210	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				211	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				212	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				213	{
				214	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				215	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				216	},
				217	],
				218	"message": "A String", # [Output Only] A human-readable description of the warning code.
				219	},
				220	}</pre>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	221	</div>
				222
				223	<div class="method">
				224	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				225	<pre>Retrieves the next page of results.
				226
				227	Args:
				228	previous_request: The request for the previous page. (required)
				229	previous_response: The response from the request for the previous page. (required)
				230
				231	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	232	A request object that you can call 'execute()' on to request the next
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	233	page. Returns None if there are no more items in the collection.
				234	</pre>
				235	</div>
				236
				237	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	238	<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	239	<pre>Returns permissions that a caller has on the specified resource.
				240
				241	Args:
				242	project: string, Project ID for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	243	resource: string, Name or id of the resource for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	244	body: object, The request body.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	245	The object takes the form of:
				246
				247	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	248	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				249	"A String",
				250	],
				251	}
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	252
				253
				254	Returns:
				255	An object of the form:
				256
				257	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	258	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				259	"A String",
				260	],
				261	}</pre>
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	262	</div>
				263
				264	</body></html>