Class protos.google.cloud.discoveryengine.v1beta.TargetSite (1.9.0)

Represents a TargetSite.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

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

Constructs a new TargetSite.

Parameter
Name Description
properties ITargetSite

Properties to set

Properties

exactMatch

public exactMatch: boolean;

TargetSite exactMatch.

failureReason

public failureReason?: (google.cloud.discoveryengine.v1beta.TargetSite.IFailureReason|null);

TargetSite failureReason.

generatedUriPattern

public generatedUriPattern: string;

TargetSite generatedUriPattern.

indexingStatus

public indexingStatus: (google.cloud.discoveryengine.v1beta.TargetSite.IndexingStatus|keyof typeof google.cloud.discoveryengine.v1beta.TargetSite.IndexingStatus);

TargetSite indexingStatus.

name

public name: string;

TargetSite name.

providedUriPattern

public providedUriPattern: string;

TargetSite providedUriPattern.

rootDomainUri

public rootDomainUri: string;

TargetSite rootDomainUri.

siteVerificationInfo

public siteVerificationInfo?: (google.cloud.discoveryengine.v1beta.ISiteVerificationInfo|null);

TargetSite siteVerificationInfo.

type

public type: (google.cloud.discoveryengine.v1beta.TargetSite.Type|keyof typeof google.cloud.discoveryengine.v1beta.TargetSite.Type);

TargetSite type.

updateTime

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

TargetSite updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1beta.ITargetSite): google.cloud.discoveryengine.v1beta.TargetSite;

Creates a new TargetSite instance using the specified properties.

Parameter
Name Description
properties ITargetSite

Properties to set

Returns
Type Description
TargetSite

TargetSite instance

decode(reader, length)

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

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

TargetSite

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
TargetSite

TargetSite

encode(message, writer)

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

Encodes the specified TargetSite message. Does not implicitly messages.

Parameters
Name Description
message ITargetSite

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

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

Parameters
Name Description
message ITargetSite

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

Creates a TargetSite 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
TargetSite

TargetSite

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TargetSite

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message TargetSite

TargetSite

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