Class protos.google.cloud.datafusion.v1beta1.Instance (2.2.2)

Represents an Instance.

Package

Constructors

(constructor)(properties)

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

Constructs a new Instance.

Parameter
Name	Description
`properties`	`IInstance` Properties to set

Properties

accelerators

public accelerators: google.cloud.datafusion.v1beta1.IAccelerator[];

Instance accelerators.

apiEndpoint

public apiEndpoint: string;

Instance apiEndpoint.

availableVersion

public availableVersion: google.cloud.datafusion.v1beta1.IVersion[];

Instance availableVersion.

createTime

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

Instance createTime.

cryptoKeyConfig

public cryptoKeyConfig?: (google.cloud.datafusion.v1beta1.ICryptoKeyConfig|null);

Instance cryptoKeyConfig.

dataprocServiceAccount

public dataprocServiceAccount: string;

Instance dataprocServiceAccount.

description

public description: string;

Instance description.

disabledReason

public disabledReason: google.cloud.datafusion.v1beta1.Instance.DisabledReason[];

Instance disabledReason.

displayName

public displayName: string;

Instance displayName.

enableRbac

public enableRbac: boolean;

Instance enableRbac.

enableStackdriverLogging

public enableStackdriverLogging: boolean;

Instance enableStackdriverLogging.

enableStackdriverMonitoring

public enableStackdriverMonitoring: boolean;

Instance enableStackdriverMonitoring.

gcsBucket

public gcsBucket: string;

Instance gcsBucket.

labels

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

Instance labels.

name

public name: string;

Instance name.

networkConfig

public networkConfig?: (google.cloud.datafusion.v1beta1.INetworkConfig|null);

Instance networkConfig.

options

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

Instance options.

p4ServiceAccount

public p4ServiceAccount: string;

Instance p4ServiceAccount.

privateInstance

public privateInstance: boolean;

Instance privateInstance.

serviceAccount

public serviceAccount: string;

Instance serviceAccount.

serviceEndpoint

public serviceEndpoint: string;

Instance serviceEndpoint.

state

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

Instance state.

stateMessage

public stateMessage: string;

Instance stateMessage.

tenantProjectId

public tenantProjectId: string;

Instance tenantProjectId.

type

public type: (google.cloud.datafusion.v1beta1.Instance.Type|keyof typeof google.cloud.datafusion.v1beta1.Instance.Type);

Instance type.

updateTime

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

Instance updateTime.

version

public version: string;

Instance version.

zone

public zone: string;

Instance zone.

Methods

create(properties)

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

Creates a new Instance instance using the specified properties.

Parameter
Name	Description
`properties`	`IInstance` Properties to set

Returns
Type	Description
`google.cloud.datafusion.v1beta1.Instance`	Instance instance

decode(reader, length)

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

Decodes an Instance message from the specified reader or buffer.

Parameters
Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns
Type	Description
`google.cloud.datafusion.v1beta1.Instance`	Instance

decodeDelimited(reader)

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

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

Parameter
Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`google.cloud.datafusion.v1beta1.Instance`	Instance

encode(message, writer)

public static encode(message: google.cloud.datafusion.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.datafusion.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.datafusion.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
`google.cloud.datafusion.v1beta1.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.datafusion.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`	`google.cloud.datafusion.v1beta1.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