Represents a SearchCatalogRequest.
Package
@google-cloud/datacatalogConstructors
(constructor)(properties)
constructor(properties?: google.cloud.datacatalog.v1.ISearchCatalogRequest);
Constructs a new SearchCatalogRequest.
Parameter | |
---|---|
Name | Description |
properties |
ISearchCatalogRequest
Properties to set |
Properties
adminSearch
public adminSearch: boolean;
SearchCatalogRequest adminSearch.
orderBy
public orderBy: string;
SearchCatalogRequest orderBy.
pageSize
public pageSize: number;
SearchCatalogRequest pageSize.
pageToken
public pageToken: string;
SearchCatalogRequest pageToken.
query
public query: string;
SearchCatalogRequest query.
scope
public scope?: (google.cloud.datacatalog.v1.SearchCatalogRequest.IScope|null);
SearchCatalogRequest scope.
Methods
create(properties)
public static create(properties?: google.cloud.datacatalog.v1.ISearchCatalogRequest): google.cloud.datacatalog.v1.SearchCatalogRequest;
Creates a new SearchCatalogRequest instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
ISearchCatalogRequest
Properties to set |
Returns | |
---|---|
Type | Description |
SearchCatalogRequest |
SearchCatalogRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datacatalog.v1.SearchCatalogRequest;
Decodes a SearchCatalogRequest 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 |
SearchCatalogRequest |
SearchCatalogRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datacatalog.v1.SearchCatalogRequest;
Decodes a SearchCatalogRequest message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
SearchCatalogRequest |
SearchCatalogRequest |
encode(message, writer)
public static encode(message: google.cloud.datacatalog.v1.ISearchCatalogRequest, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified SearchCatalogRequest message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ISearchCatalogRequest
SearchCatalogRequest 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.datacatalog.v1.ISearchCatalogRequest, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified SearchCatalogRequest message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ISearchCatalogRequest
SearchCatalogRequest 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.datacatalog.v1.SearchCatalogRequest;
Creates a SearchCatalogRequest 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 |
SearchCatalogRequest |
SearchCatalogRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for SearchCatalogRequest
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 SearchCatalogRequest to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.datacatalog.v1.SearchCatalogRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a SearchCatalogRequest message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
SearchCatalogRequest
SearchCatalogRequest |
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 SearchCatalogRequest message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|