Class Database.Builder (0.65.0)

public static final class Database.Builder extends GeneratedMessageV3.Builder<Database.Builder> implements DatabaseOrBuilder

Message describing Database object.

Protobuf type google.cloud.alloydb.v1beta.Database

Implements

DatabaseOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Database.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Database.Builder
Overrides

build()

public Database build()
Returns
Type Description
Database

buildPartial()

public Database buildPartial()
Returns
Type Description
Database

clear()

public Database.Builder clear()
Returns
Type Description
Database.Builder
Overrides

clearCharacterType()

public Database.Builder clearCharacterType()

Optional. Immutable. lc_ctype for the database. Character classification (What is a letter? The upper-case equivalent?). Example values include "C", "POSIX", etc.

string character_type = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Database.Builder

This builder for chaining.

clearCharset()

public Database.Builder clearCharset()

Optional. Immutable. Charset for the database. This field can contain any PostgreSQL supported charset name. Example values include "UTF8", "SQL_ASCII", etc.

string charset = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Database.Builder

This builder for chaining.

clearCollation()

public Database.Builder clearCollation()

Optional. Immutable. lc_collate for the database. String sort order. Example values include "C", "POSIX", etc.

string collation = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Database.Builder

This builder for chaining.

clearDatabaseTemplate()

public Database.Builder clearDatabaseTemplate()

Input only. Immutable. Template of the database to be used for creating a new database.

string database_template = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Database.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Database.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Database.Builder
Overrides

clearIsTemplate() (deprecated)

public Database.Builder clearIsTemplate()

Deprecated. google.cloud.alloydb.v1beta.Database.is_template is deprecated. See google/cloud/alloydb/v1beta/resources.proto;l=1758

Optional. Whether the database is a template database. Deprecated in favor of is_template_database.

bool is_template = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Database.Builder

This builder for chaining.

clearIsTemplateDatabase()

public Database.Builder clearIsTemplateDatabase()

Optional. Whether the database is a template database.

optional bool is_template_database = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Database.Builder

This builder for chaining.

clearName()

public Database.Builder clearName()

Identifier. Name of the resource in the form of projects/{project}/locations/{location}/clusters/{cluster}/databases/{database}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
Database.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Database.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Database.Builder
Overrides

clone()

public Database.Builder clone()
Returns
Type Description
Database.Builder
Overrides

getCharacterType()

public String getCharacterType()

Optional. Immutable. lc_ctype for the database. Character classification (What is a letter? The upper-case equivalent?). Example values include "C", "POSIX", etc.

string character_type = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The characterType.

getCharacterTypeBytes()

public ByteString getCharacterTypeBytes()

Optional. Immutable. lc_ctype for the database. Character classification (What is a letter? The upper-case equivalent?). Example values include "C", "POSIX", etc.

string character_type = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for characterType.

getCharset()

public String getCharset()

Optional. Immutable. Charset for the database. This field can contain any PostgreSQL supported charset name. Example values include "UTF8", "SQL_ASCII", etc.

string charset = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The charset.

getCharsetBytes()

public ByteString getCharsetBytes()

Optional. Immutable. Charset for the database. This field can contain any PostgreSQL supported charset name. Example values include "UTF8", "SQL_ASCII", etc.

string charset = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for charset.

getCollation()

public String getCollation()

Optional. Immutable. lc_collate for the database. String sort order. Example values include "C", "POSIX", etc.

string collation = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The collation.

getCollationBytes()

public ByteString getCollationBytes()

Optional. Immutable. lc_collate for the database. String sort order. Example values include "C", "POSIX", etc.

string collation = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for collation.

getDatabaseTemplate()

public String getDatabaseTemplate()

Input only. Immutable. Template of the database to be used for creating a new database.

string database_template = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The databaseTemplate.

getDatabaseTemplateBytes()

public ByteString getDatabaseTemplateBytes()

Input only. Immutable. Template of the database to be used for creating a new database.

string database_template = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for databaseTemplate.

getDefaultInstanceForType()

public Database getDefaultInstanceForType()
Returns
Type Description
Database

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getIsTemplate() (deprecated)

public boolean getIsTemplate()

Deprecated. google.cloud.alloydb.v1beta.Database.is_template is deprecated. See google/cloud/alloydb/v1beta/resources.proto;l=1758

Optional. Whether the database is a template database. Deprecated in favor of is_template_database.

bool is_template = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The isTemplate.

getIsTemplateDatabase()

public boolean getIsTemplateDatabase()

Optional. Whether the database is a template database.

optional bool is_template_database = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The isTemplateDatabase.

getName()

public String getName()

Identifier. Name of the resource in the form of projects/{project}/locations/{location}/clusters/{cluster}/databases/{database}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Name of the resource in the form of projects/{project}/locations/{location}/clusters/{cluster}/databases/{database}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

hasIsTemplateDatabase()

public boolean hasIsTemplateDatabase()

Optional. Whether the database is a template database.

optional bool is_template_database = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the isTemplateDatabase field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Database other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Database.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Database.Builder
Overrides

setCharacterType(String value)

public Database.Builder setCharacterType(String value)

Optional. Immutable. lc_ctype for the database. Character classification (What is a letter? The upper-case equivalent?). Example values include "C", "POSIX", etc.

string character_type = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The characterType to set.

Returns
Type Description
Database.Builder

This builder for chaining.

setCharacterTypeBytes(ByteString value)

public Database.Builder setCharacterTypeBytes(ByteString value)

Optional. Immutable. lc_ctype for the database. Character classification (What is a letter? The upper-case equivalent?). Example values include "C", "POSIX", etc.

string character_type = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for characterType to set.

Returns
Type Description
Database.Builder

This builder for chaining.

setCharset(String value)

public Database.Builder setCharset(String value)

Optional. Immutable. Charset for the database. This field can contain any PostgreSQL supported charset name. Example values include "UTF8", "SQL_ASCII", etc.

string charset = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The charset to set.

Returns
Type Description
Database.Builder

This builder for chaining.

setCharsetBytes(ByteString value)

public Database.Builder setCharsetBytes(ByteString value)

Optional. Immutable. Charset for the database. This field can contain any PostgreSQL supported charset name. Example values include "UTF8", "SQL_ASCII", etc.

string charset = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for charset to set.

Returns
Type Description
Database.Builder

This builder for chaining.

setCollation(String value)

public Database.Builder setCollation(String value)

Optional. Immutable. lc_collate for the database. String sort order. Example values include "C", "POSIX", etc.

string collation = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The collation to set.

Returns
Type Description
Database.Builder

This builder for chaining.

setCollationBytes(ByteString value)

public Database.Builder setCollationBytes(ByteString value)

Optional. Immutable. lc_collate for the database. String sort order. Example values include "C", "POSIX", etc.

string collation = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for collation to set.

Returns
Type Description
Database.Builder

This builder for chaining.

setDatabaseTemplate(String value)

public Database.Builder setDatabaseTemplate(String value)

Input only. Immutable. Template of the database to be used for creating a new database.

string database_template = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The databaseTemplate to set.

Returns
Type Description
Database.Builder

This builder for chaining.

setDatabaseTemplateBytes(ByteString value)

public Database.Builder setDatabaseTemplateBytes(ByteString value)

Input only. Immutable. Template of the database to be used for creating a new database.

string database_template = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for databaseTemplate to set.

Returns
Type Description
Database.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Database.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Database.Builder
Overrides

setIsTemplate(boolean value) (deprecated)

public Database.Builder setIsTemplate(boolean value)

Deprecated. google.cloud.alloydb.v1beta.Database.is_template is deprecated. See google/cloud/alloydb/v1beta/resources.proto;l=1758

Optional. Whether the database is a template database. Deprecated in favor of is_template_database.

bool is_template = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The isTemplate to set.

Returns
Type Description
Database.Builder

This builder for chaining.

setIsTemplateDatabase(boolean value)

public Database.Builder setIsTemplateDatabase(boolean value)

Optional. Whether the database is a template database.

optional bool is_template_database = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The isTemplateDatabase to set.

Returns
Type Description
Database.Builder

This builder for chaining.

setName(String value)

public Database.Builder setName(String value)

Identifier. Name of the resource in the form of projects/{project}/locations/{location}/clusters/{cluster}/databases/{database}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Database.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Database.Builder setNameBytes(ByteString value)

Identifier. Name of the resource in the form of projects/{project}/locations/{location}/clusters/{cluster}/databases/{database}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Database.Builder

This builder for chaining.

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

public Database.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Database.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Database.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Database.Builder
Overrides