Class CreateDataStoreRequest (0.51.0)

public final class CreateDataStoreRequest extends GeneratedMessageV3 implements CreateDataStoreRequestOrBuilder

Request for DataStoreService.CreateDataStore method.

Protobuf type google.cloud.discoveryengine.v1alpha.CreateDataStoreRequest

Static Fields

CREATE_ADVANCED_SITE_SEARCH_FIELD_NUMBER

public static final int CREATE_ADVANCED_SITE_SEARCH_FIELD_NUMBER
Field Value
Type Description
int

DATA_STORE_FIELD_NUMBER

public static final int DATA_STORE_FIELD_NUMBER
Field Value
Type Description
int

DATA_STORE_ID_FIELD_NUMBER

public static final int DATA_STORE_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

SKIP_DEFAULT_SCHEMA_CREATION_FIELD_NUMBER

public static final int SKIP_DEFAULT_SCHEMA_CREATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateDataStoreRequest getDefaultInstance()
Returns
Type Description
CreateDataStoreRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CreateDataStoreRequest.Builder newBuilder()
Returns
Type Description
CreateDataStoreRequest.Builder

newBuilder(CreateDataStoreRequest prototype)

public static CreateDataStoreRequest.Builder newBuilder(CreateDataStoreRequest prototype)
Parameter
Name Description
prototype CreateDataStoreRequest
Returns
Type Description
CreateDataStoreRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateDataStoreRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateDataStoreRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDataStoreRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDataStoreRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateDataStoreRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateDataStoreRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateDataStoreRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDataStoreRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateDataStoreRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateDataStoreRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateDataStoreRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDataStoreRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateDataStoreRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateDataStoreRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDataStoreRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDataStoreRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateDataStoreRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateDataStoreRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDataStoreRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDataStoreRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateDataStoreRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateDataStoreRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateDataStoreRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDataStoreRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateDataStoreRequest> parser()
Returns
Type Description
Parser<CreateDataStoreRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateAdvancedSiteSearch()

public boolean getCreateAdvancedSiteSearch()

A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.

bool create_advanced_site_search = 4;

Returns
Type Description
boolean

The createAdvancedSiteSearch.

getDataStore()

public DataStore getDataStore()

Required. The DataStore to create.

.google.cloud.discoveryengine.v1alpha.DataStore data_store = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DataStore

The dataStore.

getDataStoreId()

public String getDataStoreId()

Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string data_store_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The dataStoreId.

getDataStoreIdBytes()

public ByteString getDataStoreIdBytes()

Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string data_store_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for dataStoreId.

getDataStoreOrBuilder()

public DataStoreOrBuilder getDataStoreOrBuilder()

Required. The DataStore to create.

.google.cloud.discoveryengine.v1alpha.DataStore data_store = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DataStoreOrBuilder

getDefaultInstanceForType()

public CreateDataStoreRequest getDefaultInstanceForType()
Returns
Type Description
CreateDataStoreRequest

getParent()

public String getParent()

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateDataStoreRequest> getParserForType()
Returns
Type Description
Parser<CreateDataStoreRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSkipDefaultSchemaCreation()

public boolean getSkipDefaultSchemaCreation()

A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case.

If set to true, you must manually create a schema for the data store before any documents can be ingested.

This flag cannot be specified if data_store.starting_schema is specified.

bool skip_default_schema_creation = 7;

Returns
Type Description
boolean

The skipDefaultSchemaCreation.

hasDataStore()

public boolean hasDataStore()

Required. The DataStore to create.

.google.cloud.discoveryengine.v1alpha.DataStore data_store = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the dataStore field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateDataStoreRequest.Builder newBuilderForType()
Returns
Type Description
CreateDataStoreRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateDataStoreRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateDataStoreRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateDataStoreRequest.Builder toBuilder()
Returns
Type Description
CreateDataStoreRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException