Represents a SearchCatalogResult.
Package
@google-cloud/datacatalogConstructors
(constructor)(properties)
constructor(properties?: google.cloud.datacatalog.v1.ISearchCatalogResult);
Constructs a new SearchCatalogResult.
Parameter | |
---|---|
Name | Description |
properties |
ISearchCatalogResult
Properties to set |
Properties
description
public description: string;
SearchCatalogResult description.
displayName
public displayName: string;
SearchCatalogResult displayName.
fullyQualifiedName
public fullyQualifiedName: string;
SearchCatalogResult fullyQualifiedName.
integratedSystem
public integratedSystem?: (google.cloud.datacatalog.v1.IntegratedSystem|keyof typeof google.cloud.datacatalog.v1.IntegratedSystem|null);
SearchCatalogResult integratedSystem.
linkedResource
public linkedResource: string;
SearchCatalogResult linkedResource.
modifyTime
public modifyTime?: (google.protobuf.ITimestamp|null);
SearchCatalogResult modifyTime.
relativeResourceName
public relativeResourceName: string;
SearchCatalogResult relativeResourceName.
searchResultSubtype
public searchResultSubtype: string;
SearchCatalogResult searchResultSubtype.
searchResultType
public searchResultType: (google.cloud.datacatalog.v1.SearchResultType|keyof typeof google.cloud.datacatalog.v1.SearchResultType);
SearchCatalogResult searchResultType.
system
public system?: ("integratedSystem"|"userSpecifiedSystem");
SearchCatalogResult system.
userSpecifiedSystem
public userSpecifiedSystem?: (string|null);
SearchCatalogResult userSpecifiedSystem.
Methods
create(properties)
public static create(properties?: google.cloud.datacatalog.v1.ISearchCatalogResult): google.cloud.datacatalog.v1.SearchCatalogResult;
Creates a new SearchCatalogResult instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
ISearchCatalogResult
Properties to set |
Returns | |
---|---|
Type | Description |
SearchCatalogResult |
SearchCatalogResult instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datacatalog.v1.SearchCatalogResult;
Decodes a SearchCatalogResult 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 |
SearchCatalogResult |
SearchCatalogResult |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datacatalog.v1.SearchCatalogResult;
Decodes a SearchCatalogResult message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
SearchCatalogResult |
SearchCatalogResult |
encode(message, writer)
public static encode(message: google.cloud.datacatalog.v1.ISearchCatalogResult, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified SearchCatalogResult message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ISearchCatalogResult
SearchCatalogResult 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.ISearchCatalogResult, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified SearchCatalogResult message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ISearchCatalogResult
SearchCatalogResult 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.SearchCatalogResult;
Creates a SearchCatalogResult 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 |
SearchCatalogResult |
SearchCatalogResult |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for SearchCatalogResult
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 SearchCatalogResult to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.datacatalog.v1.SearchCatalogResult, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a SearchCatalogResult message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
SearchCatalogResult
SearchCatalogResult |
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 SearchCatalogResult message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|