Represents a BackupCollection.
Package
@google-cloud/memorystoreConstructors
(constructor)(properties)
constructor(properties?: google.cloud.memorystore.v1.IBackupCollection);Constructs a new BackupCollection.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackupCollection
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);BackupCollection createTime.
instance
public instance: string;BackupCollection instance.
instanceUid
public instanceUid: string;BackupCollection instanceUid.
kmsKey
public kmsKey: string;BackupCollection kmsKey.
lastBackupTime
public lastBackupTime?: (google.protobuf.ITimestamp|null);BackupCollection lastBackupTime.
name
public name: string;BackupCollection name.
totalBackupCount
public totalBackupCount: (number|Long|string);BackupCollection totalBackupCount.
totalBackupSizeBytes
public totalBackupSizeBytes: (number|Long|string);BackupCollection totalBackupSizeBytes.
uid
public uid: string;BackupCollection uid.
Methods
create(properties)
public static create(properties?: google.cloud.memorystore.v1.IBackupCollection): google.cloud.memorystore.v1.BackupCollection;Creates a new BackupCollection instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackupCollection
Properties to set |
| Returns | |
|---|---|
| Type | Description |
BackupCollection |
BackupCollection instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.memorystore.v1.BackupCollection;Decodes a BackupCollection message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
BackupCollection |
BackupCollection |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.memorystore.v1.BackupCollection;Decodes a BackupCollection message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
BackupCollection |
BackupCollection |
encode(message, writer)
public static encode(message: google.cloud.memorystore.v1.IBackupCollection, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BackupCollection message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackupCollection
BackupCollection message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.memorystore.v1.IBackupCollection, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BackupCollection message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackupCollection
BackupCollection message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.memorystore.v1.BackupCollection;Creates a BackupCollection message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
BackupCollection |
BackupCollection |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for BackupCollection
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this BackupCollection to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.memorystore.v1.BackupCollection, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a BackupCollection message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
BackupCollection
BackupCollection |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a BackupCollection message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|