Blame - docs/dyn/redis_v1.projects.locations.instances.html - platform/external/python/google-api-python-client

blob: 6d2cbb1440be2948c2161e61706188a5ac92933b [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="redis_v1.html">Google Cloud Memorystore for Redis API</a> . <a href="redis_v1.projects.html">projects</a> . <a href="redis_v1.projects.locations.html">locations</a> . <a href="redis_v1.projects.locations.instances.html">instances</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	81	<code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	82	<p class="firstline">Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's [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 instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	85	<p class="firstline">Deletes a specific Redis instance. Instance stops serving and data is deleted.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	86	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	<code><a href="#export">export(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	88	<p class="firstline">Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	89	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	90	<code><a href="#failover">failover(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	91	<p class="firstline">Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				94	<p class="firstline">Gets the details of a specific Redis instance.</p>
				95	<p class="toc_element">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	96	<code><a href="#getAuthString">getAuthString(name, x__xgafv=None)</a></code></p>
				97	<p class="firstline">Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.</p>
				98	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	<code><a href="#import_">import_(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	100	<p class="firstline">Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	101	<p class="toc_element">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	102	<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	103	<p class="firstline">Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	104	<p class="toc_element">
				105	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				106	<p class="firstline">Retrieves the next page of results.</p>
				107	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	108	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	109	<p class="firstline">Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.</p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	110	<p class="toc_element">
				111	<code><a href="#upgrade">upgrade(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	112	<p class="firstline">Upgrades Redis instance to the newer Redis version specified in the request.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	113	<h3>Method Details</h3>
				114	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	115	<code class="details" id="close">close()</code>
				116	<pre>Close httplib2 connections.</pre>
				117	</div>
				118
				119	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	120	<code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	121	<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](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 instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	122
				123	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	124	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)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	125	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	126	The object takes the form of:
				127
				128	{ # A Google Cloud Redis instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	129	"redisConfigs": { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
				130	"a_key": "A String",
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	131	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	132	"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.
				133	"connectMode": "A String", # Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
				134	"tier": "A String", # Required. The service tier of the instance.
				135	"createTime": "A String", # Output only. The time the instance was created.
				136	"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.
				137	"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.
				138	"serverCaCerts": [ # Output only. List of server CA certificates for the instance.
				139	{ # TlsCertificate Resource
				140	"expireTime": "A String", # Output only. The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2020-05-18T00:00:00.094Z`.
				141	"createTime": "A String", # Output only. The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2020-05-18T00:00:00.094Z`.
				142	"cert": "A String", # PEM representation.
				143	"serialNumber": "A String", # Serial number, as extracted from the certificate.
				144	"sha1Fingerprint": "A String", # Sha1 Fingerprint of the certificate.
				145	},
				146	],
				147	"labels": { # Resource labels to represent user provided metadata
				148	"a_key": "A String",
				149	},
				150	"state": "A String", # Output only. The current state of this instance.
				151	"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
				152	"transitEncryptionMode": "A String", # Optional. The In-transit encryption mode of Redis instance. If not provided, in-transit encryption is disabled for instance.
				153	"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.
				154	"statusMessage": "A String", # Output only. Additional information about the current status of this instance, if available.
				155	"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.
				156	"persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation.
				157	"memorySizeGb": 42, # Required. Redis memory size in GiB.
				158	"authEnabled": True or False, # Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.
				159	"host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
				160	"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.
				161	"displayName": "A String", # An arbitrary and optional user-provided name for the instance.
				162	"port": 42, # Output only. The port number of the exposed Redis endpoint.
				163	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	164
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	165	instanceId: string, Required. The logical name of the Redis instance in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project / location
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	166	x__xgafv: string, V1 error format.
				167	Allowed values
				168	1 - v1 error format
				169	2 - v2 error format
				170
				171	Returns:
				172	An object of the form:
				173
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	174	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	175	"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`.
				176	"a_key": "", # Properties of the object. Contains field @type with type URL.
				177	},
				178	"metadata": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
				179	"a_key": "", # Properties of the object. Contains field @type with type URL.
				180	},
				181	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	182	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	183	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	184	{
				185	"a_key": "", # Properties of the object. Contains field @type with type URL.
				186	},
				187	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	188	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	189	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	190	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	191	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	192	}</pre>
				193	</div>
				194
				195	<div class="method">
				196	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	197	<pre>Deletes a specific Redis instance. Instance stops serving and data is deleted.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	198
				199	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	200	name: string, Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	201	x__xgafv: string, V1 error format.
				202	Allowed values
				203	1 - v1 error format
				204	2 - v2 error format
				205
				206	Returns:
				207	An object of the form:
				208
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	209	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	210	"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`.
				211	"a_key": "", # Properties of the object. Contains field @type with type URL.
				212	},
				213	"metadata": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
				214	"a_key": "", # Properties of the object. Contains field @type with type URL.
				215	},
				216	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	217	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	218	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	219	{
				220	"a_key": "", # Properties of the object. Contains field @type with type URL.
				221	},
				222	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	223	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	224	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	225	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	226	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	227	}</pre>
				228	</div>
				229
				230	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	231	<code class="details" id="export">export(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	232	<pre>Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	233
				234	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	235	name: string, Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	236	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	237	The object takes the form of:
				238
				239	{ # Request for Export.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	240	"outputConfig": { # The output content # Required. Specify data to be exported.
				241	"gcsDestination": { # The Cloud Storage location for the output content # Google Cloud Storage destination for output content.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	242	"uri": "A String", # Required. Data destination URI (e.g. 'gs://my_bucket/my_object'). Existing files will be overwritten.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	243	},
				244	},
				245	}
				246
				247	x__xgafv: string, V1 error format.
				248	Allowed values
				249	1 - v1 error format
				250	2 - v2 error format
				251
				252	Returns:
				253	An object of the form:
				254
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	255	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	256	"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`.
				257	"a_key": "", # Properties of the object. Contains field @type with type URL.
				258	},
				259	"metadata": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
				260	"a_key": "", # Properties of the object. Contains field @type with type URL.
				261	},
				262	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	263	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	264	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	265	{
				266	"a_key": "", # Properties of the object. Contains field @type with type URL.
				267	},
				268	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	269	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	270	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	271	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	272	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	273	}</pre>
				274	</div>
				275
				276	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	277	<code class="details" id="failover">failover(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	278	<pre>Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	279
				280	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	281	name: string, Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	282	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	283	The object takes the form of:
				284
				285	{ # Request for Failover.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	286	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	287	}
				288
				289	x__xgafv: string, V1 error format.
				290	Allowed values
				291	1 - v1 error format
				292	2 - v2 error format
				293
				294	Returns:
				295	An object of the form:
				296
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	297	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	298	"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`.
				299	"a_key": "", # Properties of the object. Contains field @type with type URL.
				300	},
				301	"metadata": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
				302	"a_key": "", # Properties of the object. Contains field @type with type URL.
				303	},
				304	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	305	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	306	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	307	{
				308	"a_key": "", # Properties of the object. Contains field @type with type URL.
				309	},
				310	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	311	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	312	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	313	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	314	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	315	}</pre>
				316	</div>
				317
				318	<div class="method">
				319	<code class="details" id="get">get(name, x__xgafv=None)</code>
				320	<pre>Gets the details of a specific Redis instance.
				321
				322	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	323	name: string, Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	324	x__xgafv: string, V1 error format.
				325	Allowed values
				326	1 - v1 error format
				327	2 - v2 error format
				328
				329	Returns:
				330	An object of the form:
				331
				332	{ # A Google Cloud Redis instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	333	"redisConfigs": { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
				334	"a_key": "A String",
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	335	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	336	"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.
				337	"connectMode": "A String", # Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
				338	"tier": "A String", # Required. The service tier of the instance.
				339	"createTime": "A String", # Output only. The time the instance was created.
				340	"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.
				341	"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.
				342	"serverCaCerts": [ # Output only. List of server CA certificates for the instance.
				343	{ # TlsCertificate Resource
				344	"expireTime": "A String", # Output only. The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2020-05-18T00:00:00.094Z`.
				345	"createTime": "A String", # Output only. The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2020-05-18T00:00:00.094Z`.
				346	"cert": "A String", # PEM representation.
				347	"serialNumber": "A String", # Serial number, as extracted from the certificate.
				348	"sha1Fingerprint": "A String", # Sha1 Fingerprint of the certificate.
				349	},
				350	],
				351	"labels": { # Resource labels to represent user provided metadata
				352	"a_key": "A String",
				353	},
				354	"state": "A String", # Output only. The current state of this instance.
				355	"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
				356	"transitEncryptionMode": "A String", # Optional. The In-transit encryption mode of Redis instance. If not provided, in-transit encryption is disabled for instance.
				357	"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.
				358	"statusMessage": "A String", # Output only. Additional information about the current status of this instance, if available.
				359	"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.
				360	"persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation.
				361	"memorySizeGb": 42, # Required. Redis memory size in GiB.
				362	"authEnabled": True or False, # Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.
				363	"host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
				364	"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.
				365	"displayName": "A String", # An arbitrary and optional user-provided name for the instance.
				366	"port": 42, # Output only. The port number of the exposed Redis endpoint.
				367	}</pre>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	368	</div>
				369
				370	<div class="method">
				371	<code class="details" id="getAuthString">getAuthString(name, x__xgafv=None)</code>
				372	<pre>Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.
				373
				374	Args:
				375	name: string, Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. (required)
				376	x__xgafv: string, V1 error format.
				377	Allowed values
				378	1 - v1 error format
				379	2 - v2 error format
				380
				381	Returns:
				382	An object of the form:
				383
				384	{ # Instance AUTH string details.
				385	"authString": "A String", # AUTH string set on the instance.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	386	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	387	</div>
				388
				389	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	390	<code class="details" id="import_">import_(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	391	<pre>Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	392
				393	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	394	name: string, Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	395	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	396	The object takes the form of:
				397
				398	{ # Request for Import.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	399	"inputConfig": { # The input content # Required. Specify data to be imported.
				400	"gcsSource": { # The Cloud Storage location for the input content # Google Cloud Storage location where input content is located.
				401	"uri": "A String", # Required. Source data URI. (e.g. 'gs://my_bucket/my_object').
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	402	},
				403	},
				404	}
				405
				406	x__xgafv: string, V1 error format.
				407	Allowed values
				408	1 - v1 error format
				409	2 - v2 error format
				410
				411	Returns:
				412	An object of the form:
				413
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	414	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	415	"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`.
				416	"a_key": "", # Properties of the object. Contains field @type with type URL.
				417	},
				418	"metadata": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
				419	"a_key": "", # Properties of the object. Contains field @type with type URL.
				420	},
				421	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	422	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	423	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	424	{
				425	"a_key": "", # Properties of the object. Contains field @type with type URL.
				426	},
				427	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	428	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	429	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	430	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	431	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	432	}</pre>
				433	</div>
				434
				435	<div class="method">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	436	<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	437	<pre>Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	438
				439	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	440	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)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	441	pageToken: string, The `next_page_token` value returned from a previous ListInstances request, if any.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	442	pageSize: integer, The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more instances left to be queried.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	443	x__xgafv: string, V1 error format.
				444	Allowed values
				445	1 - v1 error format
				446	2 - v2 error format
				447
				448	Returns:
				449	An object of the form:
				450
				451	{ # Response for ListInstances.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	452	"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 available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder 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".
				453	{ # A Google Cloud Redis instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	454	"redisConfigs": { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
				455	"a_key": "A String",
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	456	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	457	"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.
				458	"connectMode": "A String", # Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
				459	"tier": "A String", # Required. The service tier of the instance.
				460	"createTime": "A String", # Output only. The time the instance was created.
				461	"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.
				462	"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.
				463	"serverCaCerts": [ # Output only. List of server CA certificates for the instance.
				464	{ # TlsCertificate Resource
				465	"expireTime": "A String", # Output only. The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2020-05-18T00:00:00.094Z`.
				466	"createTime": "A String", # Output only. The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2020-05-18T00:00:00.094Z`.
				467	"cert": "A String", # PEM representation.
				468	"serialNumber": "A String", # Serial number, as extracted from the certificate.
				469	"sha1Fingerprint": "A String", # Sha1 Fingerprint of the certificate.
				470	},
				471	],
				472	"labels": { # Resource labels to represent user provided metadata
				473	"a_key": "A String",
				474	},
				475	"state": "A String", # Output only. The current state of this instance.
				476	"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
				477	"transitEncryptionMode": "A String", # Optional. The In-transit encryption mode of Redis instance. If not provided, in-transit encryption is disabled for instance.
				478	"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.
				479	"statusMessage": "A String", # Output only. Additional information about the current status of this instance, if available.
				480	"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.
				481	"persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation.
				482	"memorySizeGb": 42, # Required. Redis memory size in GiB.
				483	"authEnabled": True or False, # Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.
				484	"host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
				485	"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.
				486	"displayName": "A String", # An arbitrary and optional user-provided name for the instance.
				487	"port": 42, # Output only. The port number of the exposed Redis endpoint.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	488	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	489	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	490	"unreachable": [ # Locations that could not be reached.
				491	"A String",
				492	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	493	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	494	}</pre>
				495	</div>
				496
				497	<div class="method">
				498	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				499	<pre>Retrieves the next page of results.
				500
				501	Args:
				502	previous_request: The request for the previous page. (required)
				503	previous_response: The response from the request for the previous page. (required)
				504
				505	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	506	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	507	page. Returns None if there are no more items in the collection.
				508	</pre>
				509	</div>
				510
				511	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	512	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	513	<pre>Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	514
				515	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	516	name: 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. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	517	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	518	The object takes the form of:
				519
				520	{ # A Google Cloud Redis instance.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	521	"redisConfigs": { # Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
				522	"a_key": "A String",
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	523	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	524	"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.
				525	"connectMode": "A String", # Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
				526	"tier": "A String", # Required. The service tier of the instance.
				527	"createTime": "A String", # Output only. The time the instance was created.
				528	"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.
				529	"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.
				530	"serverCaCerts": [ # Output only. List of server CA certificates for the instance.
				531	{ # TlsCertificate Resource
				532	"expireTime": "A String", # Output only. The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2020-05-18T00:00:00.094Z`.
				533	"createTime": "A String", # Output only. The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2020-05-18T00:00:00.094Z`.
				534	"cert": "A String", # PEM representation.
				535	"serialNumber": "A String", # Serial number, as extracted from the certificate.
				536	"sha1Fingerprint": "A String", # Sha1 Fingerprint of the certificate.
				537	},
				538	],
				539	"labels": { # Resource labels to represent user provided metadata
				540	"a_key": "A String",
				541	},
				542	"state": "A String", # Output only. The current state of this instance.
				543	"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
				544	"transitEncryptionMode": "A String", # Optional. The In-transit encryption mode of Redis instance. If not provided, in-transit encryption is disabled for instance.
				545	"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.
				546	"statusMessage": "A String", # Output only. Additional information about the current status of this instance, if available.
				547	"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.
				548	"persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation.
				549	"memorySizeGb": 42, # Required. Redis memory size in GiB.
				550	"authEnabled": True or False, # Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.
				551	"host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
				552	"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.
				553	"displayName": "A String", # An arbitrary and optional user-provided name for the instance.
				554	"port": 42, # Output only. The port number of the exposed Redis endpoint.
				555	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	556
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	557	updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Instance: * `displayName` * `labels` * `memorySizeGb` * `redisConfig`
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	558	x__xgafv: string, V1 error format.
				559	Allowed values
				560	1 - v1 error format
				561	2 - v2 error format
				562
				563	Returns:
				564	An object of the form:
				565
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	566	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	567	"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`.
				568	"a_key": "", # Properties of the object. Contains field @type with type URL.
				569	},
				570	"metadata": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
				571	"a_key": "", # Properties of the object. Contains field @type with type URL.
				572	},
				573	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	574	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	575	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	576	{
				577	"a_key": "", # Properties of the object. Contains field @type with type URL.
				578	},
				579	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	580	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	581	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	582	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	583	"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.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	584	}</pre>
				585	</div>
				586
				587	<div class="method">
				588	<code class="details" id="upgrade">upgrade(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	589	<pre>Upgrades Redis instance to the newer Redis version specified in the request.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	590
				591	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	592	name: string, Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	593	body: object, The request body.
				594	The object takes the form of:
				595
				596	{ # Request for UpgradeInstance.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	597	"redisVersion": "A String", # Required. Specifies the target version of Redis software to upgrade to.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	598	}
				599
				600	x__xgafv: string, V1 error format.
				601	Allowed values
				602	1 - v1 error format
				603	2 - v2 error format
				604
				605	Returns:
				606	An object of the form:
				607
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	608	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	609	"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`.
				610	"a_key": "", # Properties of the object. Contains field @type with type URL.
				611	},
				612	"metadata": { # { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
				613	"a_key": "", # Properties of the object. Contains field @type with type URL.
				614	},
				615	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	616	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	617	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	618	{
				619	"a_key": "", # Properties of the object. Contains field @type with type URL.
				620	},
				621	],
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame^]	622	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	623	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	624	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	625	"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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	626	}</pre>
				627	</div>
				628
				629	</body></html>