docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/redis_v1beta1.projects.locations.instances.html b/docs/dyn/redis_v1beta1.projects.locations.instances.html
index 6cb948f..795a170 100644
--- a/docs/dyn/redis_v1beta1.projects.locations.instances.html
+++ b/docs/dyn/redis_v1beta1.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, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=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>
@@ -109,7 +109,7 @@
<code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
<pre>Creates a Redis instance based on the specified tier and memory size.
-By default, the instance is accessible from the project's
+By default, the instance is accessible from the project's
[default network](/compute/docs/networks-and-firewalls#networks).
The creation is executed asynchronously and callers may check the returned
@@ -128,11 +128,12 @@
The object takes the form of:
{ # A Google Cloud Redis instance.
- "labels": { # Resource labels to represent user provided metadata
- "a_key": "A String",
- },
- "displayName": "A String", # An arbitrary and optional user-provided name for the instance.
- "name": "A String", # Required. Unique name of the resource in this scope including project and
+ "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}`
#
@@ -141,38 +142,15 @@
# 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.
- "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.
- "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
- # the service will choose a zone for the instance. For STANDARD_HA tier,
- # 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.
- "redisVersion": "A String", # Optional. The version of Redis software.
- # If not provided, latest supported version will be used. Currently, the
- # supported values are:
- #
- # * `REDIS_3_2` for Redis 3.2 compatibility
- # * `REDIS_4_0` for Redis 4.0 compatibility (default)
- # * `REDIS_5_0` for Redis 5.0 compatibility
- "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.
- "memorySizeGb": 42, # Required. Redis memory size in GiB.
- "state": "A String", # Output only. The current state of this instance.
- "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
+ "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
+ # "serviceAccount:<service_account_email>". The value may change over time
# for a given instance so should be checked before each import/export
# operation.
- "statusMessage": "A String", # Output only. Additional information about the current status of this
- # instance, if available.
- "redisConfigs": { # Optional. Redis configuration parameters, according to
+ "port": 42, # Output only. The port number of the exposed Redis endpoint.
+ "redisConfigs": { # Optional. Redis configuration parameters, according to
# http://redis.io/topics/config. Currently, the only supported parameters
# are:
#
@@ -192,21 +170,43 @@
#
# * stream-node-max-bytes
# * stream-node-max-entries
- "a_key": "A String",
+ "a_key": "A String",
},
- "tier": "A String", # Required. The service tier of the instance.
- "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
- # If not provided, the connect mode defaults to DIRECT_PEERING.
- "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
+ "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
+ # clients to connect to the service.
+ "redisVersion": "A String", # Optional. The version of Redis software.
+ # If not provided, latest supported version will be used. Currently, the
+ # supported values are:
+ #
+ # * `REDIS_3_2` for Redis 3.2 compatibility
+ # * `REDIS_4_0` for Redis 4.0 compatibility (default)
+ # * `REDIS_5_0` for Redis 5.0 compatibility
+ "tier": "A String", # Required. The service tier of the instance.
+ "memorySizeGb": 42, # Required. Redis memory size in GiB.
+ "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
+ # the service will choose a zone for the instance. For STANDARD_HA tier,
+ # 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.
+ "displayName": "A String", # An arbitrary and optional user-provided name for the instance.
+ "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.
+ "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.
+ "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.
- "port": 42, # Output only. The port number of the exposed Redis endpoint.
- "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.
+ "labels": { # Resource labels to represent user provided metadata
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. The time the instance was created.
+ "statusMessage": "A String", # Output only. Additional information about the current status of this
+ # instance, if available.
}
instanceId: string, Required. The logical name of the Redis instance in the customer project
@@ -227,7 +227,41 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # {
+ "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.
+ "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}`.
+ "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.
+ },
+ "metadata": { # {
#
# `createTime`: The time the operation was created.
#
@@ -244,42 +278,8 @@
# `apiVersion`: API version used to start the operation.
#
# }
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "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.
- "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.
- },
- ],
- },
- "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.
- "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>
@@ -302,7 +302,41 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # {
+ "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.
+ "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}`.
+ "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.
+ },
+ "metadata": { # {
#
# `createTime`: The time the operation was created.
#
@@ -319,42 +353,8 @@
# `apiVersion`: API version used to start the operation.
#
# }
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "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.
- "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.
- },
- ],
- },
- "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.
- "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>
@@ -375,10 +375,10 @@
The object takes the form of:
{ # Request for Export.
- "outputConfig": { # The output content # Required. Specify data to be exported.
- "gcsDestination": { # The Cloud Storage location for the output content # Google Cloud Storage destination for output content.
- "uri": "A String", # Required. Data destination URI (e.g.
- # 'gs://my_bucket/my_object'). Existing files will be overwritten.
+ "outputConfig": { # The output content # Required. Specify data to be exported.
+ "gcsDestination": { # The Cloud Storage location for the output content # Google Cloud Storage destination for output content.
+ "uri": "A String", # Required. Data destination URI (e.g.
+ # 'gs://my_bucket/my_object'). Existing files will be overwritten.
},
},
}
@@ -393,7 +393,41 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # {
+ "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.
+ "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}`.
+ "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.
+ },
+ "metadata": { # {
#
# `createTime`: The time the operation was created.
#
@@ -410,42 +444,8 @@
# `apiVersion`: API version used to start the operation.
#
# }
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "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.
- "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.
- },
- ],
- },
- "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.
- "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>
@@ -462,7 +462,7 @@
The object takes the form of:
{ # Request for Failover.
- "dataProtectionMode": "A String", # Optional. Available data protection modes that the user can choose. If it's
+ "dataProtectionMode": "A String", # Optional. Available data protection modes that the user can choose. If it's
# unspecified, data protection mode will be LIMITED_DATA_LOSS by default.
}
@@ -476,7 +476,41 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # {
+ "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.
+ "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}`.
+ "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.
+ },
+ "metadata": { # {
#
# `createTime`: The time the operation was created.
#
@@ -493,42 +527,8 @@
# `apiVersion`: API version used to start the operation.
#
# }
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "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.
- "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.
- },
- ],
- },
- "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.
- "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,11 +549,12 @@
An object of the form:
{ # A Google Cloud Redis instance.
- "labels": { # Resource labels to represent user provided metadata
- "a_key": "A String",
- },
- "displayName": "A String", # An arbitrary and optional user-provided name for the instance.
- "name": "A String", # Required. Unique name of the resource in this scope including project and
+ "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}`
#
@@ -562,38 +563,15 @@
# 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.
- "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.
- "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
- # the service will choose a zone for the instance. For STANDARD_HA tier,
- # 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.
- "redisVersion": "A String", # Optional. The version of Redis software.
- # If not provided, latest supported version will be used. Currently, the
- # supported values are:
- #
- # * `REDIS_3_2` for Redis 3.2 compatibility
- # * `REDIS_4_0` for Redis 4.0 compatibility (default)
- # * `REDIS_5_0` for Redis 5.0 compatibility
- "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.
- "memorySizeGb": 42, # Required. Redis memory size in GiB.
- "state": "A String", # Output only. The current state of this instance.
- "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
+ "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
+ # "serviceAccount:<service_account_email>". The value may change over time
# for a given instance so should be checked before each import/export
# operation.
- "statusMessage": "A String", # Output only. Additional information about the current status of this
- # instance, if available.
- "redisConfigs": { # Optional. Redis configuration parameters, according to
+ "port": 42, # Output only. The port number of the exposed Redis endpoint.
+ "redisConfigs": { # Optional. Redis configuration parameters, according to
# http://redis.io/topics/config. Currently, the only supported parameters
# are:
#
@@ -613,21 +591,43 @@
#
# * stream-node-max-bytes
# * stream-node-max-entries
- "a_key": "A String",
+ "a_key": "A String",
},
- "tier": "A String", # Required. The service tier of the instance.
- "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
- # If not provided, the connect mode defaults to DIRECT_PEERING.
- "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
+ "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
+ # clients to connect to the service.
+ "redisVersion": "A String", # Optional. The version of Redis software.
+ # If not provided, latest supported version will be used. Currently, the
+ # supported values are:
+ #
+ # * `REDIS_3_2` for Redis 3.2 compatibility
+ # * `REDIS_4_0` for Redis 4.0 compatibility (default)
+ # * `REDIS_5_0` for Redis 5.0 compatibility
+ "tier": "A String", # Required. The service tier of the instance.
+ "memorySizeGb": 42, # Required. Redis memory size in GiB.
+ "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
+ # the service will choose a zone for the instance. For STANDARD_HA tier,
+ # 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.
+ "displayName": "A String", # An arbitrary and optional user-provided name for the instance.
+ "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.
+ "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.
+ "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.
- "port": 42, # Output only. The port number of the exposed Redis endpoint.
- "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.
+ "labels": { # Resource labels to represent user provided metadata
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. The time the instance was created.
+ "statusMessage": "A String", # Output only. Additional information about the current status of this
+ # instance, if available.
}</pre>
</div>
@@ -650,9 +650,9 @@
The object takes the form of:
{ # Request for Import.
- "inputConfig": { # The input content # Required. Specify data to be imported.
- "gcsSource": { # The Cloud Storage location for the input content # Google Cloud Storage location where input content is located.
- "uri": "A String", # Required. Source data URI. (e.g. 'gs://my_bucket/my_object').
+ "inputConfig": { # The input content # Required. Specify data to be imported.
+ "gcsSource": { # The Cloud Storage location for the input content # Google Cloud Storage location where input content is located.
+ "uri": "A String", # Required. Source data URI. (e.g. 'gs://my_bucket/my_object').
},
},
}
@@ -667,7 +667,41 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # {
+ "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.
+ "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}`.
+ "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.
+ },
+ "metadata": { # {
#
# `createTime`: The time the operation was created.
#
@@ -684,47 +718,13 @@
# `apiVersion`: API version used to start the operation.
#
# }
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "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.
- "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.
- },
- ],
- },
- "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.
- "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>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists all Redis instances owned by a project in either the specified
location (region) or all locations.
@@ -741,40 +741,44 @@
where `location_id` refers to a GCP region. (required)
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
- 2 - v2 error format
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
+and a caller should only rely on response's
`next_page_token`
to determine if there are more instances left to be queried.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
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
+ "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,
+ "unreachable": [ # Locations that could not be reached.
+ "A String",
+ ],
+ "instances": [ # A list of Redis 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
+ # If the `location_id` in the parent field of the request is "-", all regions
# available to the project are queried, and the results aggregated.
# If in such an aggregated query a location is unavailable, a dummy Redis
# entry is included in the response with the `name` field set to a value of
# the form `projects/{project_id}/locations/{location_id}/instances/`- and
- # the `status` field set to ERROR and `status_message` field set to "location
- # not available for ListInstances".
+ # the `status` field set to ERROR and `status_message` field set to "location
+ # not available for ListInstances".
{ # A Google Cloud Redis instance.
- "labels": { # Resource labels to represent user provided metadata
- "a_key": "A String",
- },
- "displayName": "A String", # An arbitrary and optional user-provided name for the instance.
- "name": "A String", # Required. Unique name of the resource in this scope including project and
+ "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}`
#
@@ -783,38 +787,15 @@
# 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.
- "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.
- "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
- # the service will choose a zone for the instance. For STANDARD_HA tier,
- # 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.
- "redisVersion": "A String", # Optional. The version of Redis software.
- # If not provided, latest supported version will be used. Currently, the
- # supported values are:
- #
- # * `REDIS_3_2` for Redis 3.2 compatibility
- # * `REDIS_4_0` for Redis 4.0 compatibility (default)
- # * `REDIS_5_0` for Redis 5.0 compatibility
- "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.
- "memorySizeGb": 42, # Required. Redis memory size in GiB.
- "state": "A String", # Output only. The current state of this instance.
- "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
+ "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
+ # "serviceAccount:<service_account_email>". The value may change over time
# for a given instance so should be checked before each import/export
# operation.
- "statusMessage": "A String", # Output only. Additional information about the current status of this
- # instance, if available.
- "redisConfigs": { # Optional. Redis configuration parameters, according to
+ "port": 42, # Output only. The port number of the exposed Redis endpoint.
+ "redisConfigs": { # Optional. Redis configuration parameters, according to
# http://redis.io/topics/config. Currently, the only supported parameters
# are:
#
@@ -834,26 +815,45 @@
#
# * stream-node-max-bytes
# * stream-node-max-entries
- "a_key": "A String",
+ "a_key": "A String",
},
- "tier": "A String", # Required. The service tier of the instance.
- "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
- # If not provided, the connect mode defaults to DIRECT_PEERING.
- "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
+ "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
+ # clients to connect to the service.
+ "redisVersion": "A String", # Optional. The version of Redis software.
+ # If not provided, latest supported version will be used. Currently, the
+ # supported values are:
+ #
+ # * `REDIS_3_2` for Redis 3.2 compatibility
+ # * `REDIS_4_0` for Redis 4.0 compatibility (default)
+ # * `REDIS_5_0` for Redis 5.0 compatibility
+ "tier": "A String", # Required. The service tier of the instance.
+ "memorySizeGb": 42, # Required. Redis memory size in GiB.
+ "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
+ # the service will choose a zone for the instance. For STANDARD_HA tier,
+ # 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.
+ "displayName": "A String", # An arbitrary and optional user-provided name for the instance.
+ "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.
+ "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.
+ "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.
- "port": 42, # Output only. The port number of the exposed Redis endpoint.
- "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.
+ "labels": { # Resource labels to represent user provided metadata
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. The time the instance was created.
+ "statusMessage": "A String", # Output only. Additional information about the current status of this
+ # instance, if available.
},
],
- "unreachable": [ # Locations that could not be reached.
- "A String",
- ],
}</pre>
</div>
@@ -866,7 +866,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -893,11 +893,12 @@
The object takes the form of:
{ # A Google Cloud Redis instance.
- "labels": { # Resource labels to represent user provided metadata
- "a_key": "A String",
- },
- "displayName": "A String", # An arbitrary and optional user-provided name for the instance.
- "name": "A String", # Required. Unique name of the resource in this scope including project and
+ "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}`
#
@@ -906,38 +907,15 @@
# 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.
- "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.
- "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
- # the service will choose a zone for the instance. For STANDARD_HA tier,
- # 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.
- "redisVersion": "A String", # Optional. The version of Redis software.
- # If not provided, latest supported version will be used. Currently, the
- # supported values are:
- #
- # * `REDIS_3_2` for Redis 3.2 compatibility
- # * `REDIS_4_0` for Redis 4.0 compatibility (default)
- # * `REDIS_5_0` for Redis 5.0 compatibility
- "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.
- "memorySizeGb": 42, # Required. Redis memory size in GiB.
- "state": "A String", # Output only. The current state of this instance.
- "persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to
+ "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
+ # "serviceAccount:<service_account_email>". The value may change over time
# for a given instance so should be checked before each import/export
# operation.
- "statusMessage": "A String", # Output only. Additional information about the current status of this
- # instance, if available.
- "redisConfigs": { # Optional. Redis configuration parameters, according to
+ "port": 42, # Output only. The port number of the exposed Redis endpoint.
+ "redisConfigs": { # Optional. Redis configuration parameters, according to
# http://redis.io/topics/config. Currently, the only supported parameters
# are:
#
@@ -957,21 +935,43 @@
#
# * stream-node-max-bytes
# * stream-node-max-entries
- "a_key": "A String",
+ "a_key": "A String",
},
- "tier": "A String", # Required. The service tier of the instance.
- "connectMode": "A String", # Optional. The network connect mode of the Redis instance.
- # If not provided, the connect mode defaults to DIRECT_PEERING.
- "currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic
+ "host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by
+ # clients to connect to the service.
+ "redisVersion": "A String", # Optional. The version of Redis software.
+ # If not provided, latest supported version will be used. Currently, the
+ # supported values are:
+ #
+ # * `REDIS_3_2` for Redis 3.2 compatibility
+ # * `REDIS_4_0` for Redis 4.0 compatibility (default)
+ # * `REDIS_5_0` for Redis 5.0 compatibility
+ "tier": "A String", # Required. The service tier of the instance.
+ "memorySizeGb": 42, # Required. Redis memory size in GiB.
+ "locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,
+ # the service will choose a zone for the instance. For STANDARD_HA tier,
+ # 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.
+ "displayName": "A String", # An arbitrary and optional user-provided name for the instance.
+ "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.
+ "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.
+ "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.
- "port": 42, # Output only. The port number of the exposed Redis endpoint.
- "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.
+ "labels": { # Resource labels to represent user provided metadata
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Output only. The time the instance was created.
+ "statusMessage": "A String", # Output only. Additional information about the current status of this
+ # instance, if available.
}
updateMask: string, Required. Mask of fields to update. At least one path must be supplied in
@@ -992,7 +992,41 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # {
+ "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.
+ "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}`.
+ "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.
+ },
+ "metadata": { # {
#
# `createTime`: The time the operation was created.
#
@@ -1009,42 +1043,8 @@
# `apiVersion`: API version used to start the operation.
#
# }
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "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.
- "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.
- },
- ],
- },
- "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.
- "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>
@@ -1061,7 +1061,7 @@
The object takes the form of:
{ # Request for UpgradeInstance.
- "redisVersion": "A String", # Required. Specifies the target version of Redis software to upgrade to.
+ "redisVersion": "A String", # Required. Specifies the target version of Redis software to upgrade to.
}
x__xgafv: string, V1 error format.
@@ -1074,7 +1074,41 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # {
+ "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.
+ "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}`.
+ "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.
+ },
+ "metadata": { # {
#
# `createTime`: The time the operation was created.
#
@@ -1091,42 +1125,8 @@
# `apiVersion`: API version used to start the operation.
#
# }
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "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.
- "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.
- },
- ],
- },
- "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.
- "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>