Class DdlStatementActionInfo (6.71.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
Type Description
int

ENTITY_NAMES_FIELD_NUMBER

public static final int ENTITY_NAMES_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_TYPE_FIELD_NUMBER

public static final int ENTITY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DdlStatementActionInfo getDefaultInstance()
Returns
Type Description
DdlStatementActionInfo

getDescriptor()

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

newBuilder()

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

newBuilder(DdlStatementActionInfo prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for action.

getDefaultInstanceForType()

public DdlStatementActionInfo getDefaultInstanceForType()
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for entityType.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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