Class protos.google.cloud.discoveryengine.v1beta.CloudSqlSource (1.7.0)

Represents a CloudSqlSource.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1beta.ICloudSqlSource);

Constructs a new CloudSqlSource.

Parameter
NameDescription
properties ICloudSqlSource

Properties to set

Properties

databaseId

public databaseId: string;

CloudSqlSource databaseId.

gcsStagingDir

public gcsStagingDir: string;

CloudSqlSource gcsStagingDir.

instanceId

public instanceId: string;

CloudSqlSource instanceId.

offload

public offload: boolean;

CloudSqlSource offload.

projectId

public projectId: string;

CloudSqlSource projectId.

tableId

public tableId: string;

CloudSqlSource tableId.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1beta.ICloudSqlSource): google.cloud.discoveryengine.v1beta.CloudSqlSource;

Creates a new CloudSqlSource instance using the specified properties.

Parameter
NameDescription
properties ICloudSqlSource

Properties to set

Returns
TypeDescription
CloudSqlSource

CloudSqlSource instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1beta.CloudSqlSource;

Decodes a CloudSqlSource 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
CloudSqlSource

CloudSqlSource

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1beta.CloudSqlSource;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
CloudSqlSource

CloudSqlSource

encode(message, writer)

public static encode(message: google.cloud.discoveryengine.v1beta.ICloudSqlSource, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CloudSqlSource message. Does not implicitly messages.

Parameters
NameDescription
message ICloudSqlSource

CloudSqlSource 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.discoveryengine.v1beta.ICloudSqlSource, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ICloudSqlSource

CloudSqlSource 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.discoveryengine.v1beta.CloudSqlSource;

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

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

Plain object

Returns
TypeDescription
CloudSqlSource

CloudSqlSource

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CloudSqlSource

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message CloudSqlSource

CloudSqlSource

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 CloudSqlSource 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