Class StorageDirectoryMapping (0.4.0)

public final class StorageDirectoryMapping extends GeneratedMessage implements StorageDirectoryMappingOrBuilder

Mapping of backing Cloud Storage path to the directory where the user lands in the SFTP server. If directory is not specified, it'll default to '/'.

Eg 1 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: /abc/def/username)

The user will land at /abcd/def/username, and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1' and there will be no such directory in the view.

Eg 2 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: '')

The user will land at '/', and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1/path2' and there will be no such directory in the view.

Protobuf type google.cloud.ftp.v1.StorageDirectoryMapping

Static Fields

BUCKET_FIELD_NUMBER

public static final int BUCKET_FIELD_NUMBER
Field Value
Type Description
int

BUCKET_PREFIX_FIELD_NUMBER

public static final int BUCKET_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

DIRECTORY_FIELD_NUMBER

public static final int DIRECTORY_FIELD_NUMBER
Field Value
Type Description
int

PERMISSION_FIELD_NUMBER

public static final int PERMISSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StorageDirectoryMapping getDefaultInstance()
Returns
Type Description
StorageDirectoryMapping

getDescriptor()

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

newBuilder()

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

newBuilder(StorageDirectoryMapping prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBucket()

public String getBucket()

Required. Name of the bucket.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The bucket.

getBucketBytes()

public ByteString getBucketBytes()

Required. Name of the bucket.

string bucket = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for bucket.

getBucketPrefix()

public String getBucketPrefix()

Optional. Prefix inside the bucket.

string bucket_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The bucketPrefix.

getBucketPrefixBytes()

public ByteString getBucketPrefixBytes()

Optional. Prefix inside the bucket.

string bucket_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for bucketPrefix.

getDefaultInstanceForType()

public StorageDirectoryMapping getDefaultInstanceForType()
Returns
Type Description
StorageDirectoryMapping

getDirectory()

public String getDirectory()

Required. Directory where the user lands in the SFTP server.

string directory = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The directory.

getDirectoryBytes()

public ByteString getDirectoryBytes()

Required. Directory where the user lands in the SFTP server.

string directory = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for directory.

getParserForType()

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

getPermission()

public StorageDirectoryMapping.Permission getPermission()

Required. Permission to the bucket.

.google.cloud.ftp.v1.StorageDirectoryMapping.Permission permission = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
StorageDirectoryMapping.Permission

The permission.

getPermissionValue()

public int getPermissionValue()

Required. Permission to the bucket.

.google.cloud.ftp.v1.StorageDirectoryMapping.Permission permission = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for permission.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public StorageDirectoryMapping.Builder newBuilderForType()
Returns
Type Description
StorageDirectoryMapping.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected StorageDirectoryMapping.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StorageDirectoryMapping.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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