Class protos.google.cloud.datacatalog.v1.SearchCatalogRequest.Scope

Represents a Scope.

Package

@google-cloud/datacatalog!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datacatalog.v1.SearchCatalogRequest.IScope);

Constructs a new Scope.

Parameter
TypeNameDescription
IScopeproperties

Properties to set

Properties

includeGcpPublicDatasets

public includeGcpPublicDatasets: boolean;

Scope includeGcpPublicDatasets.

Property Value
TypeDescription
boolean

includeOrgIds

public includeOrgIds: string[];

Scope includeOrgIds.

Property Value
TypeDescription
string[]

includeProjectIds

public includeProjectIds: string[];

Scope includeProjectIds.

Property Value
TypeDescription
string[]

restrictedLocations

public restrictedLocations: string[];

Scope restrictedLocations.

Property Value
TypeDescription
string[]

Methods

create(properties)

public static create(properties?: google.cloud.datacatalog.v1.SearchCatalogRequest.IScope): google.cloud.datacatalog.v1.SearchCatalogRequest.Scope;

Creates a new Scope instance using the specified properties.

Parameter
TypeNameDescription
IScopeproperties

Properties to set

Returns
TypeDescription
google.cloud.datacatalog.v1.SearchCatalogRequest.Scope

Scope instance

decode(reader, length)

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

Decodes a Scope message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.cloud.datacatalog.v1.SearchCatalogRequest.Scope

Scope

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datacatalog.v1.SearchCatalogRequest.Scope;

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

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.datacatalog.v1.SearchCatalogRequest.Scope

Scope

encode(message, writer)

public static encode(message: google.cloud.datacatalog.v1.SearchCatalogRequest.IScope, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Scope message. Does not implicitly messages.

Parameters
TypeNameDescription
IScopemessage

Scope message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.datacatalog.v1.SearchCatalogRequest.IScope, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
TypeNameDescription
IScopemessage

Scope message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.datacatalog.v1.SearchCatalogRequest.Scope;

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

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

Plain object

Returns
TypeDescription
google.cloud.datacatalog.v1.SearchCatalogRequest.Scope

Scope

toJSON()

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

Converts this Scope to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.cloud.datacatalog.v1.SearchCatalogRequest.Scopemessage

Scope

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a Scope message.

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

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not