Class protos.google.cloud.filestore.v1beta1.Instance (4.0.1)

Represents an Instance.

Package

@google-cloud/filestore

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.filestore.v1beta1.IInstance);

Constructs a new Instance.

Parameter
Name Description
properties IInstance

Properties to set

Properties

capacityGb

public capacityGb: (number|Long|string);

Instance capacityGb.

capacityStepSizeGb

public capacityStepSizeGb: (number|Long|string);

Instance capacityStepSizeGb.

createTime

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

Instance createTime.

customPerformanceSupported

public customPerformanceSupported: boolean;

Instance customPerformanceSupported.

deletionProtectionEnabled

public deletionProtectionEnabled: boolean;

Instance deletionProtectionEnabled.

deletionProtectionReason

public deletionProtectionReason: string;

Instance deletionProtectionReason.

description

public description: string;

Instance description.

directoryServices

public directoryServices?: (google.cloud.filestore.v1beta1.IDirectoryServicesConfig|null);

Instance directoryServices.

etag

public etag: string;

Instance etag.

fileShares

public fileShares: google.cloud.filestore.v1beta1.IFileShareConfig[];

Instance fileShares.

kmsKeyName

public kmsKeyName: string;

Instance kmsKeyName.

labels

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

Instance labels.

maxCapacityGb

public maxCapacityGb: (number|Long|string);

Instance maxCapacityGb.

maxShareCount

public maxShareCount: (number|Long|string);

Instance maxShareCount.

multiShareEnabled

public multiShareEnabled: boolean;

Instance multiShareEnabled.

name

public name: string;

Instance name.

networks

public networks: google.cloud.filestore.v1beta1.INetworkConfig[];

Instance networks.

performanceConfig

public performanceConfig?: (google.cloud.filestore.v1beta1.Instance.IPerformanceConfig|null);

Instance performanceConfig.

performanceLimits

public performanceLimits?: (google.cloud.filestore.v1beta1.Instance.IPerformanceLimits|null);

Instance performanceLimits.

protocol

public protocol: (google.cloud.filestore.v1beta1.Instance.FileProtocol|keyof typeof google.cloud.filestore.v1beta1.Instance.FileProtocol);

Instance protocol.

replication

public replication?: (google.cloud.filestore.v1beta1.IReplication|null);

Instance replication.

satisfiesPzi

public satisfiesPzi: boolean;

Instance satisfiesPzi.

satisfiesPzs

public satisfiesPzs?: (google.protobuf.IBoolValue|null);

Instance satisfiesPzs.

state

public state: (google.cloud.filestore.v1beta1.Instance.State|keyof typeof google.cloud.filestore.v1beta1.Instance.State);

Instance state.

statusMessage

public statusMessage: string;

Instance statusMessage.

suspensionReasons

public suspensionReasons: google.cloud.filestore.v1beta1.Instance.SuspensionReason[];

Instance suspensionReasons.

tags

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

Instance tags.

tier

public tier: (google.cloud.filestore.v1beta1.Instance.Tier|keyof typeof google.cloud.filestore.v1beta1.Instance.Tier);

Instance tier.

Methods

create(properties)

public static create(properties?: google.cloud.filestore.v1beta1.IInstance): google.cloud.filestore.v1beta1.Instance;

Creates a new Instance instance using the specified properties.

Parameter
Name Description
properties IInstance

Properties to set
Returns
Type Description
Instance

Instance instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.filestore.v1beta1.Instance;

Decodes an Instance 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
Instance

Instance

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.filestore.v1beta1.Instance;

Decodes an Instance message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
Instance

Instance

encode(message, writer)

public static encode(message: google.cloud.filestore.v1beta1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Instance message. Does not implicitly messages.

Parameters
Name Description
message IInstance

Instance 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.filestore.v1beta1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IInstance

Instance 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.filestore.v1beta1.Instance;

Creates an Instance 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
Instance

Instance

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Instance

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 Instance to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Instance

Instance
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 an Instance message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not