Class DdlStatementActionInfo.Builder (6.108.0)

public static final class DdlStatementActionInfo.Builder extends GeneratedMessage.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
Type Description
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
Name Description
values Iterable<String>

The entityNames to add.

Returns
Type Description
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
Name Description
value String

The entityNames to add.

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

The bytes of the entityNames to add.

Returns
Type Description
DdlStatementActionInfo.Builder

This builder for chaining.

build()

public DdlStatementActionInfo build()
Returns
Type Description
DdlStatementActionInfo

buildPartial()

public DdlStatementActionInfo buildPartial()
Returns
Type Description
DdlStatementActionInfo

clear()

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

This builder for chaining.

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DdlStatementActionInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DdlStatementActionInfo.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DdlStatementActionInfo.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DdlStatementActionInfo.Builder
Overrides

mergeFrom(DdlStatementActionInfo other)

public DdlStatementActionInfo.Builder mergeFrom(DdlStatementActionInfo other)
Parameter
Name Description
other DdlStatementActionInfo
Returns
Type Description
DdlStatementActionInfo.Builder

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
Name Description
value String

The action to set.

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

The bytes for action to set.

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

The index to set the value at.

value String

The entityNames to set.

Returns
Type Description
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
Name Description
value String

The entityType to set.

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

The bytes for entityType to set.

Returns
Type Description
DdlStatementActionInfo.Builder

This builder for chaining.