Class DdlStatementActionInfo (6.54.0)

public final class DdlStatementActionInfo extends GeneratedMessageV3 implements DdlStatementActionInfoOrBuilder

Action information extracted from a DDL statement. This proto is used to display the brief info of the DDL statement for the operation UpdateDatabaseDdl.

Protobuf type google.spanner.admin.database.v1.DdlStatementActionInfo

Static Fields

ACTION_FIELD_NUMBER

public static final int ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

ENTITY_NAMES_FIELD_NUMBER

public static final int ENTITY_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

ENTITY_TYPE_FIELD_NUMBER

public static final int ENTITY_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DdlStatementActionInfo getDefaultInstance()
Returns
TypeDescription
DdlStatementActionInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DdlStatementActionInfo.Builder newBuilder()
Returns
TypeDescription
DdlStatementActionInfo.Builder

newBuilder(DdlStatementActionInfo prototype)

public static DdlStatementActionInfo.Builder newBuilder(DdlStatementActionInfo prototype)
Parameter
NameDescription
prototypeDdlStatementActionInfo
Returns
TypeDescription
DdlStatementActionInfo.Builder

parseDelimitedFrom(InputStream input)

public static DdlStatementActionInfo parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DdlStatementActionInfo
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DdlStatementActionInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DdlStatementActionInfo
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DdlStatementActionInfo parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DdlStatementActionInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DdlStatementActionInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DdlStatementActionInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DdlStatementActionInfo parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DdlStatementActionInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DdlStatementActionInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DdlStatementActionInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DdlStatementActionInfo parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DdlStatementActionInfo
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DdlStatementActionInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DdlStatementActionInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DdlStatementActionInfo parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DdlStatementActionInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DdlStatementActionInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DdlStatementActionInfo
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DdlStatementActionInfo parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DdlStatementActionInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DdlStatementActionInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DdlStatementActionInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DdlStatementActionInfo> parser()
Returns
TypeDescription
Parser<DdlStatementActionInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAction()

public String getAction()

The action for the DDL statement, e.g. CREATE, ALTER, DROP, GRANT, etc. This field is a non-empty string.

string action = 1;

Returns
TypeDescription
String

The action.

getActionBytes()

public ByteString getActionBytes()

The action for the DDL statement, e.g. CREATE, ALTER, DROP, GRANT, etc. This field is a non-empty string.

string action = 1;

Returns
TypeDescription
ByteString

The bytes for action.

getDefaultInstanceForType()

public DdlStatementActionInfo getDefaultInstanceForType()
Returns
TypeDescription
DdlStatementActionInfo

getEntityNames(int index)

public String getEntityNames(int index)

The entity name(s) being operated on the DDL statement. E.g.

  1. For statement "CREATE TABLE t1(...)", entity_names = ["t1"].
  2. For statement "GRANT ROLE r1, r2 ...", entity_names = ["r1", "r2"].
  3. For statement "ANALYZE", entity_names = [].

repeated string entity_names = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The entityNames at the given index.

getEntityNamesBytes(int index)

public ByteString getEntityNamesBytes(int index)

The entity name(s) being operated on the DDL statement. E.g.

  1. For statement "CREATE TABLE t1(...)", entity_names = ["t1"].
  2. For statement "GRANT ROLE r1, r2 ...", entity_names = ["r1", "r2"].
  3. For statement "ANALYZE", entity_names = [].

repeated string entity_names = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the entityNames at the given index.

getEntityNamesCount()

public int getEntityNamesCount()

The entity name(s) being operated on the DDL statement. E.g.

  1. For statement "CREATE TABLE t1(...)", entity_names = ["t1"].
  2. For statement "GRANT ROLE r1, r2 ...", entity_names = ["r1", "r2"].
  3. For statement "ANALYZE", entity_names = [].

repeated string entity_names = 3;

Returns
TypeDescription
int

The count of entityNames.

getEntityNamesList()

public ProtocolStringList getEntityNamesList()

The entity name(s) being operated on the DDL statement. E.g.

  1. For statement "CREATE TABLE t1(...)", entity_names = ["t1"].
  2. For statement "GRANT ROLE r1, r2 ...", entity_names = ["r1", "r2"].
  3. For statement "ANALYZE", entity_names = [].

repeated string entity_names = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the entityNames.

getEntityType()

public String getEntityType()

The entity type for the DDL statement, e.g. TABLE, INDEX, VIEW, etc. This field can be empty string for some DDL statement, e.g. for statement "ANALYZE", entity_type = "".

string entity_type = 2;

Returns
TypeDescription
String

The entityType.

getEntityTypeBytes()

public ByteString getEntityTypeBytes()

The entity type for the DDL statement, e.g. TABLE, INDEX, VIEW, etc. This field can be empty string for some DDL statement, e.g. for statement "ANALYZE", entity_type = "".

string entity_type = 2;

Returns
TypeDescription
ByteString

The bytes for entityType.

getParserForType()

public Parser<DdlStatementActionInfo> getParserForType()
Returns
TypeDescription
Parser<DdlStatementActionInfo>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DdlStatementActionInfo.Builder newBuilderForType()
Returns
TypeDescription
DdlStatementActionInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DdlStatementActionInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DdlStatementActionInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DdlStatementActionInfo.Builder toBuilder()
Returns
TypeDescription
DdlStatementActionInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException