mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
feat(json): updated API descriptions
This commit is contained in:
Sebastian Thiel
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"kind": "discovery#restDescription",
|
||||
"etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/3wCGcnGwi3iQywGP6Ncdo6mexyQ\"",
|
||||
"etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/cV3LW8Gmmk27SrA3CO5zY7f6Svg\"",
|
||||
"discoveryVersion": "v1",
|
||||
"id": "deploymentmanager:v2",
|
||||
"name": "deploymentmanager",
|
||||
"canonicalName": "Deployment Manager",
|
||||
"version": "v2",
|
||||
"revision": "20150831",
|
||||
"revision": "20160125",
|
||||
"title": "Google Cloud Deployment Manager API",
|
||||
"description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.",
|
||||
"ownerDomain": "google.com",
|
||||
@@ -160,7 +160,7 @@
|
||||
"properties": {
|
||||
"fingerprint": {
|
||||
"type": "string",
|
||||
"description": "Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests).\n\nThe fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request to a deployment.",
|
||||
"description": "Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests).\n\nThe fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment.",
|
||||
"format": "byte"
|
||||
}
|
||||
}
|
||||
@@ -190,7 +190,7 @@
|
||||
"properties": {
|
||||
"fingerprint": {
|
||||
"type": "string",
|
||||
"description": "Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision).\n\nThe fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request to a deployment.",
|
||||
"description": "Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision).\n\nThe fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment.",
|
||||
"format": "byte"
|
||||
}
|
||||
}
|
||||
@@ -278,15 +278,19 @@
|
||||
"properties": {
|
||||
"clientOperationId": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project."
|
||||
"description": "[Output Only] Reserved for future use."
|
||||
},
|
||||
"creationTimestamp": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] Creation timestamp in RFC3339 text format."
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] A textual description of the operation, which is set when the operation is created."
|
||||
},
|
||||
"endTime": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] The time that this operation was completed. This is in RFC3339 text format."
|
||||
"description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format."
|
||||
},
|
||||
"error": {
|
||||
"type": "object",
|
||||
@@ -321,21 +325,21 @@
|
||||
},
|
||||
"httpErrorStatusCode": {
|
||||
"type": "integer",
|
||||
"description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.",
|
||||
"description": "[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.",
|
||||
"format": "int32"
|
||||
},
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
|
||||
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
|
||||
"format": "uint64"
|
||||
},
|
||||
"insertTime": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] The time that this operation was requested. This is in RFC3339 text format."
|
||||
"description": "[Output Only] The time that this operation was requested. This value is in RFC3339 text format."
|
||||
},
|
||||
"kind": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] Type of the resource. Always compute#Operation for Operation resources.",
|
||||
"description": "[Output Only] Type of the resource. Always compute#operation for Operation resources.",
|
||||
"default": "deploymentmanager#operation"
|
||||
},
|
||||
"name": {
|
||||
@@ -344,16 +348,16 @@
|
||||
},
|
||||
"operationType": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] Type of the operation, such as insert, update, and delete."
|
||||
"description": "[Output Only] The type of operation, such as insert, update, or delete, and so on."
|
||||
},
|
||||
"progress": {
|
||||
"type": "integer",
|
||||
"description": "[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 at when the operation will be complete. This number should monotonically increase as the operation progresses.",
|
||||
"description": "[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.",
|
||||
"format": "int32"
|
||||
},
|
||||
"region": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] URL of the region where the operation resides. Only applicable for regional resources."
|
||||
"description": "[Output Only] The URL of the region where the operation resides. Only available when performing regional operations."
|
||||
},
|
||||
"selfLink": {
|
||||
"type": "string",
|
||||
@@ -361,11 +365,11 @@
|
||||
},
|
||||
"startTime": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] The time that this operation was started by the server. This is in RFC3339 text format."
|
||||
"description": "[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format."
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE."
|
||||
"description": "[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE."
|
||||
},
|
||||
"statusMessage": {
|
||||
"type": "string",
|
||||
@@ -373,12 +377,12 @@
|
||||
},
|
||||
"targetId": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] Unique target ID which identifies a particular incarnation of the target.",
|
||||
"description": "[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.",
|
||||
"format": "uint64"
|
||||
},
|
||||
"targetLink": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] URL of the resource the operation is mutating."
|
||||
"description": "[Output Only] The URL of the resource that the operation modifies."
|
||||
},
|
||||
"user": {
|
||||
"type": "string",
|
||||
@@ -392,17 +396,17 @@
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] The warning type identifier for this warning."
|
||||
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
|
||||
},
|
||||
"data": {
|
||||
"type": "array",
|
||||
"description": "[Output Only] Metadata for this warning in key: value format.",
|
||||
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] A key for the warning data."
|
||||
"description": "[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)."
|
||||
},
|
||||
"value": {
|
||||
"type": "string",
|
||||
@@ -413,14 +417,14 @@
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] Optional human-readable details for this warning."
|
||||
"description": "[Output Only] A human-readable description of the warning code."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"zone": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] URL of the zone where the operation resides."
|
||||
"description": "[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations."
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -496,17 +500,17 @@
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] The warning type identifier for this warning."
|
||||
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
|
||||
},
|
||||
"data": {
|
||||
"type": "array",
|
||||
"description": "[Output Only] Metadata for this warning in key: value format.",
|
||||
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] A key for the warning data."
|
||||
"description": "[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)."
|
||||
},
|
||||
"value": {
|
||||
"type": "string",
|
||||
@@ -517,7 +521,7 @@
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] Optional human-readable details for this warning."
|
||||
"description": "[Output Only] A human-readable description of the warning code."
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -584,17 +588,17 @@
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] The warning type identifier for this warning."
|
||||
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response."
|
||||
},
|
||||
"data": {
|
||||
"type": "array",
|
||||
"description": "[Output Only] Metadata for this warning in key: value format.",
|
||||
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] A key for the warning data."
|
||||
"description": "[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)."
|
||||
},
|
||||
"value": {
|
||||
"type": "string",
|
||||
@@ -605,7 +609,7 @@
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "[Output Only] Optional human-readable details for this warning."
|
||||
"description": "[Output Only] A human-readable description of the warning code."
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -839,12 +843,12 @@
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"type": "string",
|
||||
"description": "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.\n\nThe 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 (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.\n\nFor example, filter=name ne example-instance.",
|
||||
"description": "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.\n\nThe 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.\n\nFor example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.",
|
||||
"location": "query"
|
||||
},
|
||||
"maxResults": {
|
||||
"type": "integer",
|
||||
"description": "Maximum count of results to be returned.",
|
||||
"description": "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.",
|
||||
"default": "500",
|
||||
"format": "uint32",
|
||||
"minimum": "0",
|
||||
@@ -853,7 +857,7 @@
|
||||
},
|
||||
"pageToken": {
|
||||
"type": "string",
|
||||
"description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
|
||||
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
|
||||
"location": "query"
|
||||
},
|
||||
"project": {
|
||||
@@ -920,7 +924,7 @@
|
||||
},
|
||||
"preview": {
|
||||
"type": "boolean",
|
||||
"description": "If set to true, updates the deployment and creates and updates the \"shell\" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.",
|
||||
"description": "If set to true, updates the deployment and creates and updates the \"shell\" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.",
|
||||
"default": "false",
|
||||
"location": "query"
|
||||
},
|
||||
@@ -1026,7 +1030,7 @@
|
||||
},
|
||||
"preview": {
|
||||
"type": "boolean",
|
||||
"description": "If set to true, updates the deployment and creates and updates the \"shell\" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.",
|
||||
"description": "If set to true, updates the deployment and creates and updates the \"shell\" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.",
|
||||
"default": "false",
|
||||
"location": "query"
|
||||
},
|
||||
@@ -1115,12 +1119,12 @@
|
||||
},
|
||||
"filter": {
|
||||
"type": "string",
|
||||
"description": "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.\n\nThe 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 (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.\n\nFor example, filter=name ne example-instance.",
|
||||
"description": "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.\n\nThe 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.\n\nFor example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.",
|
||||
"location": "query"
|
||||
},
|
||||
"maxResults": {
|
||||
"type": "integer",
|
||||
"description": "Maximum count of results to be returned.",
|
||||
"description": "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.",
|
||||
"default": "500",
|
||||
"format": "uint32",
|
||||
"minimum": "0",
|
||||
@@ -1129,7 +1133,7 @@
|
||||
},
|
||||
"pageToken": {
|
||||
"type": "string",
|
||||
"description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
|
||||
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
|
||||
"location": "query"
|
||||
},
|
||||
"project": {
|
||||
@@ -1200,12 +1204,12 @@
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"type": "string",
|
||||
"description": "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.\n\nThe 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 (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.\n\nFor example, filter=name ne example-instance.",
|
||||
"description": "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.\n\nThe 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.\n\nFor example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.",
|
||||
"location": "query"
|
||||
},
|
||||
"maxResults": {
|
||||
"type": "integer",
|
||||
"description": "Maximum count of results to be returned.",
|
||||
"description": "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.",
|
||||
"default": "500",
|
||||
"format": "uint32",
|
||||
"minimum": "0",
|
||||
@@ -1214,7 +1218,7 @@
|
||||
},
|
||||
"pageToken": {
|
||||
"type": "string",
|
||||
"description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
|
||||
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
|
||||
"location": "query"
|
||||
},
|
||||
"project": {
|
||||
@@ -1299,12 +1303,12 @@
|
||||
},
|
||||
"filter": {
|
||||
"type": "string",
|
||||
"description": "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.\n\nThe 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 (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.\n\nFor example, filter=name ne example-instance.",
|
||||
"description": "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.\n\nThe 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.\n\nFor example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.",
|
||||
"location": "query"
|
||||
},
|
||||
"maxResults": {
|
||||
"type": "integer",
|
||||
"description": "Maximum count of results to be returned.",
|
||||
"description": "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.",
|
||||
"default": "500",
|
||||
"format": "uint32",
|
||||
"minimum": "0",
|
||||
@@ -1313,7 +1317,7 @@
|
||||
},
|
||||
"pageToken": {
|
||||
"type": "string",
|
||||
"description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
|
||||
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
|
||||
"location": "query"
|
||||
},
|
||||
"project": {
|
||||
@@ -1350,12 +1354,12 @@
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"type": "string",
|
||||
"description": "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.\n\nThe 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 (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.\n\nFor example, filter=name ne example-instance.",
|
||||
"description": "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.\n\nThe 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.\n\nFor example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing 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.",
|
||||
"location": "query"
|
||||
},
|
||||
"maxResults": {
|
||||
"type": "integer",
|
||||
"description": "Maximum count of results to be returned.",
|
||||
"description": "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.",
|
||||
"default": "500",
|
||||
"format": "uint32",
|
||||
"minimum": "0",
|
||||
@@ -1364,7 +1368,7 @@
|
||||
},
|
||||
"pageToken": {
|
||||
"type": "string",
|
||||
"description": "Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.",
|
||||
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
|
||||
"location": "query"
|
||||
},
|
||||
"project": {
|
||||
|
||||
Reference in New Issue
Block a user