blob: bff11d7fb9c98ea0c7ed67139d922cd2092a48a7 [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"basePath": "",
"baseUrl": "https://redis.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Redis",
"description": "Creates and manages Redis instances on the Google Cloud Platform.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/memorystore/docs/redis/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "redis:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://redis.mtls.googleapis.com/",
"name": "redis",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
"get": {
"description": "Gets information about a location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "redis.projects.locations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Location"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists information about the supported locations for this service.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "redis.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/locations",
"response": {
"$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"instances": {
"methods": {
"create": {
"description": "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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances",
"httpMethod": "POST",
"id": "redis.projects.locations.instances.create",
"parameterOrder": [
"parent"
],
"parameters": {
"instanceId": {
"description": "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",
"location": "query",
"type": "string"
},
"parent": {
"description": "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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/instances",
"request": {
"$ref": "Instance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a specific Redis instance. Instance stops serving and data is deleted.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}",
"httpMethod": "DELETE",
"id": "redis.projects.locations.instances.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"export": {
"description": "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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:export",
"httpMethod": "POST",
"id": "redis.projects.locations.instances.export",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:export",
"request": {
"$ref": "ExportInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"failover": {
"description": "Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:failover",
"httpMethod": "POST",
"id": "redis.projects.locations.instances.failover",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:failover",
"request": {
"$ref": "FailoverInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the details of a specific Redis instance.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}",
"httpMethod": "GET",
"id": "redis.projects.locations.instances.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Instance"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"import": {
"description": "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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:import",
"httpMethod": "POST",
"id": "redis.projects.locations.instances.import",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:import",
"request": {
"$ref": "ImportInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances",
"httpMethod": "GET",
"id": "redis.projects.locations.instances.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The `next_page_token` value returned from a previous ListInstances request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/instances",
"response": {
"$ref": "ListInstancesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}",
"httpMethod": "PATCH",
"id": "redis.projects.locations.instances.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "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`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Instance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"upgrade": {
"description": "Upgrades Redis instance to the newer Redis version specified in the request.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:upgrade",
"httpMethod": "POST",
"id": "redis.projects.locations.instances.upgrade",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:upgrade",
"request": {
"$ref": "UpgradeInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "redis.projects.locations.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "redis.projects.locations.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "redis.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "redis.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/operations",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
},
"revision": "20200810",
"rootUrl": "https://redis.googleapis.com/",
"schemas": {
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"ExportInstanceRequest": {
"description": "Request for Export.",
"id": "ExportInstanceRequest",
"properties": {
"outputConfig": {
"$ref": "OutputConfig",
"description": "Required. Specify data to be exported."
}
},
"type": "object"
},
"FailoverInstanceRequest": {
"description": "Request for Failover.",
"id": "FailoverInstanceRequest",
"properties": {
"dataProtectionMode": {
"description": "Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default.",
"enum": [
"DATA_PROTECTION_MODE_UNSPECIFIED",
"LIMITED_DATA_LOSS",
"FORCE_DATA_LOSS"
],
"enumDescriptions": [
"Defaults to LIMITED_DATA_LOSS if a data protection mode is not specified.",
"Instance failover will be protected with data loss control. More specifically, the failover will only be performed if the current replication offset diff between master and replica is under a certain threshold.",
"Instance failover will be performed without data loss control."
],
"type": "string"
}
},
"type": "object"
},
"GcsDestination": {
"description": "The Cloud Storage location for the output content",
"id": "GcsDestination",
"properties": {
"uri": {
"description": "Required. Data destination URI (e.g. 'gs://my_bucket/my_object'). Existing files will be overwritten.",
"type": "string"
}
},
"type": "object"
},
"GcsSource": {
"description": "The Cloud Storage location for the input content",
"id": "GcsSource",
"properties": {
"uri": {
"description": "Required. Source data URI. (e.g. 'gs://my_bucket/my_object').",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudRedisV1LocationMetadata": {
"description": "This location metadata represents additional configuration options for a given location where a Redis instance may be created. All fields are output only. It is returned as content of the `google.cloud.location.Location.metadata` field.",
"id": "GoogleCloudRedisV1LocationMetadata",
"properties": {
"availableZones": {
"additionalProperties": {
"$ref": "GoogleCloudRedisV1ZoneMetadata"
},
"description": "Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by GCE. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance.",
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"GoogleCloudRedisV1OperationMetadata": {
"description": "Represents the v1 metadata of the long-running operation.",
"id": "GoogleCloudRedisV1OperationMetadata",
"properties": {
"apiVersion": {
"description": "API version.",
"type": "string"
},
"cancelRequested": {
"description": "Specifies if cancellation was requested for the operation.",
"type": "boolean"
},
"createTime": {
"description": "Creation timestamp.",
"format": "google-datetime",
"type": "string"
},
"endTime": {
"description": "End timestamp.",
"format": "google-datetime",
"type": "string"
},
"statusDetail": {
"description": "Operation status details.",
"type": "string"
},
"target": {
"description": "Operation target.",
"type": "string"
},
"verb": {
"description": "Operation verb.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudRedisV1ZoneMetadata": {
"description": "Defines specific information for a particular zone. Currently empty and reserved for future use only.",
"id": "GoogleCloudRedisV1ZoneMetadata",
"properties": {},
"type": "object"
},
"GoogleCloudSaasacceleratorManagementProvidersV1Instance": {
"id": "GoogleCloudSaasacceleratorManagementProvidersV1Instance",
"properties": {
"consumerDefinedName": {
"description": "consumer_defined_name is the name that is set by the consumer. On the other hand Name field represents system-assigned id of an instance so consumers are not necessarily aware of it. consumer_defined_name is used for notification/UI purposes for consumer to recognize their instances.",
"type": "string"
},
"createTime": {
"description": "Output only. Timestamp when the resource was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.",
"type": "object"
},
"maintenancePolicyNames": {
"additionalProperties": {
"type": "string"
},
"description": "The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.",
"type": "object"
},
"maintenanceSchedules": {
"additionalProperties": {
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule"
},
"description": "The MaintenanceSchedule contains the scheduling information of published maintenance schedule.",
"type": "object"
},
"maintenanceSettings": {
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings",
"description": "Optional. The MaintenanceSettings associated with instance."
},
"name": {
"description": "Unique name of the resource. It uses the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}`",
"type": "string"
},
"producerMetadata": {
"additionalProperties": {
"type": "string"
},
"description": "Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata.",
"readOnly": true,
"type": "object"
},
"provisionedResources": {
"description": "Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata.",
"items": {
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource"
},
"readOnly": true,
"type": "array"
},
"slmInstanceTemplate": {
"description": "Link to the SLM instance template. Only populated when updating SLM instances via SSA's Actuation service adaptor. Service producers with custom control plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they should use software_versions.",
"type": "string"
},
"sloMetadata": {
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata",
"description": "Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description.",
"readOnly": true
},
"softwareVersions": {
"additionalProperties": {
"type": "string"
},
"description": "Software versions that are used to deploy this instance. This can be mutated by rollout services.",
"type": "object"
},
"state": {
"description": "Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"READY",
"UPDATING",
"REPAIRING",
"DELETING",
"ERROR"
],
"enumDescriptions": [
"Unspecified state.",
"Instance is being created.",
"Instance has been created and is ready to use.",
"Instance is being updated.",
"Instance is unheathy and under repair.",
"Instance is being deleted.",
"Instance encountered an error and is in indeterministic state."
],
"readOnly": true,
"type": "string"
},
"tenantProjectId": {
"description": "Output only. ID of the associated GCP tenant project. See go/get-instance-metadata.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. Timestamp when the resource was last modified.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule": {
"description": "Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule",
"id": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule",
"properties": {
"canReschedule": {
"description": "Can this scheduled update be rescheduled? By default, it's true and API needs to do explicitly check whether it's set, if it's set as false explicitly, it's false",
"type": "boolean"
},
"endTime": {
"description": "The scheduled end time for the maintenance.",
"format": "google-datetime",
"type": "string"
},
"rolloutManagementPolicy": {
"description": "The rollout management policy this maintenance schedule is associated with. When doing reschedule update request, the reschedule should be against this given policy.",
"type": "string"
},
"startTime": {
"description": "The scheduled start time for the maintenance.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings": {
"description": "Maintenance settings associated with instance. Allows service producers and end users to assign settings that controls maintenance on this instance.",
"id": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings",
"properties": {
"exclude": {
"description": "Optional. Exclude instance from maintenance. When true, rollout service will not attempt maintenance on the instance. Rollout service will include the instance in reported rollout progress as not attempted.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata": {
"description": "Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information.",
"id": "GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata",
"properties": {
"exclusions": {
"description": "By default node is eligible if instance is eligible. But individual node might be excluded from SLO by adding entry here. For semantic see SloMetadata.exclusions. If both instance and node level exclusions are present for time period, the node level's reason will be reported by Eligibility Exporter.",
"items": {
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion"
},
"type": "array"
},
"location": {
"description": "The location of the node, if different from instance location.",
"type": "string"
},
"nodeId": {
"description": "The id of the node. This should be equal to SaasInstanceNode.node_id.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource": {
"description": "Describes provisioned dataplane resources.",
"id": "GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource",
"properties": {
"resourceType": {
"description": "Type of the resource. This can be either a GCP resource or a custom one (e.g. another cloud provider's VM). For GCP compute resources use singular form of the names listed in GCP compute API documentation (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: 'compute-instance', 'compute-disk', 'compute-autoscaler'.",
"type": "string"
},
"resourceUrl": {
"description": "URL identifying the resource, e.g. \"https://www.googleapis.com/compute/v1/projects/...)\".",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility": {
"description": "SloEligibility is a tuple containing eligibility value: true if an instance is eligible for SLO calculation or false if it should be excluded from all SLO-related calculations along with a user-defined reason.",
"id": "GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility",
"properties": {
"eligible": {
"description": "Whether an instance is eligible or ineligible.",
"type": "boolean"
},
"reason": {
"description": "User-defined reason for the current value of instance eligibility. Usually, this can be directly mapped to the internal state. An empty reason is allowed.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion": {
"description": "SloExclusion represents an exclusion in SLI calculation applies to all SLOs.",
"id": "GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion",
"properties": {
"duration": {
"description": "Exclusion duration. No restrictions on the possible values. When an ongoing operation is taking longer than initially expected, an existing entry in the exclusion list can be updated by extending the duration. This is supported by the subsystem exporting eligibility data as long as such extension is committed at least 10 minutes before the original exclusion expiration - otherwise it is possible that there will be \"gaps\" in the exclusion application in the exported timeseries.",
"format": "google-duration",
"type": "string"
},
"reason": {
"description": "Human-readable reason for the exclusion. This should be a static string (e.g. \"Disruptive update in progress\") and should not contain dynamically generated data (e.g. instance name). Can be left empty.",
"type": "string"
},
"sliName": {
"description": "Name of an SLI that this exclusion applies to. Can be left empty, signaling that the instance should be excluded from all SLIs defined in the service SLO configuration.",
"type": "string"
},
"startTime": {
"description": "Start time of the exclusion. No alignment (e.g. to a full minute) needed.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata": {
"description": "SloMetadata contains resources required for proper SLO classification of the instance.",
"id": "GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata",
"properties": {
"eligibility": {
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility",
"description": "Optional. User-defined instance eligibility."
},
"exclusions": {
"description": "List of SLO exclusion windows. When multiple entries in the list match (matching the exclusion time-window against current time point) the exclusion reason used in the first matching entry will be published. It is not needed to include expired exclusion in this list, as only the currently applicable exclusions are taken into account by the eligibility exporting subsystem (the historical state of exclusions will be reflected in the historically produced timeseries regardless of the current state). This field can be used to mark the instance as temporary ineligible for the purpose of SLO calculation. For permanent instance SLO exclusion, use of custom instance eligibility is recommended. See 'eligibility' field below.",
"items": {
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion"
},
"type": "array"
},
"nodes": {
"description": "Optional. List of nodes. Some producers need to use per-node metadata to calculate SLO. This field allows such producers to publish per-node SLO meta data, which will be consumed by SSA Eligibility Exporter and published in the form of per node metric to Monarch.",
"items": {
"$ref": "GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata"
},
"type": "array"
},
"tier": {
"description": "Name of the SLO tier the Instance belongs to. This name will be expected to match the tiers specified in the service SLO configuration. Field is mandatory and must not be empty.",
"type": "string"
}
},
"type": "object"
},
"ImportInstanceRequest": {
"description": "Request for Import.",
"id": "ImportInstanceRequest",
"properties": {
"inputConfig": {
"$ref": "InputConfig",
"description": "Required. Specify data to be imported."
}
},
"type": "object"
},
"InputConfig": {
"description": "The input content",
"id": "InputConfig",
"properties": {
"gcsSource": {
"$ref": "GcsSource",
"description": "Google Cloud Storage location where input content is located."
}
},
"type": "object"
},
"Instance": {
"description": "A Google Cloud Redis instance.",
"id": "Instance",
"properties": {
"alternativeLocationId": {
"description": "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.",
"type": "string"
},
"authorizedNetwork": {
"description": "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.",
"type": "string"
},
"connectMode": {
"description": "Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.",
"enum": [
"CONNECT_MODE_UNSPECIFIED",
"DIRECT_PEERING",
"PRIVATE_SERVICE_ACCESS"
],
"enumDescriptions": [
"Not set.",
"Connect via direct peering to the Memorystore for Redis hosted service.",
"Connect your Memorystore for Redis instance using Private Service Access. Private services access provides an IP address range for multiple Google Cloud services, including Memorystore."
],
"type": "string"
},
"createTime": {
"description": "Output only. The time the instance was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"currentLocationId": {
"description": "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.",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "An arbitrary and optional user-provided name for the instance.",
"type": "string"
},
"host": {
"description": "Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.",
"readOnly": true,
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Resource labels to represent user provided metadata",
"type": "object"
},
"locationId": {
"description": "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.",
"type": "string"
},
"memorySizeGb": {
"description": "Required. Redis memory size in GiB.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "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.",
"type": "string"
},
"persistenceIamIdentity": {
"description": "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.",
"readOnly": true,
"type": "string"
},
"port": {
"description": "Output only. The port number of the exposed Redis endpoint.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"redisConfigs": {
"additionalProperties": {
"type": "string"
},
"description": "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",
"type": "object"
},
"redisVersion": {
"description": "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",
"type": "string"
},
"reservedIpRange": {
"description": "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.",
"type": "string"
},
"state": {
"description": "Output only. The current state of this instance.",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"READY",
"UPDATING",
"DELETING",
"REPAIRING",
"MAINTENANCE",
"IMPORTING",
"FAILING_OVER"
],
"enumDescriptions": [
"Not set.",
"Redis instance is being created.",
"Redis instance has been created and is fully usable.",
"Redis instance configuration is being updated. Certain kinds of updates may cause the instance to become unusable while the update is in progress.",
"Redis instance is being deleted.",
"Redis instance is being repaired and may be unusable.",
"Maintenance is being performed on this Redis instance.",
"Redis instance is importing data (availability may be affected).",
"Redis instance is failing over (availability may be affected)."
],
"readOnly": true,
"type": "string"
},
"statusMessage": {
"description": "Output only. Additional information about the current status of this instance, if available.",
"readOnly": true,
"type": "string"
},
"tier": {
"description": "Required. The service tier of the instance.",
"enum": [
"TIER_UNSPECIFIED",
"BASIC",
"STANDARD_HA"
],
"enumDescriptions": [
"Not set.",
"BASIC tier: standalone instance",
"STANDARD_HA tier: highly available primary/replica instances"
],
"type": "string"
}
},
"type": "object"
},
"ListInstancesResponse": {
"description": "Response for ListInstances.",
"id": "ListInstancesResponse",
"properties": {
"instances": {
"description": "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 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\".",
"items": {
"$ref": "Instance"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "ListLocationsResponse",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
}
},
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"id": "Location",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"locationId": {
"description": "Resource ID for the region. For example: \"us-east1\".",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance.",
"type": "object"
},
"name": {
"description": "Full resource name for the region. For example: \"projects/example-project/locations/us-east1\".",
"type": "string"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"properties": {
"done": {
"description": "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.",
"type": "boolean"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "{ `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. }",
"type": "object"
},
"name": {
"description": "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}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "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`.",
"type": "object"
}
},
"type": "object"
},
"OutputConfig": {
"description": "The output content",
"id": "OutputConfig",
"properties": {
"gcsDestination": {
"$ref": "GcsDestination",
"description": "Google Cloud Storage destination for output content."
}
},
"type": "object"
},
"Status": {
"description": "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).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "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.",
"type": "string"
}
},
"type": "object"
},
"UpgradeInstanceRequest": {
"description": "Request for UpgradeInstance.",
"id": "UpgradeInstanceRequest",
"properties": {
"redisVersion": {
"description": "Required. Specifies the target version of Redis software to upgrade to.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Google Cloud Memorystore for Redis API",
"version": "v1",
"version_module": true
}