Represents a DataStore.
Package
@google-cloud/discoveryengineConstructors
(constructor)(properties)
constructor(properties?: google.cloud.discoveryengine.v1.IDataStore);Constructs a new DataStore.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDataStore
Properties to set |
Properties
contentConfig
public contentConfig: (google.cloud.discoveryengine.v1.DataStore.ContentConfig|keyof typeof google.cloud.discoveryengine.v1.DataStore.ContentConfig);DataStore contentConfig.
createTime
public createTime?: (google.protobuf.ITimestamp|null);DataStore createTime.
defaultSchemaId
public defaultSchemaId: string;DataStore defaultSchemaId.
displayName
public displayName: string;DataStore displayName.
documentProcessingConfig
public documentProcessingConfig?: (google.cloud.discoveryengine.v1.IDocumentProcessingConfig|null);DataStore documentProcessingConfig.
industryVertical
public industryVertical: (google.cloud.discoveryengine.v1.IndustryVertical|keyof typeof google.cloud.discoveryengine.v1.IndustryVertical);DataStore industryVertical.
name
public name: string;DataStore name.
solutionTypes
public solutionTypes: google.cloud.discoveryengine.v1.SolutionType[];DataStore solutionTypes.
startingSchema
public startingSchema?: (google.cloud.discoveryengine.v1.ISchema|null);DataStore startingSchema.
Methods
create(properties)
public static create(properties?: google.cloud.discoveryengine.v1.IDataStore): google.cloud.discoveryengine.v1.DataStore;Creates a new DataStore instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDataStore
Properties to set |
| Returns | |
|---|---|
| Type | Description |
DataStore |
DataStore instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1.DataStore;Decodes a DataStore 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 |
DataStore |
DataStore |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1.DataStore;Decodes a DataStore message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
DataStore |
DataStore |
encode(message, writer)
public static encode(message: google.cloud.discoveryengine.v1.IDataStore, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DataStore message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDataStore
DataStore 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.v1.IDataStore, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DataStore message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDataStore
DataStore 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.v1.DataStore;Creates a DataStore 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 |
DataStore |
DataStore |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for DataStore
| 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 DataStore to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.discoveryengine.v1.DataStore, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a DataStore message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
DataStore
DataStore |
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 DataStore message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|