blob: fe019a377e457567ad6e5aa23b3dab8a6c6dde79 [file] [log] [blame]
{
"clientLibrary": {
"name": "cloud.google.com/go/redis/apiv1",
"version": "1.14.0",
"language": "GO",
"apis": [
{
"id": "google.cloud.redis.v1",
"version": "v1"
}
]
},
"snippets": [
{
"regionTag": "redis_v1_generated_CloudRedis_CancelOperation_sync",
"title": "redis CancelOperation Sample",
"description": "CancelOperation is a utility method from google.longrunning.Operations.",
"file": "CloudRedisClient/CancelOperation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CancelOperation",
"fullName": "google.cloud.redis.v1.CloudRedisClient.CancelOperation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.CancelOperationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "CancelOperation",
"fullName": "google.longrunning.Operations.CancelOperation",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 51,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_CreateInstance_sync",
"title": "redis CreateInstance Sample",
"description": "CreateInstance creates a Redis instance based on the specified tier and memory size.\n\nBy default, the instance is accessible from the project's\n[default network](https: //cloud.google.com/vpc/docs/vpc).\n\nThe creation is executed asynchronously and callers may check the returned\noperation to track its progress. Once the operation is completed the Redis\ninstance will be fully functional. Completed longrunning.Operation will\ncontain the new instance object in the response field.\n\nThe returned operation is automatically deleted after a few hours, so there\nis no need to call DeleteOperation.",
"file": "CloudRedisClient/CreateInstance/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CreateInstance",
"fullName": "google.cloud.redis.v1.CloudRedisClient.CreateInstance",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "redispb.CreateInstanceRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "CreateInstanceOperation",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "CreateInstance",
"fullName": "google.cloud.redis.v1.CloudRedis.CreateInstance",
"service": {
"shortName": "CloudRedis",
"fullName": "google.cloud.redis.v1.CloudRedis"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 58,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_DeleteInstance_sync",
"title": "redis DeleteInstance Sample",
"description": "DeleteInstance deletes a specific Redis instance. Instance stops serving and data is\ndeleted.",
"file": "CloudRedisClient/DeleteInstance/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeleteInstance",
"fullName": "google.cloud.redis.v1.CloudRedisClient.DeleteInstance",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "redispb.DeleteInstanceRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "DeleteInstanceOperation",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "DeleteInstance",
"fullName": "google.cloud.redis.v1.CloudRedis.DeleteInstance",
"service": {
"shortName": "CloudRedis",
"fullName": "google.cloud.redis.v1.CloudRedis"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 56,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_DeleteOperation_sync",
"title": "redis DeleteOperation Sample",
"description": "DeleteOperation is a utility method from google.longrunning.Operations.",
"file": "CloudRedisClient/DeleteOperation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeleteOperation",
"fullName": "google.cloud.redis.v1.CloudRedisClient.DeleteOperation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.DeleteOperationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "DeleteOperation",
"fullName": "google.longrunning.Operations.DeleteOperation",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 51,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_ExportInstance_sync",
"title": "redis ExportInstance Sample",
"description": "ExportInstance export Redis instance data into a Redis RDB format file in Cloud Storage.\n\nRedis will continue serving during this operation.\n\nThe returned operation is automatically deleted after a few hours, so\nthere is no need to call DeleteOperation.",
"file": "CloudRedisClient/ExportInstance/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ExportInstance",
"fullName": "google.cloud.redis.v1.CloudRedisClient.ExportInstance",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "redispb.ExportInstanceRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "ExportInstanceOperation",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "ExportInstance",
"fullName": "google.cloud.redis.v1.CloudRedis.ExportInstance",
"service": {
"shortName": "CloudRedis",
"fullName": "google.cloud.redis.v1.CloudRedis"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 58,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_FailoverInstance_sync",
"title": "redis FailoverInstance Sample",
"description": "FailoverInstance initiates a failover of the primary node to current replica node for a\nspecific STANDARD tier Cloud Memorystore for Redis instance.",
"file": "CloudRedisClient/FailoverInstance/main.go",
"language": "GO",
"clientMethod": {
"shortName": "FailoverInstance",
"fullName": "google.cloud.redis.v1.CloudRedisClient.FailoverInstance",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "redispb.FailoverInstanceRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "FailoverInstanceOperation",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "FailoverInstance",
"fullName": "google.cloud.redis.v1.CloudRedis.FailoverInstance",
"service": {
"shortName": "CloudRedis",
"fullName": "google.cloud.redis.v1.CloudRedis"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 58,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_GetInstance_sync",
"title": "redis GetInstance Sample",
"description": "GetInstance gets the details of a specific Redis instance.",
"file": "CloudRedisClient/GetInstance/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetInstance",
"fullName": "google.cloud.redis.v1.CloudRedisClient.GetInstance",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "redispb.GetInstanceRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*redispb.Instance",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "GetInstance",
"fullName": "google.cloud.redis.v1.CloudRedis.GetInstance",
"service": {
"shortName": "CloudRedis",
"fullName": "google.cloud.redis.v1.CloudRedis"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_GetInstanceAuthString_sync",
"title": "redis GetInstanceAuthString Sample",
"description": "GetInstanceAuthString gets the AUTH string for a Redis instance. If AUTH is not enabled for the\ninstance the response will be empty. This information is not included in\nthe details returned to GetInstance.",
"file": "CloudRedisClient/GetInstanceAuthString/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetInstanceAuthString",
"fullName": "google.cloud.redis.v1.CloudRedisClient.GetInstanceAuthString",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "redispb.GetInstanceAuthStringRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*redispb.InstanceAuthString",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "GetInstanceAuthString",
"fullName": "google.cloud.redis.v1.CloudRedis.GetInstanceAuthString",
"service": {
"shortName": "CloudRedis",
"fullName": "google.cloud.redis.v1.CloudRedis"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_GetLocation_sync",
"title": "redis GetLocation Sample",
"description": "GetLocation gets information about a location.",
"file": "CloudRedisClient/GetLocation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetLocation",
"fullName": "google.cloud.redis.v1.CloudRedisClient.GetLocation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "locationpb.GetLocationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*locationpb.Location",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "GetLocation",
"fullName": "google.cloud.location.Locations.GetLocation",
"service": {
"shortName": "Locations",
"fullName": "google.cloud.location.Locations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_GetOperation_sync",
"title": "redis GetOperation Sample",
"description": "GetOperation is a utility method from google.longrunning.Operations.",
"file": "CloudRedisClient/GetOperation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetOperation",
"fullName": "google.cloud.redis.v1.CloudRedisClient.GetOperation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.GetOperationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*longrunningpb.Operation",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "GetOperation",
"fullName": "google.longrunning.Operations.GetOperation",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_ImportInstance_sync",
"title": "redis ImportInstance Sample",
"description": "ImportInstance import a Redis RDB snapshot file from Cloud Storage into a Redis instance.\n\nRedis may stop serving during this operation. Instance state will be\nIMPORTING for entire operation. When complete, the instance will contain\nonly data from the imported file.\n\nThe returned operation is automatically deleted after a few hours, so\nthere is no need to call DeleteOperation.",
"file": "CloudRedisClient/ImportInstance/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ImportInstance",
"fullName": "google.cloud.redis.v1.CloudRedisClient.ImportInstance",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "redispb.ImportInstanceRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "ImportInstanceOperation",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "ImportInstance",
"fullName": "google.cloud.redis.v1.CloudRedis.ImportInstance",
"service": {
"shortName": "CloudRedis",
"fullName": "google.cloud.redis.v1.CloudRedis"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 58,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_ListInstances_sync",
"title": "redis ListInstances Sample",
"description": "ListInstances lists all Redis instances owned by a project in either the specified\nlocation (region) or all locations.\n\nThe location should have the following format: \n\n* `projects/{project_id}/locations/{location_id}`\n\nIf `location_id` is specified as `-` (wildcard), then all regions\navailable to the project are queried, and the results are aggregated.",
"file": "CloudRedisClient/ListInstances/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListInstances",
"fullName": "google.cloud.redis.v1.CloudRedisClient.ListInstances",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "redispb.ListInstancesRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "InstanceIterator",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "ListInstances",
"fullName": "google.cloud.redis.v1.CloudRedis.ListInstances",
"service": {
"shortName": "CloudRedis",
"fullName": "google.cloud.redis.v1.CloudRedis"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 60,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_ListLocations_sync",
"title": "redis ListLocations Sample",
"description": "ListLocations lists information about the supported locations for this service.",
"file": "CloudRedisClient/ListLocations/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListLocations",
"fullName": "google.cloud.redis.v1.CloudRedisClient.ListLocations",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "locationpb.ListLocationsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "LocationIterator",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "ListLocations",
"fullName": "google.cloud.location.Locations.ListLocations",
"service": {
"shortName": "Locations",
"fullName": "google.cloud.location.Locations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 60,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_ListOperations_sync",
"title": "redis ListOperations Sample",
"description": "ListOperations is a utility method from google.longrunning.Operations.",
"file": "CloudRedisClient/ListOperations/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListOperations",
"fullName": "google.cloud.redis.v1.CloudRedisClient.ListOperations",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.ListOperationsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "OperationIterator",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "ListOperations",
"fullName": "google.longrunning.Operations.ListOperations",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 60,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_RescheduleMaintenance_sync",
"title": "redis RescheduleMaintenance Sample",
"description": "RescheduleMaintenance reschedule maintenance for a given instance in a given project and\nlocation.",
"file": "CloudRedisClient/RescheduleMaintenance/main.go",
"language": "GO",
"clientMethod": {
"shortName": "RescheduleMaintenance",
"fullName": "google.cloud.redis.v1.CloudRedisClient.RescheduleMaintenance",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "redispb.RescheduleMaintenanceRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "RescheduleMaintenanceOperation",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "RescheduleMaintenance",
"fullName": "google.cloud.redis.v1.CloudRedis.RescheduleMaintenance",
"service": {
"shortName": "CloudRedis",
"fullName": "google.cloud.redis.v1.CloudRedis"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 58,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_UpdateInstance_sync",
"title": "redis UpdateInstance Sample",
"description": "UpdateInstance updates the metadata and configuration of a specific Redis instance.\n\nCompleted longrunning.Operation will contain the new instance object\nin the response field. The returned operation is automatically deleted\nafter a few hours, so there is no need to call DeleteOperation.",
"file": "CloudRedisClient/UpdateInstance/main.go",
"language": "GO",
"clientMethod": {
"shortName": "UpdateInstance",
"fullName": "google.cloud.redis.v1.CloudRedisClient.UpdateInstance",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "redispb.UpdateInstanceRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "UpdateInstanceOperation",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "UpdateInstance",
"fullName": "google.cloud.redis.v1.CloudRedis.UpdateInstance",
"service": {
"shortName": "CloudRedis",
"fullName": "google.cloud.redis.v1.CloudRedis"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 58,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedis_UpgradeInstance_sync",
"title": "redis UpgradeInstance Sample",
"description": "UpgradeInstance upgrades Redis instance to the newer Redis version specified in the\nrequest.",
"file": "CloudRedisClient/UpgradeInstance/main.go",
"language": "GO",
"clientMethod": {
"shortName": "UpgradeInstance",
"fullName": "google.cloud.redis.v1.CloudRedisClient.UpgradeInstance",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "redispb.UpgradeInstanceRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "UpgradeInstanceOperation",
"client": {
"shortName": "CloudRedisClient",
"fullName": "google.cloud.redis.v1.CloudRedisClient"
},
"method": {
"shortName": "UpgradeInstance",
"fullName": "google.cloud.redis.v1.CloudRedis.UpgradeInstance",
"service": {
"shortName": "CloudRedis",
"fullName": "google.cloud.redis.v1.CloudRedis"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 58,
"type": "FULL"
}
]
}
]
}