Class User (0.44.0)

public final class User extends GeneratedMessageV3 implements UserOrBuilder

Message describing User object.

Protobuf type google.cloud.alloydb.v1.User

Implements

UserOrBuilder

Static Fields

DATABASE_ROLES_FIELD_NUMBER

public static final int DATABASE_ROLES_FIELD_NUMBER
Field Value
Type Description
int

KEEP_EXTRA_ROLES_FIELD_NUMBER

public static final int KEEP_EXTRA_ROLES_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PASSWORD_FIELD_NUMBER

public static final int PASSWORD_FIELD_NUMBER
Field Value
Type Description
int

USER_TYPE_FIELD_NUMBER

public static final int USER_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static User getDefaultInstance()
Returns
Type Description
User

getDescriptor()

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

newBuilder()

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

newBuilder(User prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDatabaseRoles(int index)

public String getDatabaseRoles(int index)

Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions.

repeated string database_roles = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The databaseRoles at the given index.

getDatabaseRolesBytes(int index)

public ByteString getDatabaseRolesBytes(int index)

Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions.

repeated string database_roles = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the databaseRoles at the given index.

getDatabaseRolesCount()

public int getDatabaseRolesCount()

Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions.

repeated string database_roles = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of databaseRoles.

getDatabaseRolesList()

public ProtocolStringList getDatabaseRolesList()

Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions.

repeated string database_roles = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the databaseRoles.

getDefaultInstanceForType()

public User getDefaultInstanceForType()
Returns
Type Description
User

getKeepExtraRoles()

public boolean getKeepExtraRoles()

Input only. If the user already exists and it has additional roles, keep them granted.

bool keep_extra_roles = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

The keepExtraRoles.

getName()

public String getName()

Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPassword()

public String getPassword()

Input only. Password for the user.

string password = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
String

The password.

getPasswordBytes()

public ByteString getPasswordBytes()

Input only. Password for the user.

string password = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
ByteString

The bytes for password.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUserType()

public User.UserType getUserType()

Optional. Type of this user.

.google.cloud.alloydb.v1.User.UserType user_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
User.UserType

The userType.

getUserTypeValue()

public int getUserTypeValue()

Optional. Type of this user.

.google.cloud.alloydb.v1.User.UserType user_type = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for userType.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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