Service describing handlers for resources v1
Package
@google-cloud/memorystoreConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of MemorystoreClient.
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 MemorystoreClient({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
;
descriptors
descriptors
:
Descriptors
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
locationsClient
locationsClient
:
LocationsClient
;
memorystoreStub
memorystoreStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
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
cancelOperation(request, options, callback)
cancelOperation
(
request
:
protos
.
google
.
longrunning
.
CancelOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
CancelOperationRequest
,
{}
|
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
options
CallOptions
| Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.CancelOperationRequest
, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
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
:
''
});
certificateAuthorityPath(project, location, instance)
certificateAuthorityPath
(
project
:
string
,
location
:
string
,
instance
:
string
)
:
string
;
Return a fully-qualified certificateAuthority resource name string.
project
string
location
string
instance
string
string
{string} Resource name string.
checkCreateInstanceProgress(name)
checkCreateInstanceProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
memorystore
.
v1
.
Instance
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
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.memorystore.v1.Instance
, protos.google.cloud.memorystore.v1.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 parent resource where this instance will be created.
* Format: projects/{project}/locations/{location}
*/
// const parent = 'abc123'
/**
* Required. The ID to use for the instance, which will become the final
* component of the instance's resource name.
* This value is subject to the following restrictions:
* * Must be 4-63 characters in length
* * Must begin with a letter or digit
* * Must contain only lowercase letters, digits, and hyphens
* * Must not end with a hyphen
* * Must be unique within a location
*/
// const instanceId = 'abc123'
/**
* Required. The instance to create.
*/
// const instance = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Memorystore library
const
{
MemorystoreClient
}
=
require
(
' @google-cloud/memorystore
'
).
v1
;
// Instantiates a client
const
memorystoreClient
=
new
MemorystoreClient
();
async
function
callCreateInstance
()
{
// Construct request
const
request
=
{
parent
,
instanceId
,
instance
,
};
// Run request
const
[
operation
]
=
await
memorystoreClient
.
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
.
memorystore
.
v1
.
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.memorystore.v1.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 name of the instance to delete.
* Format: projects/{project}/locations/{location}/instances/{instance}
*/
// const name = 'abc123'
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Memorystore library
const
{
MemorystoreClient
}
=
require
(
' @google-cloud/memorystore
'
).
v1
;
// Instantiates a client
const
memorystoreClient
=
new
MemorystoreClient
();
async
function
callDeleteInstance
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
memorystoreClient
.
deleteInstance
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteInstance
();
checkUpdateInstanceProgress(name)
checkUpdateInstanceProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
memorystore
.
v1
.
Instance
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
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.memorystore.v1.Instance
, protos.google.cloud.memorystore.v1.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.
*/
/**
* Optional. The list of fields to be updated on the instance. At least one
* field must be specified.
*/
// const updateMask = {}
/**
* Required. The instance to update.
*/
// const instance = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Memorystore library
const
{
MemorystoreClient
}
=
require
(
' @google-cloud/memorystore
'
).
v1
;
// Instantiates a client
const
memorystoreClient
=
new
MemorystoreClient
();
async
function
callUpdateInstance
()
{
// Construct request
const
request
=
{
instance
,
};
// Run request
const
[
operation
]
=
await
memorystoreClient
.
updateInstance
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateInstance
();
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
.
memorystore
.
v1
.
ICreateInstanceRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
memorystore
.
v1
.
IInstance
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Creates a new Instance in a given project and location.
request
options
Promise
<[ LROperation
< protos.google.cloud.memorystore.v1.IInstance
, protos.google.cloud.memorystore.v1.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 parent resource where this instance will be created.
* Format: projects/{project}/locations/{location}
*/
// const parent = 'abc123'
/**
* Required. The ID to use for the instance, which will become the final
* component of the instance's resource name.
* This value is subject to the following restrictions:
* * Must be 4-63 characters in length
* * Must begin with a letter or digit
* * Must contain only lowercase letters, digits, and hyphens
* * Must not end with a hyphen
* * Must be unique within a location
*/
// const instanceId = 'abc123'
/**
* Required. The instance to create.
*/
// const instance = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Memorystore library
const
{
MemorystoreClient
}
=
require
(
' @google-cloud/memorystore
'
).
v1
;
// Instantiates a client
const
memorystoreClient
=
new
MemorystoreClient
();
async
function
callCreateInstance
()
{
// Construct request
const
request
=
{
parent
,
instanceId
,
instance
,
};
// Run request
const
[
operation
]
=
await
memorystoreClient
.
createInstance
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateInstance
();
createInstance(request, options, callback)
createInstance
(
request
:
protos
.
google
.
cloud
.
memorystore
.
v1
.
ICreateInstanceRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memorystore
.
v1
.
IInstance
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.memorystore.v1.IInstance
, protos.google.cloud.memorystore.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createInstance(request, callback)
createInstance
(
request
:
protos
.
google
.
cloud
.
memorystore
.
v1
.
ICreateInstanceRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memorystore
.
v1
.
IInstance
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.memorystore.v1.IInstance
, protos.google.cloud.memorystore.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteInstance(request, options)
deleteInstance
(
request
?:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IDeleteInstanceRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Deletes a single Instance.
request
options
Promise
<[ LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.memorystore.v1.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 name of the instance to delete.
* Format: projects/{project}/locations/{location}/instances/{instance}
*/
// const name = 'abc123'
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Memorystore library
const
{
MemorystoreClient
}
=
require
(
' @google-cloud/memorystore
'
).
v1
;
// Instantiates a client
const
memorystoreClient
=
new
MemorystoreClient
();
async
function
callDeleteInstance
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
memorystoreClient
.
deleteInstance
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteInstance
();
deleteInstance(request, options, callback)
deleteInstance
(
request
:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IDeleteInstanceRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.memorystore.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteInstance(request, callback)
deleteInstance
(
request
:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IDeleteInstanceRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.memorystore.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteOperation(request, options, callback)
deleteOperation
(
request
:
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
options
?:
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
options
CallOptions
| Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.DeleteOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
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
:
''
});
forwardingRulePath(project, region, forwardingRule)
forwardingRulePath
(
project
:
string
,
region
:
string
,
forwardingRule
:
string
)
:
string
;
Return a fully-qualified forwardingRule resource name string.
project
string
region
string
forwardingRule
string
string
{string} Resource name string.
getCertificateAuthority(request, options)
getCertificateAuthority
(
request
?:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IGetCertificateAuthorityRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
memorystore
.
v1
.
ICertificateAuthority
,
(
protos
.
google
.
cloud
.
memorystore
.
v1
.
IGetCertificateAuthorityRequest
|
undefined
),
{}
|
undefined
]>;
Gets details about the certificate authority for an Instance.
request
options
Promise
<[ protos.google.cloud.memorystore.v1.ICertificateAuthority
,
( protos.google.cloud.memorystore.v1.IGetCertificateAuthorityRequest
| 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. The name of the certificate authority.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/certificateAuthority
*/
// const name = 'abc123'
// Imports the Memorystore library
const
{
MemorystoreClient
}
=
require
(
' @google-cloud/memorystore
'
).
v1
;
// Instantiates a client
const
memorystoreClient
=
new
MemorystoreClient
();
async
function
callGetCertificateAuthority
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
memorystoreClient
.
getCertificateAuthority
(
request
);
console
.
log
(
response
);
}
callGetCertificateAuthority
();
getCertificateAuthority(request, options, callback)
getCertificateAuthority
(
request
:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IGetCertificateAuthorityRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
memorystore
.
v1
.
ICertificateAuthority
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IGetCertificateAuthorityRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.memorystore.v1.ICertificateAuthority
, protos.google.cloud.memorystore.v1.IGetCertificateAuthorityRequest
| null | undefined, {} | null | undefined>
void
getCertificateAuthority(request, callback)
getCertificateAuthority
(
request
:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IGetCertificateAuthorityRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
memorystore
.
v1
.
ICertificateAuthority
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IGetCertificateAuthorityRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.memorystore.v1.ICertificateAuthority
, protos.google.cloud.memorystore.v1.IGetCertificateAuthorityRequest
| null | undefined, {} | null | undefined>
void
getInstance(request, options)
getInstance
(
request
?:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IGetInstanceRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
memorystore
.
v1
.
IInstance
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IGetInstanceRequest
|
undefined
,
{}
|
undefined
]>;
Gets details of a single Instance.
request
options
Promise
<[ protos.google.cloud.memorystore.v1.IInstance
, protos.google.cloud.memorystore.v1.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. The name of the instance to retrieve.
* Format: projects/{project}/locations/{location}/instances/{instance}
*/
// const name = 'abc123'
// Imports the Memorystore library
const
{
MemorystoreClient
}
=
require
(
' @google-cloud/memorystore
'
).
v1
;
// Instantiates a client
const
memorystoreClient
=
new
MemorystoreClient
();
async
function
callGetInstance
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
memorystoreClient
.
getInstance
(
request
);
console
.
log
(
response
);
}
callGetInstance
();
getInstance(request, options, callback)
getInstance
(
request
:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IGetInstanceRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
memorystore
.
v1
.
IInstance
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IGetInstanceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.memorystore.v1.IInstance
, protos.google.cloud.memorystore.v1.IGetInstanceRequest
| null | undefined, {} | null | undefined>
void
getInstance(request, callback)
getInstance
(
request
:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IGetInstanceRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
memorystore
.
v1
.
IInstance
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IGetInstanceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.memorystore.v1.IInstance
, protos.google.cloud.memorystore.v1.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, options, callback)
getOperation
(
request
:
protos
.
google
.
longrunning
.
GetOperationRequest
,
options
?:
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
options
CallOptions
| Callback
< protos.google.longrunning.Operation
, protos.google.longrunning.GetOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
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
.
memorystore
.
v1
.
IListInstancesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
memorystore
.
v1
.
IInstance
[],
protos
.
google
.
cloud
.
memorystore
.
v1
.
IListInstancesRequest
|
null
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IListInstancesResponse
]>;
Lists Instances in a given project and location.
request
options
Promise
<[ protos.google.cloud.memorystore.v1.IInstance
[], protos.google.cloud.memorystore.v1.IListInstancesRequest
| null, protos.google.cloud.memorystore.v1.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
.
memorystore
.
v1
.
IListInstancesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
memorystore
.
v1
.
IListInstancesRequest
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IListInstancesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IInstance
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.memorystore.v1.IListInstancesRequest
, protos.google.cloud.memorystore.v1.IListInstancesResponse
| null | undefined, protos.google.cloud.memorystore.v1.IInstance
>
void
listInstances(request, callback)
listInstances
(
request
:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IListInstancesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
memorystore
.
v1
.
IListInstancesRequest
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IListInstancesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IInstance
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.memorystore.v1.IListInstancesRequest
, protos.google.cloud.memorystore.v1.IListInstancesResponse
| null | undefined, protos.google.cloud.memorystore.v1.IInstance
>
void
listInstancesAsync(request, options)
listInstancesAsync
(
request
?:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IListInstancesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
memorystore
.
v1
.
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.memorystore.v1.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 parent to list instances from.
* Format: projects/{project}/locations/{location}
*/
// const parent = 'abc123'
/**
* Optional. Requested page size. Server may return fewer items than
* requested. If unspecified, server will pick an appropriate default.
*/
// const pageSize = 1234
/**
* Optional. A token identifying a page of results the server should return.
*/
// const pageToken = 'abc123'
/**
* Optional. Expression for filtering results.
*/
// const filter = 'abc123'
/**
* Optional. Sort results by a defined order. Supported values: "name",
* "create_time".
*/
// const orderBy = 'abc123'
// Imports the Memorystore library
const
{
MemorystoreClient
}
=
require
(
' @google-cloud/memorystore
'
).
v1
;
// Instantiates a client
const
memorystoreClient
=
new
MemorystoreClient
();
async
function
callListInstances
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
memorystoreClient
.
listInstancesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListInstances
();
listInstancesStream(request, options)
listInstancesStream
(
request
?:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IListInstancesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, 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
.
ListOperationsResponse
> ;
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.ListOperationsResponse
>
{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.
matchForwardingRuleFromForwardingRuleName(forwardingRuleName)
matchForwardingRuleFromForwardingRuleName
(
forwardingRuleName
:
string
)
:
string
|
number
;
Parse the forwarding_rule from ForwardingRule resource.
forwardingRuleName
string
A fully-qualified path representing ForwardingRule resource.
string | number
{string} A string representing the forwarding_rule.
matchInstanceFromCertificateAuthorityName(certificateAuthorityName)
matchInstanceFromCertificateAuthorityName
(
certificateAuthorityName
:
string
)
:
string
|
number
;
Parse the instance from CertificateAuthority resource.
certificateAuthorityName
string
A fully-qualified path representing CertificateAuthority resource.
string | number
{string} A string representing the instance.
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.
matchLocationFromCertificateAuthorityName(certificateAuthorityName)
matchLocationFromCertificateAuthorityName
(
certificateAuthorityName
:
string
)
:
string
|
number
;
Parse the location from CertificateAuthority resource.
certificateAuthorityName
string
A fully-qualified path representing CertificateAuthority resource.
string | number
{string} A string representing the location.
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.
matchNetworkFromNetworkName(networkName)
matchNetworkFromNetworkName
(
networkName
:
string
)
:
string
|
number
;
Parse the network from Network resource.
networkName
string
A fully-qualified path representing Network resource.
string | number
{string} A string representing the network.
matchProjectFromCertificateAuthorityName(certificateAuthorityName)
matchProjectFromCertificateAuthorityName
(
certificateAuthorityName
:
string
)
:
string
|
number
;
Parse the project from CertificateAuthority resource.
certificateAuthorityName
string
A fully-qualified path representing CertificateAuthority resource.
string | number
{string} A string representing the project.
matchProjectFromForwardingRuleName(forwardingRuleName)
matchProjectFromForwardingRuleName
(
forwardingRuleName
:
string
)
:
string
|
number
;
Parse the project from ForwardingRule resource.
forwardingRuleName
string
A fully-qualified path representing ForwardingRule resource.
string | number
{string} A string representing the project.
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.
matchProjectFromNetworkName(networkName)
matchProjectFromNetworkName
(
networkName
:
string
)
:
string
|
number
;
Parse the project from Network resource.
networkName
string
A fully-qualified path representing Network resource.
string | number
{string} A string representing the project.
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
projectName
string
A fully-qualified path representing Project resource.
string | number
{string} A string representing the project.
matchProjectFromServiceAttachmentName(serviceAttachmentName)
matchProjectFromServiceAttachmentName
(
serviceAttachmentName
:
string
)
:
string
|
number
;
Parse the project from ServiceAttachment resource.
serviceAttachmentName
string
A fully-qualified path representing ServiceAttachment resource.
string | number
{string} A string representing the project.
matchRegionFromForwardingRuleName(forwardingRuleName)
matchRegionFromForwardingRuleName
(
forwardingRuleName
:
string
)
:
string
|
number
;
Parse the region from ForwardingRule resource.
forwardingRuleName
string
A fully-qualified path representing ForwardingRule resource.
string | number
{string} A string representing the region.
matchRegionFromServiceAttachmentName(serviceAttachmentName)
matchRegionFromServiceAttachmentName
(
serviceAttachmentName
:
string
)
:
string
|
number
;
Parse the region from ServiceAttachment resource.
serviceAttachmentName
string
A fully-qualified path representing ServiceAttachment resource.
string | number
{string} A string representing the region.
matchServiceAttachmentFromServiceAttachmentName(serviceAttachmentName)
matchServiceAttachmentFromServiceAttachmentName
(
serviceAttachmentName
:
string
)
:
string
|
number
;
Parse the service_attachment from ServiceAttachment resource.
serviceAttachmentName
string
A fully-qualified path representing ServiceAttachment resource.
string | number
{string} A string representing the service_attachment.
networkPath(project, network)
networkPath
(
project
:
string
,
network
:
string
)
:
string
;
Return a fully-qualified network resource name string.
project
string
network
string
string
{string} Resource name string.
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
project
string
string
{string} Resource name string.
serviceAttachmentPath(project, region, serviceAttachment)
serviceAttachmentPath
(
project
:
string
,
region
:
string
,
serviceAttachment
:
string
)
:
string
;
Return a fully-qualified serviceAttachment resource name string.
project
string
region
string
serviceAttachment
string
string
{string} Resource name string.
updateInstance(request, options)
updateInstance
(
request
?:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IUpdateInstanceRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
memorystore
.
v1
.
IInstance
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Updates the parameters of a single Instance.
request
options
Promise
<[ LROperation
< protos.google.cloud.memorystore.v1.IInstance
, protos.google.cloud.memorystore.v1.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.
*/
/**
* Optional. The list of fields to be updated on the instance. At least one
* field must be specified.
*/
// const updateMask = {}
/**
* Required. The instance to update.
*/
// const instance = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Memorystore library
const
{
MemorystoreClient
}
=
require
(
' @google-cloud/memorystore
'
).
v1
;
// Instantiates a client
const
memorystoreClient
=
new
MemorystoreClient
();
async
function
callUpdateInstance
()
{
// Construct request
const
request
=
{
instance
,
};
// Run request
const
[
operation
]
=
await
memorystoreClient
.
updateInstance
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateInstance
();
updateInstance(request, options, callback)
updateInstance
(
request
:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IUpdateInstanceRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memorystore
.
v1
.
IInstance
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.memorystore.v1.IInstance
, protos.google.cloud.memorystore.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateInstance(request, callback)
updateInstance
(
request
:
protos
.
google
.
cloud
.
memorystore
.
v1
.
IUpdateInstanceRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
memorystore
.
v1
.
IInstance
,
protos
.
google
.
cloud
.
memorystore
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.memorystore.v1.IInstance
, protos.google.cloud.memorystore.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
