Class protos.google.cloud.netapp.v1.Replication (0.2.1)

Represents a Replication.

Package

@google-cloud/netapp

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.netapp.v1.IReplication);

Constructs a new Replication.

Parameter
NameDescription
properties IReplication

Properties to set

Properties

_description

public _description?: "description";

Replication _description.

_healthy

public _healthy?: "healthy";

Replication _healthy.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Replication createTime.

description

public description?: (string|null);

Replication description.

destinationVolume

public destinationVolume: string;

Replication destinationVolume.

destinationVolumeParameters

public destinationVolumeParameters?: (google.cloud.netapp.v1.IDestinationVolumeParameters|null);

Replication destinationVolumeParameters.

healthy

public healthy?: (boolean|null);

Replication healthy.

labels

public labels: { [k: string]: string };

Replication labels.

mirrorState

public mirrorState: (google.cloud.netapp.v1.Replication.MirrorState|keyof typeof google.cloud.netapp.v1.Replication.MirrorState);

Replication mirrorState.

name

public name: string;

Replication name.

replicationSchedule

public replicationSchedule: (google.cloud.netapp.v1.Replication.ReplicationSchedule|keyof typeof google.cloud.netapp.v1.Replication.ReplicationSchedule);

Replication replicationSchedule.

role

public role: (google.cloud.netapp.v1.Replication.ReplicationRole|keyof typeof google.cloud.netapp.v1.Replication.ReplicationRole);

Replication role.

sourceVolume

public sourceVolume: string;

Replication sourceVolume.

state

public state: (google.cloud.netapp.v1.Replication.State|keyof typeof google.cloud.netapp.v1.Replication.State);

Replication state.

stateDetails

public stateDetails: string;

Replication stateDetails.

transferStats

public transferStats?: (google.cloud.netapp.v1.ITransferStats|null);

Replication transferStats.

Methods

create(properties)

public static create(properties?: google.cloud.netapp.v1.IReplication): google.cloud.netapp.v1.Replication;

Creates a new Replication instance using the specified properties.

Parameter
NameDescription
properties IReplication

Properties to set

Returns
TypeDescription
Replication

Replication instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.netapp.v1.Replication;

Decodes a Replication message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
Replication

Replication

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.netapp.v1.Replication;

Decodes a Replication message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Replication

Replication

encode(message, writer)

public static encode(message: google.cloud.netapp.v1.IReplication, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Replication message. Does not implicitly messages.

Parameters
NameDescription
message IReplication

Replication message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.netapp.v1.IReplication, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Replication message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IReplication

Replication message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.netapp.v1.Replication;

Creates a Replication message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
Replication

Replication

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Replication

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this Replication to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.netapp.v1.Replication, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Replication message. Also converts values to other types if specified.

Parameters
NameDescription
message Replication

Replication

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Replication message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not