Class SpannerSource (0.42.0)

public final class SpannerSource extends GeneratedMessageV3 implements SpannerSourceOrBuilder

The Spanner source for importing data

Protobuf type google.cloud.discoveryengine.v1.SpannerSource

Static Fields

DATABASE_ID_FIELD_NUMBER

public static final int DATABASE_ID_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_DATA_BOOST_FIELD_NUMBER

public static final int ENABLE_DATA_BOOST_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_ID_FIELD_NUMBER

public static final int INSTANCE_ID_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

TABLE_ID_FIELD_NUMBER

public static final int TABLE_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SpannerSource getDefaultInstance()
Returns
Type Description
SpannerSource

getDescriptor()

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

newBuilder()

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

newBuilder(SpannerSource prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDatabaseId()

public String getDatabaseId()

Required. The database ID of the source Spanner table.

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

Returns
Type Description
String

The databaseId.

getDatabaseIdBytes()

public ByteString getDatabaseIdBytes()

Required. The database ID of the source Spanner table.

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

Returns
Type Description
ByteString

The bytes for databaseId.

getDefaultInstanceForType()

public SpannerSource getDefaultInstanceForType()
Returns
Type Description
SpannerSource

getEnableDataBoost()

public boolean getEnableDataBoost()

Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info can be found here.

bool enable_data_boost = 5;

Returns
Type Description
boolean

The enableDataBoost.

getInstanceId()

public String getInstanceId()

Required. The instance ID of the source Spanner table.

string instance_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The instanceId.

getInstanceIdBytes()

public ByteString getInstanceIdBytes()

Required. The instance ID of the source Spanner table.

string instance_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for instanceId.

getParserForType()

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

getProjectId()

public String getProjectId()

The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

string project_id = 1;

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

string project_id = 1;

Returns
Type Description
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTableId()

public String getTableId()

Required. The table name of the Spanner database that needs to be imported.

string table_id = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The tableId.

getTableIdBytes()

public ByteString getTableIdBytes()

Required. The table name of the Spanner database that needs to be imported.

string table_id = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for tableId.

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 SpannerSource.Builder newBuilderForType()
Returns
Type Description
SpannerSource.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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