docs: update generated docs (#981)
diff --git a/docs/dyn/redis_v1.projects.locations.instances.html b/docs/dyn/redis_v1.projects.locations.instances.html
index 9483b8a..8d2f2f6 100644
--- a/docs/dyn/redis_v1.projects.locations.instances.html
+++ b/docs/dyn/redis_v1.projects.locations.instances.html
@@ -93,7 +93,7 @@
<code><a href="#import_">import_(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all Redis instances owned by a project in either the specified</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -110,7 +110,7 @@
<pre>Creates a Redis instance based on the specified tier and memory size.
By default, the instance is accessible from the project's
-[default network](/compute/docs/networks-and-firewalls#networks).
+[default network](https://cloud.google.com/vpc/docs/vpc).
The creation is executed asynchronously and callers may check the returned
operation to track its progress. Once the operation is completed the Redis
@@ -130,27 +130,12 @@
{ # A Google Cloud Redis instance.
"statusMessage": "A String", # Output only. Additional information about the current status of this
# instance, if available.
- "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
- # [network](/compute/docs/networks-and-firewalls#networks) to which the
- # instance is connected. If left unspecified, the `default` network
- # will be used.
- "state": "A String", # Output only. The current state of this instance.
- "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: Redis instances are managed and addressed at regional level so
- # location_id here refers to a GCP region; however, users may choose which
- # specific zone (or collection of zones for cross-zone instances) an instance
- # should be provisioned in. Refer to location_id and
- # alternative_location_id fields for more details.
- "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
- # If not provided, the connect mode defaults to DIRECT_PEERING.
- "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
- # transfer data to/from Cloud Storage. Format is
- # "serviceAccount:<service_account_email>". The value may change over time
- # for a given instance so should be checked before each import/export
- # operation.
+ "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
+ # clients to connect to the service.
+ "createTime": "A String", # Output only. The time the instance was created.
+ "labels": { # Resource labels to represent user provided metadata
+ "a_key": "A String",
+ },
"redisConfigs": { # Optional. Redis configuration parameters, according to
# http://redis.io/topics/config. Currently, the only supported parameters
# are:
@@ -174,8 +159,35 @@
"a_key": "A String",
},
"port": 42, # Output only. The port number of the exposed Redis endpoint.
- "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
- # clients to connect to the service.
+ "authorizedNetwork": "A String", # Optional. 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.
+ "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
+ # Tier instances, this will always be the same as the location_id
+ # provided by the user at creation time. For Standard Tier instances,
+ # this can be either location_id or alternative_location_id and can
+ # change after a failover event.
+ "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
+ # If not provided, the connect mode defaults to DIRECT_PEERING.
+ "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
+ # instance. If not provided, the service will choose an unused /29 block,
+ # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
+ # and non-overlapping with existing subnets in an authorized network.
+ "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
+ # transfer data to/from Cloud Storage. Format is
+ # "serviceAccount:<service_account_email>". The value may change over time
+ # for a given instance so should be checked before each import/export
+ # operation.
+ "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: Redis instances are managed and addressed at regional level so
+ # location_id here refers to a GCP region; however, users may choose which
+ # specific zone (or collection of zones for cross-zone instances) an instance
+ # should be provisioned in. Refer to location_id and
+ # alternative_location_id fields for more details.
"redisVersion": "A String", # Optional. The version of Redis software.
# If not provided, latest supported version will be used. Currently, the
# supported values are:
@@ -184,6 +196,9 @@
# * `REDIS_4_0` for Redis 4.0 compatibility (default)
# * `REDIS_5_0` for Redis 5.0 compatibility
"memorySizeGb": 42, # Required. Redis memory size in GiB.
+ "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
+ # against zonal failures by provisioning it across two zones. If provided, it
+ # must be a different zone from the one provided in location_id.
"tier": "A String", # Required. The service tier of the instance.
"displayName": "A String", # An arbitrary and optional user-provided name for the instance.
"locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
@@ -191,22 +206,7 @@
# instances will be created across two zones for protection against zonal
# failures. If alternative_location_id is also provided, it must be
# different from location_id.
- "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
- # instance. If not provided, the service will choose an unused /29 block,
- # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
- # and non-overlapping with existing subnets in an authorized network.
- "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
- # Tier instances, this will always be the same as the location_id
- # provided by the user at creation time. For Standard Tier instances,
- # this can be either location_id or alternative_location_id and can
- # change after a failover event.
- "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
- # against zonal failures by provisioning it across two zones. If provided, it
- # must be a different zone from the one provided in location_id.
- "createTime": "A String", # Output only. The time the instance was created.
- "labels": { # Resource labels to represent user provided metadata
- "a_key": "A String",
- },
+ "state": "A String", # Output only. The current state of this instance.
}
instanceId: string, Required. The logical name of the Redis instance in the customer project
@@ -227,6 +227,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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}`.
"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
@@ -237,27 +240,6 @@
# `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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "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.
- },
- ],
- },
"metadata": { # {
#
# `createTime`: The time the operation was created.
@@ -277,6 +259,24 @@
# }
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "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.
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ },
"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.
@@ -302,6 +302,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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}`.
"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
@@ -312,27 +315,6 @@
# `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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "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.
- },
- ],
- },
"metadata": { # {
#
# `createTime`: The time the operation was created.
@@ -352,6 +334,24 @@
# }
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "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.
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ },
"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.
@@ -393,6 +393,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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}`.
"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
@@ -403,27 +406,6 @@
# `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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "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.
- },
- ],
- },
"metadata": { # {
#
# `createTime`: The time the operation was created.
@@ -443,6 +425,24 @@
# }
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "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.
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ },
"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.
@@ -476,6 +476,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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}`.
"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
@@ -486,27 +489,6 @@
# `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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "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.
- },
- ],
- },
"metadata": { # {
#
# `createTime`: The time the operation was created.
@@ -526,6 +508,24 @@
# }
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "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.
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ },
"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.
@@ -551,27 +551,12 @@
{ # A Google Cloud Redis instance.
"statusMessage": "A String", # Output only. Additional information about the current status of this
# instance, if available.
- "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
- # [network](/compute/docs/networks-and-firewalls#networks) to which the
- # instance is connected. If left unspecified, the `default` network
- # will be used.
- "state": "A String", # Output only. The current state of this instance.
- "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: Redis instances are managed and addressed at regional level so
- # location_id here refers to a GCP region; however, users may choose which
- # specific zone (or collection of zones for cross-zone instances) an instance
- # should be provisioned in. Refer to location_id and
- # alternative_location_id fields for more details.
- "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
- # If not provided, the connect mode defaults to DIRECT_PEERING.
- "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
- # transfer data to/from Cloud Storage. Format is
- # "serviceAccount:<service_account_email>". The value may change over time
- # for a given instance so should be checked before each import/export
- # operation.
+ "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
+ # clients to connect to the service.
+ "createTime": "A String", # Output only. The time the instance was created.
+ "labels": { # Resource labels to represent user provided metadata
+ "a_key": "A String",
+ },
"redisConfigs": { # Optional. Redis configuration parameters, according to
# http://redis.io/topics/config. Currently, the only supported parameters
# are:
@@ -595,8 +580,35 @@
"a_key": "A String",
},
"port": 42, # Output only. The port number of the exposed Redis endpoint.
- "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
- # clients to connect to the service.
+ "authorizedNetwork": "A String", # Optional. 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.
+ "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
+ # Tier instances, this will always be the same as the location_id
+ # provided by the user at creation time. For Standard Tier instances,
+ # this can be either location_id or alternative_location_id and can
+ # change after a failover event.
+ "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
+ # If not provided, the connect mode defaults to DIRECT_PEERING.
+ "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
+ # instance. If not provided, the service will choose an unused /29 block,
+ # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
+ # and non-overlapping with existing subnets in an authorized network.
+ "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
+ # transfer data to/from Cloud Storage. Format is
+ # "serviceAccount:<service_account_email>". The value may change over time
+ # for a given instance so should be checked before each import/export
+ # operation.
+ "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: Redis instances are managed and addressed at regional level so
+ # location_id here refers to a GCP region; however, users may choose which
+ # specific zone (or collection of zones for cross-zone instances) an instance
+ # should be provisioned in. Refer to location_id and
+ # alternative_location_id fields for more details.
"redisVersion": "A String", # Optional. The version of Redis software.
# If not provided, latest supported version will be used. Currently, the
# supported values are:
@@ -605,6 +617,9 @@
# * `REDIS_4_0` for Redis 4.0 compatibility (default)
# * `REDIS_5_0` for Redis 5.0 compatibility
"memorySizeGb": 42, # Required. Redis memory size in GiB.
+ "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
+ # against zonal failures by provisioning it across two zones. If provided, it
+ # must be a different zone from the one provided in location_id.
"tier": "A String", # Required. The service tier of the instance.
"displayName": "A String", # An arbitrary and optional user-provided name for the instance.
"locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
@@ -612,22 +627,7 @@
# instances will be created across two zones for protection against zonal
# failures. If alternative_location_id is also provided, it must be
# different from location_id.
- "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
- # instance. If not provided, the service will choose an unused /29 block,
- # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
- # and non-overlapping with existing subnets in an authorized network.
- "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
- # Tier instances, this will always be the same as the location_id
- # provided by the user at creation time. For Standard Tier instances,
- # this can be either location_id or alternative_location_id and can
- # change after a failover event.
- "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
- # against zonal failures by provisioning it across two zones. If provided, it
- # must be a different zone from the one provided in location_id.
- "createTime": "A String", # Output only. The time the instance was created.
- "labels": { # Resource labels to represent user provided metadata
- "a_key": "A String",
- },
+ "state": "A String", # Output only. The current state of this instance.
}</pre>
</div>
@@ -667,6 +667,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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}`.
"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
@@ -677,27 +680,6 @@
# `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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "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.
- },
- ],
- },
"metadata": { # {
#
# `createTime`: The time the operation was created.
@@ -717,6 +699,24 @@
# }
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "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.
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ },
"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.
@@ -724,7 +724,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all Redis instances owned by a project in either the specified
location (region) or all locations.
@@ -739,8 +739,6 @@
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)
- pageToken: string, The `next_page_token` value returned from a previous
-ListInstances request, if any.
pageSize: integer, The maximum number of items to return.
If not specified, a default value of 1000 will be used by the service.
@@ -748,6 +746,8 @@
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
+ListInstances request, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -757,11 +757,11 @@
An object of the form:
{ # Response for ListInstances.
- "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",
],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
+ # results in the list.
"instances": [ # A list of Redis instances in the project in the specified location,
# or across all locations.
#
@@ -775,27 +775,12 @@
{ # A Google Cloud Redis instance.
"statusMessage": "A String", # Output only. Additional information about the current status of this
# instance, if available.
- "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
- # [network](/compute/docs/networks-and-firewalls#networks) to which the
- # instance is connected. If left unspecified, the `default` network
- # will be used.
- "state": "A String", # Output only. The current state of this instance.
- "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: Redis instances are managed and addressed at regional level so
- # location_id here refers to a GCP region; however, users may choose which
- # specific zone (or collection of zones for cross-zone instances) an instance
- # should be provisioned in. Refer to location_id and
- # alternative_location_id fields for more details.
- "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
- # If not provided, the connect mode defaults to DIRECT_PEERING.
- "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
- # transfer data to/from Cloud Storage. Format is
- # "serviceAccount:<service_account_email>". The value may change over time
- # for a given instance so should be checked before each import/export
- # operation.
+ "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
+ # clients to connect to the service.
+ "createTime": "A String", # Output only. The time the instance was created.
+ "labels": { # Resource labels to represent user provided metadata
+ "a_key": "A String",
+ },
"redisConfigs": { # Optional. Redis configuration parameters, according to
# http://redis.io/topics/config. Currently, the only supported parameters
# are:
@@ -819,8 +804,35 @@
"a_key": "A String",
},
"port": 42, # Output only. The port number of the exposed Redis endpoint.
- "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
- # clients to connect to the service.
+ "authorizedNetwork": "A String", # Optional. 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.
+ "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
+ # Tier instances, this will always be the same as the location_id
+ # provided by the user at creation time. For Standard Tier instances,
+ # this can be either location_id or alternative_location_id and can
+ # change after a failover event.
+ "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
+ # If not provided, the connect mode defaults to DIRECT_PEERING.
+ "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
+ # instance. If not provided, the service will choose an unused /29 block,
+ # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
+ # and non-overlapping with existing subnets in an authorized network.
+ "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
+ # transfer data to/from Cloud Storage. Format is
+ # "serviceAccount:<service_account_email>". The value may change over time
+ # for a given instance so should be checked before each import/export
+ # operation.
+ "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: Redis instances are managed and addressed at regional level so
+ # location_id here refers to a GCP region; however, users may choose which
+ # specific zone (or collection of zones for cross-zone instances) an instance
+ # should be provisioned in. Refer to location_id and
+ # alternative_location_id fields for more details.
"redisVersion": "A String", # Optional. The version of Redis software.
# If not provided, latest supported version will be used. Currently, the
# supported values are:
@@ -829,6 +841,9 @@
# * `REDIS_4_0` for Redis 4.0 compatibility (default)
# * `REDIS_5_0` for Redis 5.0 compatibility
"memorySizeGb": 42, # Required. Redis memory size in GiB.
+ "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
+ # against zonal failures by provisioning it across two zones. If provided, it
+ # must be a different zone from the one provided in location_id.
"tier": "A String", # Required. The service tier of the instance.
"displayName": "A String", # An arbitrary and optional user-provided name for the instance.
"locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
@@ -836,22 +851,7 @@
# instances will be created across two zones for protection against zonal
# failures. If alternative_location_id is also provided, it must be
# different from location_id.
- "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
- # instance. If not provided, the service will choose an unused /29 block,
- # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
- # and non-overlapping with existing subnets in an authorized network.
- "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
- # Tier instances, this will always be the same as the location_id
- # provided by the user at creation time. For Standard Tier instances,
- # this can be either location_id or alternative_location_id and can
- # change after a failover event.
- "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
- # against zonal failures by provisioning it across two zones. If provided, it
- # must be a different zone from the one provided in location_id.
- "createTime": "A String", # Output only. The time the instance was created.
- "labels": { # Resource labels to represent user provided metadata
- "a_key": "A String",
- },
+ "state": "A String", # Output only. The current state of this instance.
},
],
}</pre>
@@ -895,27 +895,12 @@
{ # A Google Cloud Redis instance.
"statusMessage": "A String", # Output only. Additional information about the current status of this
# instance, if available.
- "authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine
- # [network](/compute/docs/networks-and-firewalls#networks) to which the
- # instance is connected. If left unspecified, the `default` network
- # will be used.
- "state": "A String", # Output only. The current state of this instance.
- "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: Redis instances are managed and addressed at regional level so
- # location_id here refers to a GCP region; however, users may choose which
- # specific zone (or collection of zones for cross-zone instances) an instance
- # should be provisioned in. Refer to location_id and
- # alternative_location_id fields for more details.
- "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
- # If not provided, the connect mode defaults to DIRECT_PEERING.
- "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
- # transfer data to/from Cloud Storage. Format is
- # "serviceAccount:<service_account_email>". The value may change over time
- # for a given instance so should be checked before each import/export
- # operation.
+ "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
+ # clients to connect to the service.
+ "createTime": "A String", # Output only. The time the instance was created.
+ "labels": { # Resource labels to represent user provided metadata
+ "a_key": "A String",
+ },
"redisConfigs": { # Optional. Redis configuration parameters, according to
# http://redis.io/topics/config. Currently, the only supported parameters
# are:
@@ -939,8 +924,35 @@
"a_key": "A String",
},
"port": 42, # Output only. The port number of the exposed Redis endpoint.
- "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
- # clients to connect to the service.
+ "authorizedNetwork": "A String", # Optional. 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.
+ "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
+ # Tier instances, this will always be the same as the location_id
+ # provided by the user at creation time. For Standard Tier instances,
+ # this can be either location_id or alternative_location_id and can
+ # change after a failover event.
+ "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
+ # If not provided, the connect mode defaults to DIRECT_PEERING.
+ "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
+ # instance. If not provided, the service will choose an unused /29 block,
+ # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
+ # and non-overlapping with existing subnets in an authorized network.
+ "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
+ # transfer data to/from Cloud Storage. Format is
+ # "serviceAccount:<service_account_email>". The value may change over time
+ # for a given instance so should be checked before each import/export
+ # operation.
+ "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: Redis instances are managed and addressed at regional level so
+ # location_id here refers to a GCP region; however, users may choose which
+ # specific zone (or collection of zones for cross-zone instances) an instance
+ # should be provisioned in. Refer to location_id and
+ # alternative_location_id fields for more details.
"redisVersion": "A String", # Optional. The version of Redis software.
# If not provided, latest supported version will be used. Currently, the
# supported values are:
@@ -949,6 +961,9 @@
# * `REDIS_4_0` for Redis 4.0 compatibility (default)
# * `REDIS_5_0` for Redis 5.0 compatibility
"memorySizeGb": 42, # Required. Redis memory size in GiB.
+ "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
+ # against zonal failures by provisioning it across two zones. If provided, it
+ # must be a different zone from the one provided in location_id.
"tier": "A String", # Required. The service tier of the instance.
"displayName": "A String", # An arbitrary and optional user-provided name for the instance.
"locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
@@ -956,22 +971,7 @@
# instances will be created across two zones for protection against zonal
# failures. If alternative_location_id is also provided, it must be
# different from location_id.
- "reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this
- # instance. If not provided, the service will choose an unused /29 block,
- # for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
- # and non-overlapping with existing subnets in an authorized network.
- "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
- # Tier instances, this will always be the same as the location_id
- # provided by the user at creation time. For Standard Tier instances,
- # this can be either location_id or alternative_location_id and can
- # change after a failover event.
- "alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance
- # against zonal failures by provisioning it across two zones. If provided, it
- # must be a different zone from the one provided in location_id.
- "createTime": "A String", # Output only. The time the instance was created.
- "labels": { # Resource labels to represent user provided metadata
- "a_key": "A String",
- },
+ "state": "A String", # Output only. The current state of this instance.
}
updateMask: string, Required. Mask of fields to update. At least one path must be supplied in
@@ -992,6 +992,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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}`.
"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
@@ -1002,27 +1005,6 @@
# `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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "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.
- },
- ],
- },
"metadata": { # {
#
# `createTime`: The time the operation was created.
@@ -1042,6 +1024,24 @@
# }
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "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.
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ },
"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.
@@ -1074,6 +1074,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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}`.
"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
@@ -1084,27 +1087,6 @@
# `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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "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.
- },
- ],
- },
"metadata": { # {
#
# `createTime`: The time the operation was created.
@@ -1124,6 +1106,24 @@
# }
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "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.
+ "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.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ },
"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.