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

blob: 20bf5224e1f9ff81cd48f061033155ad91b6826b [file] [log] [blame]

Sai Cheemalapati	df61397	2016-10-21 13:59:49 -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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.routers.html">routers</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
				79	<p class="firstline">Retrieves an aggregated list of routers.</p>
				80	<p class="toc_element">
				81	<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
				82	<p class="firstline">Retrieves the next page of results.</p>
				83	<p class="toc_element">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	84	<code><a href="#delete">delete(project, region, router, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	85	<p class="firstline">Deletes the specified Router resource.</p>
				86	<p class="toc_element">
				87	<code><a href="#get">get(project, region, router)</a></code></p>
				88	<p class="firstline">Returns the specified Router resource. Get a list of available routers by making a list() request.</p>
				89	<p class="toc_element">
				90	<code><a href="#getRouterStatus">getRouterStatus(project, region, router)</a></code></p>
				91	<p class="firstline">Retrieves runtime information of the specified router.</p>
				92	<p class="toc_element">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	93	<code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	94	<p class="firstline">Creates a Router resource in the specified project and region using the data included in the request.</p>
				95	<p class="toc_element">
				96	<code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
				97	<p class="firstline">Retrieves a list of Router resources available to the specified project.</p>
				98	<p class="toc_element">
				99	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				100	<p class="firstline">Retrieves the next page of results.</p>
				101	<p class="toc_element">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	102	<code><a href="#patch">patch(project, region, router, body, requestId=None)</a></code></p>
				103	<p class="firstline">Patches the specified Router resource with the data included in the request. This method supports patch semantics.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	104	<p class="toc_element">
				105	<code><a href="#preview">preview(project, region, router, body)</a></code></p>
				106	<p class="firstline">Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.</p>
				107	<p class="toc_element">
				108	<code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
				109	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				110	<p class="toc_element">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	111	<code><a href="#update">update(project, region, router, body, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	112	<p class="firstline">Updates the specified Router resource with the data included in the request.</p>
				113	<h3>Method Details</h3>
				114	<div class="method">
				115	<code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
				116	<pre>Retrieves an aggregated list of routers.
				117
				118	Args:
				119	project: string, Project ID for this request. (required)
				120	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				121
				122	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.
				123
				124	Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	125	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)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	126	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.
				127	filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
				128
				129	The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
				130
				131	For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
				132
				133	You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
				134
				135	To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
				136
				137	Returns:
				138	An object of the form:
				139
				140	{ # Contains a list of routers.
				141	"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.
				142	"items": { # A map of scoped router lists.
				143	"a_key": { # Name of the scope containing this set of routers.
				144	"routers": [ # List of routers contained in this scope.
				145	{ # Router resource.
				146	"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
				147	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				148	"interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
				149	{
				150	"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
				151	"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
				152	"name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
				153	},
				154	],
				155	"bgp": { # BGP information specific to this router.
				156	"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
				157	},
				158	"network": "A String", # URI of the network to which this router belongs.
				159	"bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
				160	{
				161	"interfaceName": "A String", # Name of the interface the BGP peer is associated with.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	162	"peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	163	"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
				164	"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	165	"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	166	"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
				167	},
				168	],
				169	"region": "A String", # [Output Only] URI of the region where the router resides.
				170	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				171	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				172	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				173	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				174	},
				175	],
				176	"warning": { # Informational warning which replaces the list of routers when the list is empty.
				177	"message": "A String", # [Output Only] A human-readable description of the warning code.
				178	"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.
				179	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				180	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				181	{
				182	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				183	"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).
				184	},
				185	],
				186	},
				187	},
				188	},
				189	"kind": "compute#routerAggregatedList", # Type of resource.
				190	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				191	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				192	}</pre>
				193	</div>
				194
				195	<div class="method">
				196	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				197	<pre>Retrieves the next page of results.
				198
				199	Args:
				200	previous_request: The request for the previous page. (required)
				201	previous_response: The response from the request for the previous page. (required)
				202
				203	Returns:
				204	A request object that you can call 'execute()' on to request the next
				205	page. Returns None if there are no more items in the collection.
				206	</pre>
				207	</div>
				208
				209	<div class="method">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	210	<code class="details" id="delete">delete(project, region, router, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	211	<pre>Deletes the specified Router resource.
				212
				213	Args:
				214	project: string, Project ID for this request. (required)
				215	region: string, Name of the region for this request. (required)
				216	router: string, Name of the Router resource to delete. (required)
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	217	requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	218
				219	Returns:
				220	An object of the form:
				221
				222	{ # An Operation resource, used to manage asynchronous API requests.
				223	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				224	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	225	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	226	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				227	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				228	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				229	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				230	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				231	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				232	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
				233	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				234	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				235	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				236	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				237	{
				238	"message": "A String", # [Output Only] A human-readable description of the warning code.
				239	"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.
				240	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				241	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				242	{
				243	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				244	"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).
				245	},
				246	],
				247	},
				248	],
				249	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				250	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				251	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				252	"name": "A String", # [Output Only] Name of the resource.
				253	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
				254	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				255	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				256	{
				257	"message": "A String", # [Output Only] An optional, human-readable error message.
				258	"code": "A String", # [Output Only] The error type identifier for this error.
				259	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				260	},
				261	],
				262	},
				263	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				264	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	265	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	266	}</pre>
				267	</div>
				268
				269	<div class="method">
				270	<code class="details" id="get">get(project, region, router)</code>
				271	<pre>Returns the specified Router resource. Get a list of available routers by making a list() request.
				272
				273	Args:
				274	project: string, Project ID for this request. (required)
				275	region: string, Name of the region for this request. (required)
				276	router: string, Name of the Router resource to return. (required)
				277
				278	Returns:
				279	An object of the form:
				280
				281	{ # Router resource.
				282	"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
				283	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				284	"interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
				285	{
				286	"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
				287	"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
				288	"name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
				289	},
				290	],
				291	"bgp": { # BGP information specific to this router.
				292	"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
				293	},
				294	"network": "A String", # URI of the network to which this router belongs.
				295	"bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
				296	{
				297	"interfaceName": "A String", # Name of the interface the BGP peer is associated with.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	298	"peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	299	"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
				300	"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	301	"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	302	"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
				303	},
				304	],
				305	"region": "A String", # [Output Only] URI of the region where the router resides.
				306	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				307	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				308	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				309	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				310	}</pre>
				311	</div>
				312
				313	<div class="method">
				314	<code class="details" id="getRouterStatus">getRouterStatus(project, region, router)</code>
				315	<pre>Retrieves runtime information of the specified router.
				316
				317	Args:
				318	project: string, Project ID for this request. (required)
				319	region: string, Name of the region for this request. (required)
				320	router: string, Name of the Router resource to query. (required)
				321
				322	Returns:
				323	An object of the form:
				324
				325	{
				326	"kind": "compute#routerStatusResponse", # Type of resource.
				327	"result": {
				328	"bgpPeerStatus": [
				329	{
				330	"status": "A String", # Status of the BGP peer: {UP, DOWN}
				331	"uptime": "A String", # Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
				332	"name": "A String", # Name of this BGP peer. Unique within the Routers resource.
				333	"uptimeSeconds": "A String", # Time this session has been up, in seconds. Format: 145
				334	"linkedVpnTunnel": "A String", # URL of the VPN tunnel that this BGP peer controls.
				335	"peerIpAddress": "A String", # IP address of the remote BGP interface.
				336	"advertisedRoutes": [ # Routes that were advertised to the remote BGP peer
				337	{ # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
				338	#
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	339	# For each packet leaving a instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, an instance gateway, or a Google Compute Engine-operated gateway.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	340	#
				341	# Packets that do not match any route in the sending instance's routing table are dropped.
				342	"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
				343	"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
				344	"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
				345	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				346	"tags": [ # A list of instance tags to which this route applies.
				347	"A String",
				348	],
				349	"nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:
				350	# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
				351	"priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	352	"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	353	"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
				354	"network": "A String", # Fully-qualified URL of the network that this route applies to.
				355	"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
				356	"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
				357	{
				358	"message": "A String", # [Output Only] A human-readable description of the warning code.
				359	"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.
				360	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				361	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				362	{
				363	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				364	"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).
				365	},
				366	],
				367	},
				368	],
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	369	"destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	370	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				371	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	372	"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	373	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				374	},
				375	],
				376	"state": "A String", # BGP state as specified in RFC1771.
				377	"ipAddress": "A String", # IP address of the local BGP interface.
				378	"numLearnedRoutes": 42, # Number of routes learned from the remote BGP Peer.
				379	},
				380	],
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	381	"bestRoutesForRouter": [ # Best routes learned by this router.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	382	{ # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
				383	#
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	384	# For each packet leaving a instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, an instance gateway, or a Google Compute Engine-operated gateway.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	385	#
				386	# Packets that do not match any route in the sending instance's routing table are dropped.
				387	"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
				388	"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
				389	"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
				390	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				391	"tags": [ # A list of instance tags to which this route applies.
				392	"A String",
				393	],
				394	"nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:
				395	# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
				396	"priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	397	"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	398	"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
				399	"network": "A String", # Fully-qualified URL of the network that this route applies to.
				400	"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
				401	"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
				402	{
				403	"message": "A String", # [Output Only] A human-readable description of the warning code.
				404	"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.
				405	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				406	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				407	{
				408	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				409	"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).
				410	},
				411	],
				412	},
				413	],
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	414	"destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	415	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				416	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	417	"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.
				418	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				419	},
				420	],
				421	"network": "A String", # URI of the network to which this router belongs.
				422	"bestRoutes": [ # Best routes for this router's network.
				423	{ # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
				424	#
				425	# For each packet leaving a instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, an instance gateway, or a Google Compute Engine-operated gateway.
				426	#
				427	# Packets that do not match any route in the sending instance's routing table are dropped.
				428	"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
				429	"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
				430	"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
				431	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				432	"tags": [ # A list of instance tags to which this route applies.
				433	"A String",
				434	],
				435	"nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:
				436	# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
				437	"priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
				438	"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
				439	"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
				440	"network": "A String", # Fully-qualified URL of the network that this route applies to.
				441	"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
				442	"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
				443	{
				444	"message": "A String", # [Output Only] A human-readable description of the warning code.
				445	"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.
				446	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				447	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				448	{
				449	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				450	"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).
				451	},
				452	],
				453	},
				454	],
				455	"destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
				456	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				457	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				458	"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	459	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				460	},
				461	],
				462	},
				463	}</pre>
				464	</div>
				465
				466	<div class="method">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	467	<code class="details" id="insert">insert(project, region, body, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	468	<pre>Creates a Router resource in the specified project and region using the data included in the request.
				469
				470	Args:
				471	project: string, Project ID for this request. (required)
				472	region: string, Name of the region for this request. (required)
				473	body: object, The request body. (required)
				474	The object takes the form of:
				475
				476	{ # Router resource.
				477	"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
				478	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				479	"interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
				480	{
				481	"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
				482	"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
				483	"name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
				484	},
				485	],
				486	"bgp": { # BGP information specific to this router.
				487	"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
				488	},
				489	"network": "A String", # URI of the network to which this router belongs.
				490	"bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
				491	{
				492	"interfaceName": "A String", # Name of the interface the BGP peer is associated with.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	493	"peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	494	"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
				495	"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	496	"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	497	"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
				498	},
				499	],
				500	"region": "A String", # [Output Only] URI of the region where the router resides.
				501	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				502	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				503	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				504	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				505	}
				506
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	507	requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	508
				509	Returns:
				510	An object of the form:
				511
				512	{ # An Operation resource, used to manage asynchronous API requests.
				513	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				514	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	515	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	516	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				517	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				518	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				519	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				520	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				521	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				522	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
				523	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				524	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				525	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				526	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				527	{
				528	"message": "A String", # [Output Only] A human-readable description of the warning code.
				529	"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.
				530	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				531	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				532	{
				533	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				534	"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).
				535	},
				536	],
				537	},
				538	],
				539	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				540	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				541	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				542	"name": "A String", # [Output Only] Name of the resource.
				543	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
				544	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				545	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				546	{
				547	"message": "A String", # [Output Only] An optional, human-readable error message.
				548	"code": "A String", # [Output Only] The error type identifier for this error.
				549	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				550	},
				551	],
				552	},
				553	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				554	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	555	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	556	}</pre>
				557	</div>
				558
				559	<div class="method">
				560	<code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
				561	<pre>Retrieves a list of Router resources available to the specified project.
				562
				563	Args:
				564	project: string, Project ID for this request. (required)
				565	region: string, Name of the region for this request. (required)
				566	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				567
				568	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.
				569
				570	Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	571	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)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	572	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.
				573	filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
				574
				575	The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
				576
				577	For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
				578
				579	You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
				580
				581	To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
				582
				583	Returns:
				584	An object of the form:
				585
				586	{ # Contains a list of Router resources.
				587	"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.
				588	"items": [ # A list of Router resources.
				589	{ # Router resource.
				590	"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
				591	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				592	"interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
				593	{
				594	"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
				595	"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
				596	"name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
				597	},
				598	],
				599	"bgp": { # BGP information specific to this router.
				600	"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
				601	},
				602	"network": "A String", # URI of the network to which this router belongs.
				603	"bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
				604	{
				605	"interfaceName": "A String", # Name of the interface the BGP peer is associated with.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	606	"peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	607	"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
				608	"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	609	"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	610	"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
				611	},
				612	],
				613	"region": "A String", # [Output Only] URI of the region where the router resides.
				614	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				615	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				616	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				617	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				618	},
				619	],
				620	"kind": "compute#routerList", # [Output Only] Type of resource. Always compute#router for routers.
				621	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				622	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				623	}</pre>
				624	</div>
				625
				626	<div class="method">
				627	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				628	<pre>Retrieves the next page of results.
				629
				630	Args:
				631	previous_request: The request for the previous page. (required)
				632	previous_response: The response from the request for the previous page. (required)
				633
				634	Returns:
				635	A request object that you can call 'execute()' on to request the next
				636	page. Returns None if there are no more items in the collection.
				637	</pre>
				638	</div>
				639
				640	<div class="method">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	641	<code class="details" id="patch">patch(project, region, router, body, requestId=None)</code>
				642	<pre>Patches the specified Router resource with the data included in the request. This method supports patch semantics.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	643
				644	Args:
				645	project: string, Project ID for this request. (required)
				646	region: string, Name of the region for this request. (required)
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	647	router: string, Name of the Router resource to patch. (required)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	648	body: object, The request body. (required)
				649	The object takes the form of:
				650
				651	{ # Router resource.
				652	"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
				653	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				654	"interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
				655	{
				656	"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
				657	"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
				658	"name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
				659	},
				660	],
				661	"bgp": { # BGP information specific to this router.
				662	"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
				663	},
				664	"network": "A String", # URI of the network to which this router belongs.
				665	"bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
				666	{
				667	"interfaceName": "A String", # Name of the interface the BGP peer is associated with.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	668	"peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	669	"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
				670	"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	671	"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	672	"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
				673	},
				674	],
				675	"region": "A String", # [Output Only] URI of the region where the router resides.
				676	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				677	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				678	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				679	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				680	}
				681
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	682	requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	683
				684	Returns:
				685	An object of the form:
				686
				687	{ # An Operation resource, used to manage asynchronous API requests.
				688	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				689	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	690	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	691	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				692	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				693	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				694	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				695	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				696	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				697	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
				698	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				699	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				700	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				701	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				702	{
				703	"message": "A String", # [Output Only] A human-readable description of the warning code.
				704	"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.
				705	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				706	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				707	{
				708	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				709	"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).
				710	},
				711	],
				712	},
				713	],
				714	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				715	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				716	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				717	"name": "A String", # [Output Only] Name of the resource.
				718	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
				719	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				720	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				721	{
				722	"message": "A String", # [Output Only] An optional, human-readable error message.
				723	"code": "A String", # [Output Only] The error type identifier for this error.
				724	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				725	},
				726	],
				727	},
				728	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				729	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	730	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	731	}</pre>
				732	</div>
				733
				734	<div class="method">
				735	<code class="details" id="preview">preview(project, region, router, body)</code>
				736	<pre>Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.
				737
				738	Args:
				739	project: string, Project ID for this request. (required)
				740	region: string, Name of the region for this request. (required)
				741	router: string, Name of the Router resource to query. (required)
				742	body: object, The request body. (required)
				743	The object takes the form of:
				744
				745	{ # Router resource.
				746	"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
				747	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				748	"interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
				749	{
				750	"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
				751	"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
				752	"name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
				753	},
				754	],
				755	"bgp": { # BGP information specific to this router.
				756	"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
				757	},
				758	"network": "A String", # URI of the network to which this router belongs.
				759	"bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
				760	{
				761	"interfaceName": "A String", # Name of the interface the BGP peer is associated with.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	762	"peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	763	"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
				764	"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	765	"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	766	"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
				767	},
				768	],
				769	"region": "A String", # [Output Only] URI of the region where the router resides.
				770	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				771	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				772	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				773	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				774	}
				775
				776
				777	Returns:
				778	An object of the form:
				779
				780	{
				781	"resource": { # Router resource. # Preview of given router.
				782	"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
				783	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				784	"interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
				785	{
				786	"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
				787	"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
				788	"name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
				789	},
				790	],
				791	"bgp": { # BGP information specific to this router.
				792	"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
				793	},
				794	"network": "A String", # URI of the network to which this router belongs.
				795	"bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
				796	{
				797	"interfaceName": "A String", # Name of the interface the BGP peer is associated with.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	798	"peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	799	"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
				800	"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	801	"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	802	"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
				803	},
				804	],
				805	"region": "A String", # [Output Only] URI of the region where the router resides.
				806	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				807	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				808	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				809	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				810	},
				811	}</pre>
				812	</div>
				813
				814	<div class="method">
				815	<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
				816	<pre>Returns permissions that a caller has on the specified resource.
				817
				818	Args:
				819	project: string, Project ID for this request. (required)
				820	region: string, The name of the region for this request. (required)
				821	resource: string, Name of the resource for this request. (required)
				822	body: object, The request body. (required)
				823	The object takes the form of:
				824
				825	{
				826	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				827	"A String",
				828	],
				829	}
				830
				831
				832	Returns:
				833	An object of the form:
				834
				835	{
				836	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				837	"A String",
				838	],
				839	}</pre>
				840	</div>
				841
				842	<div class="method">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	843	<code class="details" id="update">update(project, region, router, body, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	844	<pre>Updates the specified Router resource with the data included in the request.
				845
				846	Args:
				847	project: string, Project ID for this request. (required)
				848	region: string, Name of the region for this request. (required)
				849	router: string, Name of the Router resource to update. (required)
				850	body: object, The request body. (required)
				851	The object takes the form of:
				852
				853	{ # Router resource.
				854	"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
				855	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				856	"interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
				857	{
				858	"linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
				859	"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
				860	"name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
				861	},
				862	],
				863	"bgp": { # BGP information specific to this router.
				864	"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
				865	},
				866	"network": "A String", # URI of the network to which this router belongs.
				867	"bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
				868	{
				869	"interfaceName": "A String", # Name of the interface the BGP peer is associated with.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	870	"peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	871	"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
				872	"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	873	"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	874	"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
				875	},
				876	],
				877	"region": "A String", # [Output Only] URI of the region where the router resides.
				878	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				879	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				880	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				881	"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				882	}
				883
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	884	requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	885
				886	Returns:
				887	An object of the form:
				888
				889	{ # An Operation resource, used to manage asynchronous API requests.
				890	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				891	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	892	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	893	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				894	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				895	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				896	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				897	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				898	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				899	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
				900	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				901	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				902	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				903	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				904	{
				905	"message": "A String", # [Output Only] A human-readable description of the warning code.
				906	"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.
				907	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				908	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				909	{
				910	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				911	"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).
				912	},
				913	],
				914	},
				915	],
				916	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				917	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				918	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				919	"name": "A String", # [Output Only] Name of the resource.
				920	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
				921	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				922	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				923	{
				924	"message": "A String", # [Output Only] An optional, human-readable error message.
				925	"code": "A String", # [Output Only] The error type identifier for this error.
				926	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				927	},
				928	],
				929	},
				930	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				931	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	932	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	933	}</pre>
				934	</div>
				935
				936	</body></html>