Blame - docs/dyn/compute_v1.urlMaps.html - platform/external/python/google-api-python-client

blob: 1af13d4c276825b76cef9b4fa43b16c74e77f708 [file] [log] [blame]

Craig Citro	065b530	2014-08-14 00:47:23 -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_v1.html">Compute Engine API</a> . <a href="compute_v1.urlMaps.html">urlMaps</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#delete">delete(project, urlMap)</a></code></p>
				79	<p class="firstline">Deletes the specified UrlMap resource.</p>
				80	<p class="toc_element">
				81	<code><a href="#get">get(project, urlMap)</a></code></p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	82	<p class="firstline">Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	83	<p class="toc_element">
				84	<code><a href="#insert">insert(project, body)</a></code></p>
				85	<p class="firstline">Creates a UrlMap resource in the specified project using the data included in the request.</p>
				86	<p class="toc_element">
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	87	<code><a href="#invalidateCache">invalidateCache(project, urlMap, body)</a></code></p>
				88	<p class="firstline">Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.</p>
				89	<p class="toc_element">
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	90	<code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
				91	<p class="firstline">Retrieves the list of UrlMap resources available to the specified project.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
				96	<code><a href="#patch">patch(project, urlMap, body)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	97	<p class="firstline">Updates the entire content of the UrlMap resource. This method supports patch semantics.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	98	<p class="toc_element">
				99	<code><a href="#update">update(project, urlMap, body)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	100	<p class="firstline">Updates the entire content of the UrlMap resource.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	101	<p class="toc_element">
				102	<code><a href="#validate">validate(project, urlMap, body)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	103	<p class="firstline">Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	104	<h3>Method Details</h3>
				105	<div class="method">
				106	<code class="details" id="delete">delete(project, urlMap)</code>
				107	<pre>Deletes the specified UrlMap resource.
				108
				109	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	110	project: string, Project ID for this request. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	111	urlMap: string, Name of the UrlMap resource to delete. (required)
				112
				113	Returns:
				114	An object of the form:
				115
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	116	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	117	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				118	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	119	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	120	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				121	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				122	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				123	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	124	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	125	"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.
				126	"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.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	127	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	128	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				129	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	130	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	131	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	132	"message": "A String", # [Output Only] A human-readable description of the warning code.
				133	"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.
				134	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				135	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	136	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	137	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	138	"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).
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	139	},
				140	],
				141	},
				142	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	143	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	144	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				145	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	146	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	147	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	148	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	149	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	150	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	151	"message": "A String", # [Output Only] An optional, human-readable error message.
				152	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	153	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	154	},
				155	],
				156	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	157	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	158	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	159	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	160	}</pre>
				161	</div>
				162
				163	<div class="method">
				164	<code class="details" id="get">get(project, urlMap)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	165	<pre>Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	166
				167	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	168	project: string, Project ID for this request. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	169	urlMap: string, Name of the UrlMap resource to return. (required)
				170
				171	Returns:
				172	An object of the form:
				173
				174	{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	175	"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
				176	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	177	"defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	178	"tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	179	{ # Message for the expected URL mappings.
				180	"path": "A String", # Path portion of the URL.
				181	"host": "A String", # Host portion of the URL.
				182	"description": "A String", # Description of this test case.
				183	"service": "A String", # Expected BackendService resource the given URL should be mapped to.
				184	},
				185	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	186	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	187	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
				188	"pathMatchers": [ # The list of named PathMatchers to use against the URL.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	189	{ # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
				190	"defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
				191	# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
				192	# - compute/v1/projects/project/global/backendServices/backendService
				193	# - global/backendServices/backendService
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	194	"pathRules": [ # The list of path rules.
				195	{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
				196	"paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
				197	"A String",
				198	],
				199	"service": "A String", # The URL of the BackendService resource if this rule is matched.
				200	},
				201	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	202	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	203	"name": "A String", # The name to which this PathMatcher is referred by the HostRule.
				204	},
				205	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	206	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	207	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	208	"hostRules": [ # The list of HostRules to use against the URL.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	209	{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	210	"hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]). In that case, must be the first character and must be followed in the pattern by either - or ..
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	211	"A String",
				212	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	213	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				214	"pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	215	},
				216	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	217	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	218	}</pre>
				219	</div>
				220
				221	<div class="method">
				222	<code class="details" id="insert">insert(project, body)</code>
				223	<pre>Creates a UrlMap resource in the specified project using the data included in the request.
				224
				225	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	226	project: string, Project ID for this request. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	227	body: object, The request body. (required)
				228	The object takes the form of:
				229
				230	{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	231	"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
				232	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	233	"defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	234	"tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	235	{ # Message for the expected URL mappings.
				236	"path": "A String", # Path portion of the URL.
				237	"host": "A String", # Host portion of the URL.
				238	"description": "A String", # Description of this test case.
				239	"service": "A String", # Expected BackendService resource the given URL should be mapped to.
				240	},
				241	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	242	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	243	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
				244	"pathMatchers": [ # The list of named PathMatchers to use against the URL.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	245	{ # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
				246	"defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
				247	# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
				248	# - compute/v1/projects/project/global/backendServices/backendService
				249	# - global/backendServices/backendService
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	250	"pathRules": [ # The list of path rules.
				251	{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
				252	"paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
				253	"A String",
				254	],
				255	"service": "A String", # The URL of the BackendService resource if this rule is matched.
				256	},
				257	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	258	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	259	"name": "A String", # The name to which this PathMatcher is referred by the HostRule.
				260	},
				261	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	262	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	263	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	264	"hostRules": [ # The list of HostRules to use against the URL.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	265	{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	266	"hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]). In that case, must be the first character and must be followed in the pattern by either - or ..
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	267	"A String",
				268	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	269	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				270	"pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	271	},
				272	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	273	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	274	}
				275
				276
				277	Returns:
				278	An object of the form:
				279
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	280	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	281	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				282	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	283	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	284	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				285	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				286	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				287	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	288	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	289	"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.
				290	"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.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	291	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	292	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				293	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	294	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	295	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	296	"message": "A String", # [Output Only] A human-readable description of the warning code.
				297	"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.
				298	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				299	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	300	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	301	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	302	"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).
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	303	},
				304	],
				305	},
				306	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	307	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	308	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				309	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	310	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	311	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	312	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	313	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	314	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	315	"message": "A String", # [Output Only] An optional, human-readable error message.
				316	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	317	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	318	},
				319	],
				320	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	321	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	322	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	323	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	324	}</pre>
				325	</div>
				326
				327	<div class="method">
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	328	<code class="details" id="invalidateCache">invalidateCache(project, urlMap, body)</code>
				329	<pre>Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
				330
				331	Args:
				332	project: string, Project ID for this request. (required)
				333	urlMap: string, Name of the UrlMap scoping this request. (required)
				334	body: object, The request body. (required)
				335	The object takes the form of:
				336
				337	{
				338	"path": "A String",
				339	}
				340
				341
				342	Returns:
				343	An object of the form:
				344
				345	{ # An Operation resource, used to manage asynchronous API requests.
				346	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				347	"clientOperationId": "A String", # [Output Only] Reserved for future use.
				348	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				349	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				350	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				351	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				352	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
				353	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
				354	"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.
				355	"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.
				356	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				357	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				358	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				359	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				360	{
				361	"message": "A String", # [Output Only] A human-readable description of the warning code.
				362	"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.
				363	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				364	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				365	{
				366	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				367	"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).
				368	},
				369	],
				370	},
				371	],
				372	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
				373	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				374	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
				375	"name": "A String", # [Output Only] Name of the resource.
				376	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
				377	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				378	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				379	{
				380	"message": "A String", # [Output Only] An optional, human-readable error message.
				381	"code": "A String", # [Output Only] The error type identifier for this error.
				382	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				383	},
				384	],
				385	},
				386	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				387	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				388	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
				389	}</pre>
				390	</div>
				391
				392	<div class="method">
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	393	<code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
				394	<pre>Retrieves the list of UrlMap resources available to the specified project.
				395
				396	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	397	project: string, Project ID for this request. (required)
				398	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.
				399	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.
				400	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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	401
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	402	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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	403
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	404	For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	405
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	406	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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	407
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	408	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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	409
				410	Returns:
				411	An object of the form:
				412
				413	{ # Contains a list of UrlMap resources.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	414	"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.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	415	"items": [ # A list of UrlMap resources.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	416	{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	417	"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
				418	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	419	"defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	420	"tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	421	{ # Message for the expected URL mappings.
				422	"path": "A String", # Path portion of the URL.
				423	"host": "A String", # Host portion of the URL.
				424	"description": "A String", # Description of this test case.
				425	"service": "A String", # Expected BackendService resource the given URL should be mapped to.
				426	},
				427	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	428	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	429	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
				430	"pathMatchers": [ # The list of named PathMatchers to use against the URL.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	431	{ # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
				432	"defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
				433	# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
				434	# - compute/v1/projects/project/global/backendServices/backendService
				435	# - global/backendServices/backendService
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	436	"pathRules": [ # The list of path rules.
				437	{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
				438	"paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
				439	"A String",
				440	],
				441	"service": "A String", # The URL of the BackendService resource if this rule is matched.
				442	},
				443	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	444	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	445	"name": "A String", # The name to which this PathMatcher is referred by the HostRule.
				446	},
				447	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	448	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	449	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	450	"hostRules": [ # The list of HostRules to use against the URL.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	451	{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	452	"hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]). In that case, must be the first character and must be followed in the pattern by either - or ..
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	453	"A String",
				454	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	455	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				456	"pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	457	},
				458	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	459	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	460	},
				461	],
				462	"kind": "compute#urlMapList", # Type of resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	463	"id": "A String", # [Output Only] Unique identifier for the resource. Set by the server.
				464	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	465	}</pre>
				466	</div>
				467
				468	<div class="method">
				469	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				470	<pre>Retrieves the next page of results.
				471
				472	Args:
				473	previous_request: The request for the previous page. (required)
				474	previous_response: The response from the request for the previous page. (required)
				475
				476	Returns:
				477	A request object that you can call 'execute()' on to request the next
				478	page. Returns None if there are no more items in the collection.
				479	</pre>
				480	</div>
				481
				482	<div class="method">
				483	<code class="details" id="patch">patch(project, urlMap, body)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	484	<pre>Updates the entire content of the UrlMap resource. This method supports patch semantics.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	485
				486	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	487	project: string, Project ID for this request. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	488	urlMap: string, Name of the UrlMap resource to update. (required)
				489	body: object, The request body. (required)
				490	The object takes the form of:
				491
				492	{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	493	"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
				494	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	495	"defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	496	"tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	497	{ # Message for the expected URL mappings.
				498	"path": "A String", # Path portion of the URL.
				499	"host": "A String", # Host portion of the URL.
				500	"description": "A String", # Description of this test case.
				501	"service": "A String", # Expected BackendService resource the given URL should be mapped to.
				502	},
				503	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	504	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	505	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
				506	"pathMatchers": [ # The list of named PathMatchers to use against the URL.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	507	{ # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
				508	"defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
				509	# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
				510	# - compute/v1/projects/project/global/backendServices/backendService
				511	# - global/backendServices/backendService
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	512	"pathRules": [ # The list of path rules.
				513	{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
				514	"paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
				515	"A String",
				516	],
				517	"service": "A String", # The URL of the BackendService resource if this rule is matched.
				518	},
				519	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	520	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	521	"name": "A String", # The name to which this PathMatcher is referred by the HostRule.
				522	},
				523	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	524	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	525	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	526	"hostRules": [ # The list of HostRules to use against the URL.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	527	{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	528	"hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]). In that case, must be the first character and must be followed in the pattern by either - or ..
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	529	"A String",
				530	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	531	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				532	"pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	533	},
				534	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	535	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	536	}
				537
				538
				539	Returns:
				540	An object of the form:
				541
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	542	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	543	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				544	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	545	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	546	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				547	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				548	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				549	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	550	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	551	"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.
				552	"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.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	553	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	554	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				555	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	556	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	557	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	558	"message": "A String", # [Output Only] A human-readable description of the warning code.
				559	"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.
				560	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				561	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	562	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	563	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	564	"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).
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	565	},
				566	],
				567	},
				568	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	569	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	570	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				571	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	572	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	573	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	574	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	575	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	576	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	577	"message": "A String", # [Output Only] An optional, human-readable error message.
				578	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	579	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	580	},
				581	],
				582	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	583	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	584	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	585	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	586	}</pre>
				587	</div>
				588
				589	<div class="method">
				590	<code class="details" id="update">update(project, urlMap, body)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	591	<pre>Updates the entire content of the UrlMap resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	592
				593	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	594	project: string, Project ID for this request. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	595	urlMap: string, Name of the UrlMap resource to update. (required)
				596	body: object, The request body. (required)
				597	The object takes the form of:
				598
				599	{ # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	600	"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
				601	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	602	"defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	603	"tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	604	{ # Message for the expected URL mappings.
				605	"path": "A String", # Path portion of the URL.
				606	"host": "A String", # Host portion of the URL.
				607	"description": "A String", # Description of this test case.
				608	"service": "A String", # Expected BackendService resource the given URL should be mapped to.
				609	},
				610	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	611	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	612	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
				613	"pathMatchers": [ # The list of named PathMatchers to use against the URL.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	614	{ # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
				615	"defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
				616	# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
				617	# - compute/v1/projects/project/global/backendServices/backendService
				618	# - global/backendServices/backendService
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	619	"pathRules": [ # The list of path rules.
				620	{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
				621	"paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
				622	"A String",
				623	],
				624	"service": "A String", # The URL of the BackendService resource if this rule is matched.
				625	},
				626	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	627	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	628	"name": "A String", # The name to which this PathMatcher is referred by the HostRule.
				629	},
				630	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	631	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	632	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	633	"hostRules": [ # The list of HostRules to use against the URL.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	634	{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	635	"hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]). In that case, must be the first character and must be followed in the pattern by either - or ..
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	636	"A String",
				637	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	638	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				639	"pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	640	},
				641	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	642	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	643	}
				644
				645
				646	Returns:
				647	An object of the form:
				648
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	649	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	650	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				651	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	652	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	653	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				654	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				655	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				656	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	657	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	658	"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.
				659	"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.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	660	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	661	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				662	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	663	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	664	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	665	"message": "A String", # [Output Only] A human-readable description of the warning code.
				666	"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.
				667	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				668	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	669	{
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	670	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	671	"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).
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	672	},
				673	],
				674	},
				675	],
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	676	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	677	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				678	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	679	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	680	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	681	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	682	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	683	{
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	684	"message": "A String", # [Output Only] An optional, human-readable error message.
				685	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	686	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	687	},
				688	],
				689	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	690	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	691	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	692	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	693	}</pre>
				694	</div>
				695
				696	<div class="method">
				697	<code class="details" id="validate">validate(project, urlMap, body)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	698	<pre>Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	699
				700	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	701	project: string, Project ID for this request. (required)
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	702	urlMap: string, Name of the UrlMap resource to be validated as. (required)
				703	body: object, The request body. (required)
				704	The object takes the form of:
				705
				706	{
				707	"resource": { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. # Content of the UrlMap to be validated.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	708	"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
				709	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	710	"defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame]	711	"tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	712	{ # Message for the expected URL mappings.
				713	"path": "A String", # Path portion of the URL.
				714	"host": "A String", # Host portion of the URL.
				715	"description": "A String", # Description of this test case.
				716	"service": "A String", # Expected BackendService resource the given URL should be mapped to.
				717	},
				718	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	719	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	720	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
				721	"pathMatchers": [ # The list of named PathMatchers to use against the URL.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	722	{ # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.
				723	"defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
				724	# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
				725	# - compute/v1/projects/project/global/backendServices/backendService
				726	# - global/backendServices/backendService
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	727	"pathRules": [ # The list of path rules.
				728	{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
				729	"paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
				730	"A String",
				731	],
				732	"service": "A String", # The URL of the BackendService resource if this rule is matched.
				733	},
				734	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	735	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	736	"name": "A String", # The name to which this PathMatcher is referred by the HostRule.
				737	},
				738	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	739	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	740	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	741	"hostRules": [ # The list of HostRules to use against the URL.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	742	{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	743	"hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]). In that case, must be the first character and must be followed in the pattern by either - or ..
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	744	"A String",
				745	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	746	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				747	"pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	748	},
				749	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	750	"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.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	751	},
				752	}
				753
				754
				755	Returns:
				756	An object of the form:
				757
				758	{
				759	"result": { # Message representing the validation result for a UrlMap.
				760	"testFailures": [
				761	{
				762	"path": "A String",
				763	"actualService": "A String",
				764	"host": "A String",
				765	"expectedService": "A String",
				766	},
				767	],
				768	"loadErrors": [
				769	"A String",
				770	],
				771	"testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.
				772	"loadSucceeded": True or False, # Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.
				773	},
				774	}</pre>
				775	</div>
				776
				777	</body></html>