Configures and manages Cloud Memorystore for Memcached instances.
The memcache.googleapis.com
service implements the Google Cloud Memorystore for Memcached API and defines the following resource model for managing Memorystore Memcached (also called Memcached below) instances: * The service works with a collection of cloud projects, named: /projects/*
* Each project has a collection of available locations, named: /locations/*
* Each location has a collection of Memcached instances, named: /instances/*
* As such, Memcached instances are resources of the form: /projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note that location_id must be a GCP region
; for example: * projects/my-memcached-project/locations/us-central1/instances/my-memcached
v1beta2
Package
@google-cloud/memcacheConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of CloudMemcacheClient.
opts
ClientOptions
gaxInstance
typeof gax
| typeof fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new CloudMemcacheClient({fallback: true}, gax); ```
Properties
apiEndpoint
get
apiEndpoint
()
:
string
;
The DNS address for this API service.
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath.
auth
auth
:
gax
.
GoogleAuth
;
cloudMemcacheStub
cloudMemcacheStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
descriptors
descriptors
:
Descriptors
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
locationsClient
locationsClient
:
LocationsClient
;
operationsClient
operationsClient
:
gax
.
OperationsClient
;
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
universeDomain
get
universeDomain
()
:
string
;
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
applyParameters(request, options)
applyParameters
(
request
?:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IApplyParametersRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
ApplyParameters
restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.
request
options
Promise
<[ LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the Memcached instance for which parameter group updates
* should be applied.
*/
// const name = 'abc123'
/**
* Nodes to which the instance-level parameter group is applied.
*/
// const nodeIds = ['abc','def']
/**
* Whether to apply instance-level parameter group to all nodes. If set to
* true, users are restricted from specifying individual nodes, and
* `ApplyParameters` updates all nodes within the instance.
*/
// const applyAll = true
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callApplyParameters
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
memcacheClient
.
applyParameters
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callApplyParameters
();
applyParameters(request, options, callback)
applyParameters
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IApplyParametersRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
applyParameters(request, callback)
applyParameters
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IApplyParametersRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
applySoftwareUpdate(request, options)
applySoftwareUpdate
(
request
?:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IApplySoftwareUpdateRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Updates software on the selected nodes of the Instance.
request
options
Promise
<[ LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the Memcached instance for which software update should be
* applied.
*/
// const instance = 'abc123'
/**
* Nodes to which we should apply the update to. Note all the selected nodes
* are updated in parallel.
*/
// const nodeIds = ['abc','def']
/**
* Whether to apply the update to all nodes. If set to
* true, will explicitly restrict users from specifying any nodes, and apply
* software update to all nodes (where applicable) within the instance.
*/
// const applyAll = true
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callApplySoftwareUpdate
()
{
// Construct request
const
request
=
{
instance
,
};
// Run request
const
[
operation
]
=
await
memcacheClient
.
applySoftwareUpdate
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callApplySoftwareUpdate
();
applySoftwareUpdate(request, options, callback)
applySoftwareUpdate
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IApplySoftwareUpdateRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
applySoftwareUpdate(request, callback)
applySoftwareUpdate
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IApplySoftwareUpdateRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
cancelOperation(request, optionsOrCallback, callback)
cancelOperation
(
request
:
protos
.
google
.
longrunning
.
CancelOperationRequest
,
optionsOrCallback
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
longrunning
.
CancelOperationRequest
,
protos
.
google
.
protobuf
.
Empty
,
{}
|
undefined
|
null
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
CancelOperationRequest
,
protos
.
google
.
protobuf
.
Empty
,
{}
|
undefined
|
null
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
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 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 value with a of 1, corresponding to Code.CANCELLED
.
request
optionsOrCallback
CallOptions
| Callback
< protos.google.longrunning.CancelOperationRequest
, protos.google.protobuf.Empty
, {} | undefined | null>
callback
Callback
< protos.google.longrunning.CancelOperationRequest
, protos.google.protobuf.Empty
, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
await
client
.
cancelOperation
({
name
:
''
});
checkApplyParametersProgress(name)
checkApplyParametersProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
Instance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
OperationMetadata
>> ;
Check the status of the long running operation returned by applyParameters()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.memcache.v1beta2.Instance
, protos.google.cloud.memcache.v1beta2.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the Memcached instance for which parameter group updates
* should be applied.
*/
// const name = 'abc123'
/**
* Nodes to which the instance-level parameter group is applied.
*/
// const nodeIds = ['abc','def']
/**
* Whether to apply instance-level parameter group to all nodes. If set to
* true, users are restricted from specifying individual nodes, and
* `ApplyParameters` updates all nodes within the instance.
*/
// const applyAll = true
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callApplyParameters
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
memcacheClient
.
applyParameters
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callApplyParameters
();
checkApplySoftwareUpdateProgress(name)
checkApplySoftwareUpdateProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
Instance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
OperationMetadata
>> ;
Check the status of the long running operation returned by applySoftwareUpdate()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.memcache.v1beta2.Instance
, protos.google.cloud.memcache.v1beta2.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the Memcached instance for which software update should be
* applied.
*/
// const instance = 'abc123'
/**
* Nodes to which we should apply the update to. Note all the selected nodes
* are updated in parallel.
*/
// const nodeIds = ['abc','def']
/**
* Whether to apply the update to all nodes. If set to
* true, will explicitly restrict users from specifying any nodes, and apply
* software update to all nodes (where applicable) within the instance.
*/
// const applyAll = true
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callApplySoftwareUpdate
()
{
// Construct request
const
request
=
{
instance
,
};
// Run request
const
[
operation
]
=
await
memcacheClient
.
applySoftwareUpdate
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callApplySoftwareUpdate
();
checkCreateInstanceProgress(name)
checkCreateInstanceProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
Instance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createInstance()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.memcache.v1beta2.Instance
, protos.google.cloud.memcache.v1beta2.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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
*/
// const parent = 'abc123'
/**
* Required. The logical name of the Memcached instance in the user
* 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 user project / location.
* If any of the above are not met, the API raises an invalid argument error.
*/
// const instanceId = 'abc123'
/**
* Required. A Memcached Instance resource
*/
// const resource = {}
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callCreateInstance
()
{
// Construct request
const
request
=
{
parent
,
instanceId
,
resource
,
};
// Run request
const
[
operation
]
=
await
memcacheClient
.
createInstance
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateInstance
();
checkDeleteInstanceProgress(name)
checkDeleteInstanceProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteInstance()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.protobuf.Empty
, protos.google.cloud.memcache.v1beta2.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Memcached instance resource name in the format:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a GCP region
*/
// const name = 'abc123'
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callDeleteInstance
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
memcacheClient
.
deleteInstance
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteInstance
();
checkRescheduleMaintenanceProgress(name)
checkRescheduleMaintenanceProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
Instance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
OperationMetadata
>> ;
Check the status of the long running operation returned by rescheduleMaintenance()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.memcache.v1beta2.Instance
, protos.google.cloud.memcache.v1beta2.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Memcache instance resource name using the form:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a GCP region.
*/
// const instance = 'abc123'
/**
* Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
*/
// const rescheduleType = {}
/**
* Timestamp when the maintenance shall be rescheduled to if
* reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for
* example `2012-11-15T16:19:00.094Z`.
*/
// const scheduleTime = {}
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callRescheduleMaintenance
()
{
// Construct request
const
request
=
{
instance
,
rescheduleType
,
};
// Run request
const
[
operation
]
=
await
memcacheClient
.
rescheduleMaintenance
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callRescheduleMaintenance
();
checkUpdateInstanceProgress(name)
checkUpdateInstanceProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
Instance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateInstance()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.memcache.v1beta2.Instance
, protos.google.cloud.memcache.v1beta2.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Mask of fields to update.
* * `displayName`
*/
// const updateMask = {}
/**
* Required. A Memcached Instance resource.
* Only fields specified in update_mask are updated.
*/
// const resource = {}
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callUpdateInstance
()
{
// Construct request
const
request
=
{
updateMask
,
resource
,
};
// Run request
const
[
operation
]
=
await
memcacheClient
.
updateInstance
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateInstance
();
checkUpdateParametersProgress(name)
checkUpdateParametersProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
Instance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateParameters()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.memcache.v1beta2.Instance
, protos.google.cloud.memcache.v1beta2.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the Memcached instance for which the parameters should be
* updated.
*/
// const name = 'abc123'
/**
* Required. Mask of fields to update.
*/
// const updateMask = {}
/**
* The parameters to apply to the instance.
*/
// const parameters = {}
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callUpdateParameters
()
{
// Construct request
const
request
=
{
name
,
updateMask
,
};
// Run request
const
[
operation
]
=
await
memcacheClient
.
updateParameters
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateParameters
();
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
createInstance(request, options)
createInstance
(
request
?:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
ICreateInstanceRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Creates a new Instance in a given location.
request
options
Promise
<[ LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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
*/
// const parent = 'abc123'
/**
* Required. The logical name of the Memcached instance in the user
* 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 user project / location.
* If any of the above are not met, the API raises an invalid argument error.
*/
// const instanceId = 'abc123'
/**
* Required. A Memcached Instance resource
*/
// const resource = {}
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callCreateInstance
()
{
// Construct request
const
request
=
{
parent
,
instanceId
,
resource
,
};
// Run request
const
[
operation
]
=
await
memcacheClient
.
createInstance
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateInstance
();
createInstance(request, options, callback)
createInstance
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
ICreateInstanceRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createInstance(request, callback)
createInstance
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
ICreateInstanceRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteInstance(request, options)
deleteInstance
(
request
?:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IDeleteInstanceRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Deletes a single Instance.
request
options
Promise
<[ LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Memcached instance resource name in the format:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a GCP region
*/
// const name = 'abc123'
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callDeleteInstance
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
memcacheClient
.
deleteInstance
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteInstance
();
deleteInstance(request, options, callback)
deleteInstance
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IDeleteInstanceRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteInstance(request, callback)
deleteInstance
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IDeleteInstanceRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteOperation(request, optionsOrCallback, callback)
deleteOperation
(
request
:
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
optionsOrCallback
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
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
.
request
optionsOrCallback
CallOptions
| Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.DeleteOperationRequest
, {} | null | undefined>
callback
Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.DeleteOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
await
client
.
deleteOperation
({
name
:
''
});
getInstance(request, options)
getInstance
(
request
?:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IGetInstanceRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IGetInstanceRequest
|
undefined
,
{}
|
undefined
]>;
Gets details of a single Instance.
request
options
Promise
<[ protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IGetInstanceRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Memcached instance resource name in the format:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a GCP region
*/
// const name = 'abc123'
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callGetInstance
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
memcacheClient
.
getInstance
(
request
);
console
.
log
(
response
);
}
callGetInstance
();
getInstance(request, options, callback)
getInstance
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IGetInstanceRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IGetInstanceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IGetInstanceRequest
| null | undefined, {} | null | undefined>
void
getInstance(request, callback)
getInstance
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IGetInstanceRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IGetInstanceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IGetInstanceRequest
| null | undefined, {} | null | undefined>
void
getLocation(request, options, callback)
getLocation
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
,
options
?:
gax
.
CallOptions
|
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Gets information about a location.
request
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.cloud.location.ILocation
, google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Call options. See CallOptions for more details.
callback
Callback
< google.cloud.location.ILocation
, google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Promise
< google.cloud.location.ILocation
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
const
[
response
]
=
await
client
.
getLocation
(
request
);
getOperation(request, optionsOrCallback, callback)
getOperation
(
request
:
protos
.
google
.
longrunning
.
GetOperationRequest
,
optionsOrCallback
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise
< [
protos
.
google
.
longrunning
.
Operation
]>;
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.
request
optionsOrCallback
CallOptions
| Callback
< protos.google.longrunning.Operation
, protos.google.longrunning.GetOperationRequest
, {} | null | undefined>
callback
Callback
< protos.google.longrunning.Operation
, protos.google.longrunning.GetOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
const
name
=
''
;
const
[
response
]
=
await
client
.
getOperation
({
name
});
// doThingsWith(response)
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
instancePath(project, location, instance)
instancePath
(
project
:
string
,
location
:
string
,
instance
:
string
)
:
string
;
Return a fully-qualified instance resource name string.
project
string
location
string
instance
string
string
{string} Resource name string.
listInstances(request, options)
listInstances
(
request
?:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IListInstancesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
[],
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IListInstancesRequest
|
null
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IListInstancesResponse
]>;
Lists Instances in a given location.
request
options
Promise
<[ protos.google.cloud.memcache.v1beta2.IInstance
[], protos.google.cloud.memcache.v1beta2.IListInstancesRequest
| null, protos.google.cloud.memcache.v1beta2.IListInstancesResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listInstancesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listInstances(request, options, callback)
listInstances
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IListInstancesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IListInstancesRequest
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IListInstancesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.memcache.v1beta2.IListInstancesRequest
, protos.google.cloud.memcache.v1beta2.IListInstancesResponse
| null | undefined, protos.google.cloud.memcache.v1beta2.IInstance
>
void
listInstances(request, callback)
listInstances
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IListInstancesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IListInstancesRequest
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IListInstancesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.memcache.v1beta2.IListInstancesRequest
, protos.google.cloud.memcache.v1beta2.IListInstancesResponse
| null | undefined, protos.google.cloud.memcache.v1beta2.IInstance
>
void
listInstancesAsync(request, options)
listInstancesAsync
(
request
?:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IListInstancesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
> ;
Equivalent to listInstances
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.memcache.v1beta2.IInstance
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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
*/
// const parent = 'abc123'
/**
* 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` google.cloud.memcache.v1beta2.ListInstancesResponse.next_page_token
* to determine if there are more instances left to be queried.
*/
// const pageSize = 1234
/**
* The `next_page_token` value returned from a previous List request, if any.
*/
// const pageToken = 'abc123'
/**
* List filter. For example, exclude all Memcached instances with name as
* my-instance by specifying `"name != my-instance"`.
*/
// const filter = 'abc123'
/**
* Sort results. Supported values are "name", "name desc" or "" (unsorted).
*/
// const orderBy = 'abc123'
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callListInstances
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
memcacheClient
.
listInstancesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListInstances
();
listInstancesStream(request, options)
listInstancesStream
(
request
?:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IListInstancesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to listInstances
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listInstancesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listLocationsAsync(request, options)
listLocationsAsync
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IListLocationsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Lists information about the supported locations for this service. Returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent.
options
AsyncIterable
< google.cloud.location.ILocation
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
const
iterable
=
client
.
listLocationsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
// process response
}
listOperationsAsync(request, options)
listOperationsAsync
(
request
:
protos
.
google
.
longrunning
.
ListOperationsRequest
,
options
?:
gax
.
CallOptions
)
:
AsyncIterable<protos
.
google
.
longrunning
.
IOperation
> ;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
request
options
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
AsyncIterable
< protos.google.longrunning.IOperation
>
{Object} An iterable Object that conforms to iteration protocols .
const
client
=
longrunning
.
operationsClient
();
for
await
(
const
response
of
client
.
listOperationsAsync
(
request
));
// doThingsWith(response)
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
project
string
location
string
string
{string} Resource name string.
matchInstanceFromInstanceName(instanceName)
matchInstanceFromInstanceName
(
instanceName
:
string
)
:
string
|
number
;
Parse the instance from Instance resource.
instanceName
string
A fully-qualified path representing Instance resource.
string | number
{string} A string representing the instance.
matchLocationFromInstanceName(instanceName)
matchLocationFromInstanceName
(
instanceName
:
string
)
:
string
|
number
;
Parse the location from Instance resource.
instanceName
string
A fully-qualified path representing Instance resource.
string | number
{string} A string representing the location.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the location.
matchProjectFromInstanceName(instanceName)
matchProjectFromInstanceName
(
instanceName
:
string
)
:
string
|
number
;
Parse the project from Instance resource.
instanceName
string
A fully-qualified path representing Instance resource.
string | number
{string} A string representing the project.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the project.
rescheduleMaintenance(request, options)
rescheduleMaintenance
(
request
?:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IRescheduleMaintenanceRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Performs the apply phase of the RescheduleMaintenance verb.
request
options
Promise
<[ LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Memcache instance resource name using the form:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a GCP region.
*/
// const instance = 'abc123'
/**
* Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
*/
// const rescheduleType = {}
/**
* Timestamp when the maintenance shall be rescheduled to if
* reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for
* example `2012-11-15T16:19:00.094Z`.
*/
// const scheduleTime = {}
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callRescheduleMaintenance
()
{
// Construct request
const
request
=
{
instance
,
rescheduleType
,
};
// Run request
const
[
operation
]
=
await
memcacheClient
.
rescheduleMaintenance
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callRescheduleMaintenance
();
rescheduleMaintenance(request, options, callback)
rescheduleMaintenance
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IRescheduleMaintenanceRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
rescheduleMaintenance(request, callback)
rescheduleMaintenance
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IRescheduleMaintenanceRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateInstance(request, options)
updateInstance
(
request
?:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IUpdateInstanceRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Updates an existing Instance in a given project and location.
request
options
Promise
<[ LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Mask of fields to update.
* * `displayName`
*/
// const updateMask = {}
/**
* Required. A Memcached Instance resource.
* Only fields specified in update_mask are updated.
*/
// const resource = {}
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callUpdateInstance
()
{
// Construct request
const
request
=
{
updateMask
,
resource
,
};
// Run request
const
[
operation
]
=
await
memcacheClient
.
updateInstance
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateInstance
();
updateInstance(request, options, callback)
updateInstance
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IUpdateInstanceRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateInstance(request, callback)
updateInstance
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IUpdateInstanceRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateParameters(request, options)
updateParameters
(
request
?:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IUpdateParametersRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Updates the defined Memcached parameters for an existing instance. This method only stages the parameters, it must be followed by ApplyParameters
to apply the parameters to nodes of the Memcached instance.
request
options
Promise
<[ LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Resource name of the Memcached instance for which the parameters should be
* updated.
*/
// const name = 'abc123'
/**
* Required. Mask of fields to update.
*/
// const updateMask = {}
/**
* The parameters to apply to the instance.
*/
// const parameters = {}
// Imports the Memcache library
const
{
CloudMemcacheClient
}
=
require
(
' @google-cloud/memcache
'
).
v1beta2
;
// Instantiates a client
const
memcacheClient
=
new
CloudMemcacheClient
();
async
function
callUpdateParameters
()
{
// Construct request
const
request
=
{
name
,
updateMask
,
};
// Run request
const
[
operation
]
=
await
memcacheClient
.
updateParameters
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateParameters
();
updateParameters(request, options, callback)
updateParameters
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IUpdateParametersRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateParameters(request, callback)
updateParameters
(
request
:
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IUpdateParametersRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IInstance
,
protos
.
google
.
cloud
.
memcache
.
v1beta2
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.memcache.v1beta2.IInstance
, protos.google.cloud.memcache.v1beta2.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void