Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Interface UserOrBuilder (0.4.0)

public interface UserOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getCustomerServiceAccount()

public abstract String getCustomerServiceAccount()

Required. Service account in customer project attached to this SFTP User.

string customer_service_account = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The customerServiceAccount.

getCustomerServiceAccountBytes()

public abstract ByteString getCustomerServiceAccountBytes()

Required. Service account in customer project attached to this SFTP User.

string customer_service_account = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for customerServiceAccount.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public abstract int getLabelsCount()

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. Labels as key value pairs

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getName()

public abstract String getName()

Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}

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

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}

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

Returns
Type	Description
`ByteString`	The bytes for name.

getState()

public abstract User.State getState()

Output only. Tracks user creation.

.google.cloud.ftp.v1.User.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`User.State`	The state.

getStateValue()

public abstract int getStateValue()

Output only. Tracks user creation.

.google.cloud.ftp.v1.User.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The enum numeric value on the wire for state.

getStorageDirectoryMappings(int index)

public abstract StorageDirectoryMapping getStorageDirectoryMappings(int index)

Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.

repeated .google.cloud.ftp.v1.StorageDirectoryMapping storage_directory_mappings = 10 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`StorageDirectoryMapping`

getStorageDirectoryMappingsCount()

public abstract int getStorageDirectoryMappingsCount()

Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.

repeated .google.cloud.ftp.v1.StorageDirectoryMapping storage_directory_mappings = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`

getStorageDirectoryMappingsList()

public abstract List<StorageDirectoryMapping> getStorageDirectoryMappingsList()

Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.

repeated .google.cloud.ftp.v1.StorageDirectoryMapping storage_directory_mappings = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<StorageDirectoryMapping>`

getStorageDirectoryMappingsOrBuilder(int index)

public abstract StorageDirectoryMappingOrBuilder getStorageDirectoryMappingsOrBuilder(int index)

Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.

repeated .google.cloud.ftp.v1.StorageDirectoryMapping storage_directory_mappings = 10 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`StorageDirectoryMappingOrBuilder`

getStorageDirectoryMappingsOrBuilderList()

public abstract List<? extends StorageDirectoryMappingOrBuilder> getStorageDirectoryMappingsOrBuilderList()

Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.

repeated .google.cloud.ftp.v1.StorageDirectoryMapping storage_directory_mappings = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<? extends com.google.cloud.ftp.v1.StorageDirectoryMappingOrBuilder>`

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getUserCredentials(int index)

public abstract UserCredential getUserCredentials(int index)

Required. User credential for the user. The maximum number of user credentials is 10.

repeated .google.cloud.ftp.v1.UserCredential user_credentials = 9 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`UserCredential`

getUserCredentialsCount()

public abstract int getUserCredentialsCount()

Required. User credential for the user. The maximum number of user credentials is 10.

repeated .google.cloud.ftp.v1.UserCredential user_credentials = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`

getUserCredentialsList()

public abstract List<UserCredential> getUserCredentialsList()

Required. User credential for the user. The maximum number of user credentials is 10.

repeated .google.cloud.ftp.v1.UserCredential user_credentials = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<UserCredential>`

getUserCredentialsOrBuilder(int index)

public abstract UserCredentialOrBuilder getUserCredentialsOrBuilder(int index)

Required. User credential for the user. The maximum number of user credentials is 10.

repeated .google.cloud.ftp.v1.UserCredential user_credentials = 9 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`UserCredentialOrBuilder`

getUserCredentialsOrBuilderList()

public abstract List<? extends UserCredentialOrBuilder> getUserCredentialsOrBuilderList()

Required. User credential for the user. The maximum number of user credentials is 10.

repeated .google.cloud.ftp.v1.UserCredential user_credentials = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<? extends com.google.cloud.ftp.v1.UserCredentialOrBuilder>`

getUsername()

public abstract String getUsername()

Output only. [Output only] The username of the user.

string username = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The username.

getUsernameBytes()

public abstract ByteString getUsernameBytes()

Output only. [Output only] The username of the user.

string username = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for username.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the createTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the updateTime field is set.