Class SqlUsersUpdateRequest.Builder (0.1.0)

public static final class SqlUsersUpdateRequest.Builder extends GeneratedMessage.Builder<SqlUsersUpdateRequest.Builder> implements SqlUsersUpdateRequestOrBuilder

Protobuf type google.cloud.sql.v1.SqlUsersUpdateRequest

Static Methods

getDescriptor()

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

Methods

addAllDatabaseRoles(Iterable<String> values)

public SqlUsersUpdateRequest.Builder addAllDatabaseRoles(Iterable<String> values)

Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.

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

Parameter
Name Description
values Iterable<String>

The databaseRoles to add.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

addAllServerRoles(Iterable<String> values)

public SqlUsersUpdateRequest.Builder addAllServerRoles(Iterable<String> values)

Optional. The server roles to grant to the SQL Server login. Existing server roles will not be revoked if revoke_existing_roles is false. body.server_roles will be ignored for update request.

repeated string server_roles = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The serverRoles to add.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

addDatabaseRoles(String value)

public SqlUsersUpdateRequest.Builder addDatabaseRoles(String value)

Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.

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

Parameter
Name Description
value String

The databaseRoles to add.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

addDatabaseRolesBytes(ByteString value)

public SqlUsersUpdateRequest.Builder addDatabaseRolesBytes(ByteString value)

Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.

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

Parameter
Name Description
value ByteString

The bytes of the databaseRoles to add.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

addServerRoles(String value)

public SqlUsersUpdateRequest.Builder addServerRoles(String value)

Optional. The server roles to grant to the SQL Server login. Existing server roles will not be revoked if revoke_existing_roles is false. body.server_roles will be ignored for update request.

repeated string server_roles = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The serverRoles to add.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

addServerRolesBytes(ByteString value)

public SqlUsersUpdateRequest.Builder addServerRolesBytes(ByteString value)

Optional. The server roles to grant to the SQL Server login. Existing server roles will not be revoked if revoke_existing_roles is false. body.server_roles will be ignored for update request.

repeated string server_roles = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the serverRoles to add.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

build()

public SqlUsersUpdateRequest build()
Returns
Type Description
SqlUsersUpdateRequest

buildPartial()

public SqlUsersUpdateRequest buildPartial()
Returns
Type Description
SqlUsersUpdateRequest

clear()

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

clearBody()

public SqlUsersUpdateRequest.Builder clearBody()

.google.cloud.sql.v1.User body = 100;

Returns
Type Description
SqlUsersUpdateRequest.Builder

clearDatabaseRoles()

public SqlUsersUpdateRequest.Builder clearDatabaseRoles()

Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.

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

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

clearHost()

public SqlUsersUpdateRequest.Builder clearHost()

Optional. Host of the user in the instance.

string host = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

clearInstance()

public SqlUsersUpdateRequest.Builder clearInstance()

Database instance ID. This does not include the project ID.

string instance = 2;

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

clearName()

public SqlUsersUpdateRequest.Builder clearName()

Name of the user in the instance.

string name = 3;

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

clearProject()

public SqlUsersUpdateRequest.Builder clearProject()

Project ID of the project that contains the instance.

string project = 4;

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

clearRevokeExistingRoles()

public SqlUsersUpdateRequest.Builder clearRevokeExistingRoles()

Optional. Specifies whether to revoke existing roles that are not present in the database_roles field. If false or unset, the database roles specified in database_roles are added to the user's existing roles.

optional bool revoke_existing_roles = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

clearRevokeExistingServerRoles()

public SqlUsersUpdateRequest.Builder clearRevokeExistingServerRoles()

Optional. Specifies whether to revoke existing roles that are not present in the server_roles field. If false or unset, the server roles specified in server_roles are added to the user's existing server roles.

optional bool revoke_existing_server_roles = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

clearServerRoles()

public SqlUsersUpdateRequest.Builder clearServerRoles()

Optional. The server roles to grant to the SQL Server login. Existing server roles will not be revoked if revoke_existing_roles is false. body.server_roles will be ignored for update request.

repeated string server_roles = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

getBody()

public User getBody()

.google.cloud.sql.v1.User body = 100;

Returns
Type Description
User

The body.

getBodyBuilder()

public User.Builder getBodyBuilder()

.google.cloud.sql.v1.User body = 100;

Returns
Type Description
User.Builder

getBodyOrBuilder()

public UserOrBuilder getBodyOrBuilder()

.google.cloud.sql.v1.User body = 100;

Returns
Type Description
UserOrBuilder

getDatabaseRoles(int index)

public String getDatabaseRoles(int index)

Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.

repeated string database_roles = 5 [(.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 to grant to the user. body.database_roles will be ignored for update request.

repeated string database_roles = 5 [(.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 to grant to the user. body.database_roles will be ignored for update request.

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

Returns
Type Description
int

The count of databaseRoles.

getDatabaseRolesList()

public ProtocolStringList getDatabaseRolesList()

Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.

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

Returns
Type Description
ProtocolStringList

A list containing the databaseRoles.

getDefaultInstanceForType()

public SqlUsersUpdateRequest getDefaultInstanceForType()
Returns
Type Description
SqlUsersUpdateRequest

getDescriptorForType()

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

getHost()

public String getHost()

Optional. Host of the user in the instance.

string host = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The host.

getHostBytes()

public ByteString getHostBytes()

Optional. Host of the user in the instance.

string host = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for host.

getInstance()

public String getInstance()

Database instance ID. This does not include the project ID.

string instance = 2;

Returns
Type Description
String

The instance.

getInstanceBytes()

public ByteString getInstanceBytes()

Database instance ID. This does not include the project ID.

string instance = 2;

Returns
Type Description
ByteString

The bytes for instance.

getName()

public String getName()

Name of the user in the instance.

string name = 3;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the user in the instance.

string name = 3;

Returns
Type Description
ByteString

The bytes for name.

getProject()

public String getProject()

Project ID of the project that contains the instance.

string project = 4;

Returns
Type Description
String

The project.

getProjectBytes()

public ByteString getProjectBytes()

Project ID of the project that contains the instance.

string project = 4;

Returns
Type Description
ByteString

The bytes for project.

getRevokeExistingRoles()

public boolean getRevokeExistingRoles()

Optional. Specifies whether to revoke existing roles that are not present in the database_roles field. If false or unset, the database roles specified in database_roles are added to the user's existing roles.

optional bool revoke_existing_roles = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The revokeExistingRoles.

getRevokeExistingServerRoles()

public boolean getRevokeExistingServerRoles()

Optional. Specifies whether to revoke existing roles that are not present in the server_roles field. If false or unset, the server roles specified in server_roles are added to the user's existing server roles.

optional bool revoke_existing_server_roles = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The revokeExistingServerRoles.

getServerRoles(int index)

public String getServerRoles(int index)

Optional. The server roles to grant to the SQL Server login. Existing server roles will not be revoked if revoke_existing_roles is false. body.server_roles will be ignored for update request.

repeated string server_roles = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The serverRoles at the given index.

getServerRolesBytes(int index)

public ByteString getServerRolesBytes(int index)

Optional. The server roles to grant to the SQL Server login. Existing server roles will not be revoked if revoke_existing_roles is false. body.server_roles will be ignored for update request.

repeated string server_roles = 7 [(.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 serverRoles at the given index.

getServerRolesCount()

public int getServerRolesCount()

Optional. The server roles to grant to the SQL Server login. Existing server roles will not be revoked if revoke_existing_roles is false. body.server_roles will be ignored for update request.

repeated string server_roles = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of serverRoles.

getServerRolesList()

public ProtocolStringList getServerRolesList()

Optional. The server roles to grant to the SQL Server login. Existing server roles will not be revoked if revoke_existing_roles is false. body.server_roles will be ignored for update request.

repeated string server_roles = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the serverRoles.

hasBody()

public boolean hasBody()

.google.cloud.sql.v1.User body = 100;

Returns
Type Description
boolean

Whether the body field is set.

hasRevokeExistingRoles()

public boolean hasRevokeExistingRoles()

Optional. Specifies whether to revoke existing roles that are not present in the database_roles field. If false or unset, the database roles specified in database_roles are added to the user's existing roles.

optional bool revoke_existing_roles = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the revokeExistingRoles field is set.

hasRevokeExistingServerRoles()

public boolean hasRevokeExistingServerRoles()

Optional. Specifies whether to revoke existing roles that are not present in the server_roles field. If false or unset, the server roles specified in server_roles are added to the user's existing server roles.

optional bool revoke_existing_server_roles = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the revokeExistingServerRoles field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBody(User value)

public SqlUsersUpdateRequest.Builder mergeBody(User value)

.google.cloud.sql.v1.User body = 100;

Parameter
Name Description
value User
Returns
Type Description
SqlUsersUpdateRequest.Builder

mergeFrom(SqlUsersUpdateRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setBody(User value)

public SqlUsersUpdateRequest.Builder setBody(User value)

.google.cloud.sql.v1.User body = 100;

Parameter
Name Description
value User
Returns
Type Description
SqlUsersUpdateRequest.Builder

setBody(User.Builder builderForValue)

public SqlUsersUpdateRequest.Builder setBody(User.Builder builderForValue)

.google.cloud.sql.v1.User body = 100;

Parameter
Name Description
builderForValue User.Builder
Returns
Type Description
SqlUsersUpdateRequest.Builder

setDatabaseRoles(int index, String value)

public SqlUsersUpdateRequest.Builder setDatabaseRoles(int index, String value)

Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.

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

Parameters
Name Description
index int

The index to set the value at.

value String

The databaseRoles to set.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

setHost(String value)

public SqlUsersUpdateRequest.Builder setHost(String value)

Optional. Host of the user in the instance.

string host = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The host to set.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

setHostBytes(ByteString value)

public SqlUsersUpdateRequest.Builder setHostBytes(ByteString value)

Optional. Host of the user in the instance.

string host = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for host to set.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

setInstance(String value)

public SqlUsersUpdateRequest.Builder setInstance(String value)

Database instance ID. This does not include the project ID.

string instance = 2;

Parameter
Name Description
value String

The instance to set.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

setInstanceBytes(ByteString value)

public SqlUsersUpdateRequest.Builder setInstanceBytes(ByteString value)

Database instance ID. This does not include the project ID.

string instance = 2;

Parameter
Name Description
value ByteString

The bytes for instance to set.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

setName(String value)

public SqlUsersUpdateRequest.Builder setName(String value)

Name of the user in the instance.

string name = 3;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SqlUsersUpdateRequest.Builder setNameBytes(ByteString value)

Name of the user in the instance.

string name = 3;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

setProject(String value)

public SqlUsersUpdateRequest.Builder setProject(String value)

Project ID of the project that contains the instance.

string project = 4;

Parameter
Name Description
value String

The project to set.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

setProjectBytes(ByteString value)

public SqlUsersUpdateRequest.Builder setProjectBytes(ByteString value)

Project ID of the project that contains the instance.

string project = 4;

Parameter
Name Description
value ByteString

The bytes for project to set.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

setRevokeExistingRoles(boolean value)

public SqlUsersUpdateRequest.Builder setRevokeExistingRoles(boolean value)

Optional. Specifies whether to revoke existing roles that are not present in the database_roles field. If false or unset, the database roles specified in database_roles are added to the user's existing roles.

optional bool revoke_existing_roles = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The revokeExistingRoles to set.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

setRevokeExistingServerRoles(boolean value)

public SqlUsersUpdateRequest.Builder setRevokeExistingServerRoles(boolean value)

Optional. Specifies whether to revoke existing roles that are not present in the server_roles field. If false or unset, the server roles specified in server_roles are added to the user's existing server roles.

optional bool revoke_existing_server_roles = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The revokeExistingServerRoles to set.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.

setServerRoles(int index, String value)

public SqlUsersUpdateRequest.Builder setServerRoles(int index, String value)

Optional. The server roles to grant to the SQL Server login. Existing server roles will not be revoked if revoke_existing_roles is false. body.server_roles will be ignored for update request.

repeated string server_roles = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The serverRoles to set.

Returns
Type Description
SqlUsersUpdateRequest.Builder

This builder for chaining.