blob: 0a118ebe649c846870db281b45db680866877be3 [file] [log] [blame]
{
"clientLibrary": {
"name": "cloud.google.com/go/redis/cluster/apiv1",
"version": "1.14.0",
"language": "GO",
"apis": [
{
"id": "google.cloud.redis.cluster.v1",
"version": "v1"
}
]
},
"snippets": [
{
"regionTag": "redis_v1_generated_CloudRedisCluster_CancelOperation_sync",
"title": "redis CancelOperation Sample",
"description": "CancelOperation is a utility method from google.longrunning.Operations.",
"file": "CloudRedisClusterClient/CancelOperation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CancelOperation",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient.CancelOperation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.CancelOperationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "CloudRedisClusterClient",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient"
},
"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_CloudRedisCluster_CreateCluster_sync",
"title": "redis CreateCluster Sample",
"description": "CreateCluster creates a Redis cluster based on the specified properties.\nThe creation is executed asynchronously and callers may check the returned\noperation to track its progress. Once the operation is completed the Redis\ncluster will be fully functional. The completed longrunning.Operation will\ncontain the new cluster 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": "CloudRedisClusterClient/CreateCluster/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CreateCluster",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient.CreateCluster",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "clusterpb.CreateClusterRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "CreateClusterOperation",
"client": {
"shortName": "CloudRedisClusterClient",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient"
},
"method": {
"shortName": "CreateCluster",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisCluster.CreateCluster",
"service": {
"shortName": "CloudRedisCluster",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisCluster"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 58,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedisCluster_DeleteCluster_sync",
"title": "redis DeleteCluster Sample",
"description": "DeleteCluster deletes a specific Redis cluster. Cluster stops serving and data is\ndeleted.",
"file": "CloudRedisClusterClient/DeleteCluster/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeleteCluster",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient.DeleteCluster",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "clusterpb.DeleteClusterRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "DeleteClusterOperation",
"client": {
"shortName": "CloudRedisClusterClient",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient"
},
"method": {
"shortName": "DeleteCluster",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisCluster.DeleteCluster",
"service": {
"shortName": "CloudRedisCluster",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisCluster"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 56,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedisCluster_DeleteOperation_sync",
"title": "redis DeleteOperation Sample",
"description": "DeleteOperation is a utility method from google.longrunning.Operations.",
"file": "CloudRedisClusterClient/DeleteOperation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeleteOperation",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient.DeleteOperation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.DeleteOperationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "CloudRedisClusterClient",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient"
},
"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_CloudRedisCluster_GetCluster_sync",
"title": "redis GetCluster Sample",
"description": "GetCluster gets the details of a specific Redis cluster.",
"file": "CloudRedisClusterClient/GetCluster/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetCluster",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient.GetCluster",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "clusterpb.GetClusterRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*clusterpb.Cluster",
"client": {
"shortName": "CloudRedisClusterClient",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient"
},
"method": {
"shortName": "GetCluster",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisCluster.GetCluster",
"service": {
"shortName": "CloudRedisCluster",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisCluster"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedisCluster_GetLocation_sync",
"title": "redis GetLocation Sample",
"description": "GetLocation gets information about a location.",
"file": "CloudRedisClusterClient/GetLocation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetLocation",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient.GetLocation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "locationpb.GetLocationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*locationpb.Location",
"client": {
"shortName": "CloudRedisClusterClient",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient"
},
"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_CloudRedisCluster_GetOperation_sync",
"title": "redis GetOperation Sample",
"description": "GetOperation is a utility method from google.longrunning.Operations.",
"file": "CloudRedisClusterClient/GetOperation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetOperation",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient.GetOperation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.GetOperationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*longrunningpb.Operation",
"client": {
"shortName": "CloudRedisClusterClient",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient"
},
"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_CloudRedisCluster_ListClusters_sync",
"title": "redis ListClusters Sample",
"description": "ListClusters lists all Redis clusters 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": "CloudRedisClusterClient/ListClusters/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListClusters",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient.ListClusters",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "clusterpb.ListClustersRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "ClusterIterator",
"client": {
"shortName": "CloudRedisClusterClient",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient"
},
"method": {
"shortName": "ListClusters",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisCluster.ListClusters",
"service": {
"shortName": "CloudRedisCluster",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisCluster"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 60,
"type": "FULL"
}
]
},
{
"regionTag": "redis_v1_generated_CloudRedisCluster_ListLocations_sync",
"title": "redis ListLocations Sample",
"description": "ListLocations lists information about the supported locations for this service.",
"file": "CloudRedisClusterClient/ListLocations/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListLocations",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient.ListLocations",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "locationpb.ListLocationsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "LocationIterator",
"client": {
"shortName": "CloudRedisClusterClient",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient"
},
"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_CloudRedisCluster_ListOperations_sync",
"title": "redis ListOperations Sample",
"description": "ListOperations is a utility method from google.longrunning.Operations.",
"file": "CloudRedisClusterClient/ListOperations/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListOperations",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient.ListOperations",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.ListOperationsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "OperationIterator",
"client": {
"shortName": "CloudRedisClusterClient",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient"
},
"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_CloudRedisCluster_UpdateCluster_sync",
"title": "redis UpdateCluster Sample",
"description": "UpdateCluster updates the metadata and configuration of a specific Redis cluster.\n\nCompleted longrunning.Operation will contain the new cluster object\nin the response field. The returned operation is automatically deleted\nafter a few hours, so there is no need to call DeleteOperation.",
"file": "CloudRedisClusterClient/UpdateCluster/main.go",
"language": "GO",
"clientMethod": {
"shortName": "UpdateCluster",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient.UpdateCluster",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "clusterpb.UpdateClusterRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "UpdateClusterOperation",
"client": {
"shortName": "CloudRedisClusterClient",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisClusterClient"
},
"method": {
"shortName": "UpdateCluster",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisCluster.UpdateCluster",
"service": {
"shortName": "CloudRedisCluster",
"fullName": "google.cloud.redis.cluster.v1.CloudRedisCluster"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 58,
"type": "FULL"
}
]
}
]
}