Reference documentation and code samples for the Cloud FTP V1 API class Google::Cloud::Ftp::V1::User.
Message describing User object
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. [Output only] Create time stamp
#customer_service_account
def customer_service_account() -> ::String
Returns
- (::String) — Required. Service account in customer project attached to this SFTP User.
#customer_service_account=
def customer_service_account=(value) -> ::String
Parameter
- value (::String) — Required. Service account in customer project attached to this SFTP User.
Returns
- (::String) — Required. Service account in customer project attached to this SFTP User.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs
#name
def name() -> ::String
Returns
- (::String) — Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}
Returns
- (::String) — Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}
#state
def state() -> ::Google::Cloud::Ftp::V1::User::State
Returns
- (::Google::Cloud::Ftp::V1::User::State) — Output only. Tracks user creation.
#storage_directory_mappings
def storage_directory_mappings() -> ::Array<::Google::Cloud::Ftp::V1::StorageDirectoryMapping>
Returns
- (::Array<::Google::Cloud::Ftp::V1::StorageDirectoryMapping>) — Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.
#storage_directory_mappings=
def storage_directory_mappings=(value) -> ::Array<::Google::Cloud::Ftp::V1::StorageDirectoryMapping>
Parameter
- value (::Array<::Google::Cloud::Ftp::V1::StorageDirectoryMapping>) — Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.
Returns
- (::Array<::Google::Cloud::Ftp::V1::StorageDirectoryMapping>) — Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. [Output only] Update time stamp
#user_credentials
def user_credentials() -> ::Array<::Google::Cloud::Ftp::V1::UserCredential>
Returns
- (::Array<::Google::Cloud::Ftp::V1::UserCredential>) — Required. User credential for the user. The maximum number of user credentials is 10.
#user_credentials=
def user_credentials=(value) -> ::Array<::Google::Cloud::Ftp::V1::UserCredential>
Parameter
- value (::Array<::Google::Cloud::Ftp::V1::UserCredential>) — Required. User credential for the user. The maximum number of user credentials is 10.
Returns
- (::Array<::Google::Cloud::Ftp::V1::UserCredential>) — Required. User credential for the user. The maximum number of user credentials is 10.
#username
def username() -> ::String
Returns
- (::String) — Output only. [Output only] The username of the user.