Class DdlStatementActionInfo.Builder (6.57.0)

public static final class DdlStatementActionInfo.Builder extends GeneratedMessageV3.Builder<DdlStatementActionInfo.Builder> 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 Methods

getDescriptor()

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

Methods

addAllEntityNames(Iterable<String> values)

public DdlStatementActionInfo.Builder addAllEntityNames(Iterable<String> values)

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
valuesIterable<String>

The entityNames to add.

Returns
TypeDescription
DdlStatementActionInfo.Builder

This builder for chaining.

addEntityNames(String value)

public DdlStatementActionInfo.Builder addEntityNames(String value)

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
valueString

The entityNames to add.

Returns
TypeDescription
DdlStatementActionInfo.Builder

This builder for chaining.

addEntityNamesBytes(ByteString value)

public DdlStatementActionInfo.Builder addEntityNamesBytes(ByteString value)

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
valueByteString

The bytes of the entityNames to add.

Returns
TypeDescription
DdlStatementActionInfo.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DdlStatementActionInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DdlStatementActionInfo.Builder
Overrides

build()

public DdlStatementActionInfo build()
Returns
TypeDescription
DdlStatementActionInfo

buildPartial()

public DdlStatementActionInfo buildPartial()
Returns
TypeDescription
DdlStatementActionInfo

clear()

public DdlStatementActionInfo.Builder clear()
Returns
TypeDescription
DdlStatementActionInfo.Builder
Overrides

clearAction()

public DdlStatementActionInfo.Builder clearAction()

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
DdlStatementActionInfo.Builder

This builder for chaining.

clearEntityNames()

public DdlStatementActionInfo.Builder clearEntityNames()

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
DdlStatementActionInfo.Builder

This builder for chaining.

clearEntityType()

public DdlStatementActionInfo.Builder clearEntityType()

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
DdlStatementActionInfo.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DdlStatementActionInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DdlStatementActionInfo.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public DdlStatementActionInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DdlStatementActionInfo.Builder
Overrides

clone()

public DdlStatementActionInfo.Builder clone()
Returns
TypeDescription
DdlStatementActionInfo.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DdlStatementActionInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DdlStatementActionInfo.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DdlStatementActionInfo.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DdlStatementActionInfo.Builder
Overrides

mergeFrom(DdlStatementActionInfo other)

public DdlStatementActionInfo.Builder mergeFrom(DdlStatementActionInfo other)
Parameter
NameDescription
otherDdlStatementActionInfo
Returns
TypeDescription
DdlStatementActionInfo.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DdlStatementActionInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DdlStatementActionInfo.Builder
Overrides

setAction(String value)

public DdlStatementActionInfo.Builder setAction(String value)

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

string action = 1;

Parameter
NameDescription
valueString

The action to set.

Returns
TypeDescription
DdlStatementActionInfo.Builder

This builder for chaining.

setActionBytes(ByteString value)

public DdlStatementActionInfo.Builder setActionBytes(ByteString value)

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

string action = 1;

Parameter
NameDescription
valueByteString

The bytes for action to set.

Returns
TypeDescription
DdlStatementActionInfo.Builder

This builder for chaining.

setEntityNames(int index, String value)

public DdlStatementActionInfo.Builder setEntityNames(int index, String value)

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;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The entityNames to set.

Returns
TypeDescription
DdlStatementActionInfo.Builder

This builder for chaining.

setEntityType(String value)

public DdlStatementActionInfo.Builder setEntityType(String value)

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;

Parameter
NameDescription
valueString

The entityType to set.

Returns
TypeDescription
DdlStatementActionInfo.Builder

This builder for chaining.

setEntityTypeBytes(ByteString value)

public DdlStatementActionInfo.Builder setEntityTypeBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for entityType to set.

Returns
TypeDescription
DdlStatementActionInfo.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DdlStatementActionInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DdlStatementActionInfo.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DdlStatementActionInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DdlStatementActionInfo.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DdlStatementActionInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DdlStatementActionInfo.Builder
Overrides