chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/memcache_v1beta2.projects.locations.instances.html b/docs/dyn/memcache_v1beta2.projects.locations.instances.html
index bf5cb66..754e0ed 100644
--- a/docs/dyn/memcache_v1beta2.projects.locations.instances.html
+++ b/docs/dyn/memcache_v1beta2.projects.locations.instances.html
@@ -90,7 +90,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Instance.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, orderBy=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Instances in a given location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -127,23 +127,23 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
@@ -162,54 +162,54 @@
The object takes the form of:
{
- "memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version.
- "zones": [ # Zones where Memcached nodes should be provisioned in. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
- "A String",
- ],
- "discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API
- "memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
- "instanceMessages": [ # List of messages that describe current statuses of memcached instance.
- {
- "code": "A String", # A code that correspond to one type of user-facing message.
- "message": "A String", # Message on memcached instance which will be exposed to users.
- },
- ],
- "authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
- "nodeCount": 42, # Required. Number of nodes in the Memcached instance.
- "displayName": "A String", # User provided name for the instance only used for display purposes. Cannot be more than 80 characters.
- "memcacheNodes": [ # Output only. List of Memcached nodes. Refer to [Node] message for more details.
- {
- "zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
- "port": 42, # Output only. The port number of the Memcached server on this node.
- "state": "A String", # Output only. Current state of the Memcached node.
- "nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
- "host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
- "parameters": { # User defined parameters currently applied to the node.
- "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
- "params": { # User defined set of parameters to use in the memcached process.
- "a_key": "A String",
- },
+ "memcacheNodes": [ # Output only. List of Memcached nodes. Refer to [Node] message for more details.
+ {
+ "state": "A String", # Output only. Current state of the Memcached node.
+ "nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
+ "host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
+ "zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
+ "parameters": { # User defined parameters currently applied to the node.
+ "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
+ "params": { # User defined set of parameters to use in the memcached process.
+ "a_key": "A String",
},
},
- ],
- "nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
- "cpuCount": 42, # Required. Number of cpus per Memcached node.
- "memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
+ "port": 42, # Output only. The port number of the Memcached server on this node.
},
- "createTime": "A String", # Output only. The time the instance was created.
- "parameters": { # Optional: User defined parameters to apply to the memcached process on each node.
- "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
- "params": { # User defined set of parameters to use in the memcached process.
- "a_key": "A String",
- },
- },
- "updateTime": "A String", # Output only. The time the instance was updated.
- "state": "A String", # Output only. The state of this Memcached instance.
- "labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
+ ],
+ "parameters": { # Optional: User defined parameters to apply to the memcached process on each node.
+ "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
+ "params": { # User defined set of parameters to use in the memcached process.
"a_key": "A String",
},
- "name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details.
- }
+ },
+ "authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
+ "memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version.
+ "state": "A String", # Output only. The state of this Memcached instance.
+ "nodeCount": 42, # Required. Number of nodes in the Memcached instance.
+ "instanceMessages": [ # List of messages that describe current statuses of memcached instance.
+ {
+ "code": "A String", # A code that correspond to one type of user-facing message.
+ "message": "A String", # Message on memcached instance which will be exposed to users.
+ },
+ ],
+ "createTime": "A String", # Output only. The time the instance was created.
+ "discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API
+ "labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
+ "a_key": "A String",
+ },
+ "updateTime": "A String", # Output only. The time the instance was updated.
+ "displayName": "A String", # User provided name for the instance only used for display purposes. Cannot be more than 80 characters.
+ "name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details.
+ "nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
+ "memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
+ "cpuCount": 42, # Required. Number of cpus per Memcached node.
+ },
+ "zones": [ # Zones where Memcached nodes should be provisioned in. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
+ "A String",
+ ],
+ "memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
+}
instanceId: string, Required. The logical name of the Memcached instance in the user project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the user project / location If any of the above are not met, will raise an invalid argument error.
x__xgafv: string, V1 error format.
@@ -221,23 +221,23 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
@@ -256,23 +256,23 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
@@ -291,66 +291,66 @@
An object of the form:
{
- "memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version.
- "zones": [ # Zones where Memcached nodes should be provisioned in. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
- "A String",
- ],
- "discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API
- "memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
- "instanceMessages": [ # List of messages that describe current statuses of memcached instance.
- {
- "code": "A String", # A code that correspond to one type of user-facing message.
- "message": "A String", # Message on memcached instance which will be exposed to users.
- },
- ],
- "authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
- "nodeCount": 42, # Required. Number of nodes in the Memcached instance.
- "displayName": "A String", # User provided name for the instance only used for display purposes. Cannot be more than 80 characters.
- "memcacheNodes": [ # Output only. List of Memcached nodes. Refer to [Node] message for more details.
- {
- "zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
- "port": 42, # Output only. The port number of the Memcached server on this node.
- "state": "A String", # Output only. Current state of the Memcached node.
- "nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
- "host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
- "parameters": { # User defined parameters currently applied to the node.
- "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
- "params": { # User defined set of parameters to use in the memcached process.
- "a_key": "A String",
- },
+ "memcacheNodes": [ # Output only. List of Memcached nodes. Refer to [Node] message for more details.
+ {
+ "state": "A String", # Output only. Current state of the Memcached node.
+ "nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
+ "host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
+ "zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
+ "parameters": { # User defined parameters currently applied to the node.
+ "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
+ "params": { # User defined set of parameters to use in the memcached process.
+ "a_key": "A String",
},
},
- ],
- "nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
- "cpuCount": 42, # Required. Number of cpus per Memcached node.
- "memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
+ "port": 42, # Output only. The port number of the Memcached server on this node.
},
- "createTime": "A String", # Output only. The time the instance was created.
- "parameters": { # Optional: User defined parameters to apply to the memcached process on each node.
- "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
- "params": { # User defined set of parameters to use in the memcached process.
- "a_key": "A String",
- },
- },
- "updateTime": "A String", # Output only. The time the instance was updated.
- "state": "A String", # Output only. The state of this Memcached instance.
- "labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
+ ],
+ "parameters": { # Optional: User defined parameters to apply to the memcached process on each node.
+ "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
+ "params": { # User defined set of parameters to use in the memcached process.
"a_key": "A String",
},
- "name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details.
- }</pre>
+ },
+ "authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
+ "memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version.
+ "state": "A String", # Output only. The state of this Memcached instance.
+ "nodeCount": 42, # Required. Number of nodes in the Memcached instance.
+ "instanceMessages": [ # List of messages that describe current statuses of memcached instance.
+ {
+ "code": "A String", # A code that correspond to one type of user-facing message.
+ "message": "A String", # Message on memcached instance which will be exposed to users.
+ },
+ ],
+ "createTime": "A String", # Output only. The time the instance was created.
+ "discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API
+ "labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
+ "a_key": "A String",
+ },
+ "updateTime": "A String", # Output only. The time the instance was updated.
+ "displayName": "A String", # User provided name for the instance only used for display purposes. Cannot be more than 80 characters.
+ "name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details.
+ "nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
+ "memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
+ "cpuCount": 42, # Required. Number of cpus per Memcached node.
+ },
+ "zones": [ # Zones where Memcached nodes should be provisioned in. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
+ "A String",
+ ],
+ "memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, orderBy=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</code>
<pre>Lists Instances in a given location.
Args:
parent: string, Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region (required)
orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
- filter: string, List filter. For example, exclude all Memcached instances with name as my-instance by specifying "name != my-instance".
pageSize: integer, The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
pageToken: string, The next_page_token value returned from a previous List request, if any.
+ filter: string, List filter. For example, exclude all Memcached instances with name as my-instance by specifying "name != my-instance".
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -360,61 +360,61 @@
An object of the form:
{ # Response for ListInstances.
- "resources": [ # A list of Memcached instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated.
- {
- "memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version.
- "zones": [ # Zones where Memcached nodes should be provisioned in. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
- "A String",
- ],
- "discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API
- "memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
- "instanceMessages": [ # List of messages that describe current statuses of memcached instance.
- {
- "code": "A String", # A code that correspond to one type of user-facing message.
- "message": "A String", # Message on memcached instance which will be exposed to users.
- },
- ],
- "authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
- "nodeCount": 42, # Required. Number of nodes in the Memcached instance.
- "displayName": "A String", # User provided name for the instance only used for display purposes. Cannot be more than 80 characters.
- "memcacheNodes": [ # Output only. List of Memcached nodes. Refer to [Node] message for more details.
- {
- "zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
- "port": 42, # Output only. The port number of the Memcached server on this node.
- "state": "A String", # Output only. Current state of the Memcached node.
- "nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
- "host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
- "parameters": { # User defined parameters currently applied to the node.
- "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
- "params": { # User defined set of parameters to use in the memcached process.
- "a_key": "A String",
- },
- },
- },
- ],
- "nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
- "cpuCount": 42, # Required. Number of cpus per Memcached node.
- "memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
- },
- "createTime": "A String", # Output only. The time the instance was created.
- "parameters": { # Optional: User defined parameters to apply to the memcached process on each node.
- "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
- "params": { # User defined set of parameters to use in the memcached process.
- "a_key": "A String",
- },
- },
- "updateTime": "A String", # Output only. The time the instance was updated.
- "state": "A String", # Output only. The state of this Memcached instance.
- "labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
- "a_key": "A String",
- },
- "name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details.
- },
- ],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
"unreachable": [ # Locations that could not be reached.
"A String",
],
+ "resources": [ # A list of Memcached instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated.
+ {
+ "memcacheNodes": [ # Output only. List of Memcached nodes. Refer to [Node] message for more details.
+ {
+ "state": "A String", # Output only. Current state of the Memcached node.
+ "nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
+ "host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
+ "zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
+ "parameters": { # User defined parameters currently applied to the node.
+ "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
+ "params": { # User defined set of parameters to use in the memcached process.
+ "a_key": "A String",
+ },
+ },
+ "port": 42, # Output only. The port number of the Memcached server on this node.
+ },
+ ],
+ "parameters": { # Optional: User defined parameters to apply to the memcached process on each node.
+ "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
+ "params": { # User defined set of parameters to use in the memcached process.
+ "a_key": "A String",
+ },
+ },
+ "authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
+ "memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version.
+ "state": "A String", # Output only. The state of this Memcached instance.
+ "nodeCount": 42, # Required. Number of nodes in the Memcached instance.
+ "instanceMessages": [ # List of messages that describe current statuses of memcached instance.
+ {
+ "code": "A String", # A code that correspond to one type of user-facing message.
+ "message": "A String", # Message on memcached instance which will be exposed to users.
+ },
+ ],
+ "createTime": "A String", # Output only. The time the instance was created.
+ "discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API
+ "labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
+ "a_key": "A String",
+ },
+ "updateTime": "A String", # Output only. The time the instance was updated.
+ "displayName": "A String", # User provided name for the instance only used for display purposes. Cannot be more than 80 characters.
+ "name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details.
+ "nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
+ "memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
+ "cpuCount": 42, # Required. Number of cpus per Memcached node.
+ },
+ "zones": [ # Zones where Memcached nodes should be provisioned in. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
+ "A String",
+ ],
+ "memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
+ },
+ ],
}</pre>
</div>
@@ -442,54 +442,54 @@
The object takes the form of:
{
- "memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version.
- "zones": [ # Zones where Memcached nodes should be provisioned in. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
- "A String",
- ],
- "discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API
- "memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
- "instanceMessages": [ # List of messages that describe current statuses of memcached instance.
- {
- "code": "A String", # A code that correspond to one type of user-facing message.
- "message": "A String", # Message on memcached instance which will be exposed to users.
- },
- ],
- "authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
- "nodeCount": 42, # Required. Number of nodes in the Memcached instance.
- "displayName": "A String", # User provided name for the instance only used for display purposes. Cannot be more than 80 characters.
- "memcacheNodes": [ # Output only. List of Memcached nodes. Refer to [Node] message for more details.
- {
- "zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
- "port": 42, # Output only. The port number of the Memcached server on this node.
- "state": "A String", # Output only. Current state of the Memcached node.
- "nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
- "host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
- "parameters": { # User defined parameters currently applied to the node.
- "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
- "params": { # User defined set of parameters to use in the memcached process.
- "a_key": "A String",
- },
+ "memcacheNodes": [ # Output only. List of Memcached nodes. Refer to [Node] message for more details.
+ {
+ "state": "A String", # Output only. Current state of the Memcached node.
+ "nodeId": "A String", # Output only. Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
+ "host": "A String", # Output only. Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
+ "zone": "A String", # Output only. Location (GCP Zone) for the Memcached node.
+ "parameters": { # User defined parameters currently applied to the node.
+ "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
+ "params": { # User defined set of parameters to use in the memcached process.
+ "a_key": "A String",
},
},
- ],
- "nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
- "cpuCount": 42, # Required. Number of cpus per Memcached node.
- "memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
+ "port": 42, # Output only. The port number of the Memcached server on this node.
},
- "createTime": "A String", # Output only. The time the instance was created.
- "parameters": { # Optional: User defined parameters to apply to the memcached process on each node.
- "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
- "params": { # User defined set of parameters to use in the memcached process.
- "a_key": "A String",
- },
- },
- "updateTime": "A String", # Output only. The time the instance was updated.
- "state": "A String", # Output only. The state of this Memcached instance.
- "labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
+ ],
+ "parameters": { # Optional: User defined parameters to apply to the memcached process on each node.
+ "id": "A String", # Output only. The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes and any action needs to be taken to apply parameters on nodes.
+ "params": { # User defined set of parameters to use in the memcached process.
"a_key": "A String",
},
- "name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details.
- }
+ },
+ "authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
+ "memcacheVersion": "A String", # The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version.
+ "state": "A String", # Output only. The state of this Memcached instance.
+ "nodeCount": 42, # Required. Number of nodes in the Memcached instance.
+ "instanceMessages": [ # List of messages that describe current statuses of memcached instance.
+ {
+ "code": "A String", # A code that correspond to one type of user-facing message.
+ "message": "A String", # Message on memcached instance which will be exposed to users.
+ },
+ ],
+ "createTime": "A String", # Output only. The time the instance was created.
+ "discoveryEndpoint": "A String", # Output only. Endpoint for Discovery API
+ "labels": { # Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
+ "a_key": "A String",
+ },
+ "updateTime": "A String", # Output only. The time the instance was updated.
+ "displayName": "A String", # User provided name for the instance only used for display purposes. Cannot be more than 80 characters.
+ "name": "A String", # Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details.
+ "nodeConfig": { # Configuration for a Memcached Node. # Required. Configuration for Memcached nodes.
+ "memorySizeMb": 42, # Required. Memory size in MiB for each Memcached node.
+ "cpuCount": 42, # Required. Number of cpus per Memcached node.
+ },
+ "zones": [ # Zones where Memcached nodes should be provisioned in. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance.
+ "A String",
+ ],
+ "memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
+}
updateMask: string, Required. Mask of fields to update. * `displayName`
x__xgafv: string, V1 error format.
@@ -501,23 +501,23 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
@@ -549,23 +549,23 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>