public static final class StorageDirectoryMapping.Builder extends GeneratedMessage.Builder<StorageDirectoryMapping.Builder> implements StorageDirectoryMappingOrBuilderMapping 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
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > StorageDirectoryMapping.BuilderImplements
StorageDirectoryMappingOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public StorageDirectoryMapping build()| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping |
|
buildPartial()
public StorageDirectoryMapping buildPartial()| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping |
|
clear()
public StorageDirectoryMapping.Builder clear()| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
|
clearBucket()
public StorageDirectoryMapping.Builder clearBucket()Required. Name of the bucket.
string bucket = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
This builder for chaining. |
clearBucketPrefix()
public StorageDirectoryMapping.Builder clearBucketPrefix()Optional. Prefix inside the bucket.
string bucket_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
This builder for chaining. |
clearDirectory()
public StorageDirectoryMapping.Builder clearDirectory()Required. Directory where the user lands in the SFTP server.
string directory = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
This builder for chaining. |
clearPermission()
public StorageDirectoryMapping.Builder clearPermission()Required. Permission to the bucket.
.google.cloud.ftp.v1.StorageDirectoryMapping.Permission permission = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
This builder for chaining. |
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(StorageDirectoryMapping other)
public StorageDirectoryMapping.Builder mergeFrom(StorageDirectoryMapping other)| Parameter | |
|---|---|
| Name | Description |
other |
StorageDirectoryMapping |
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public StorageDirectoryMapping.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public StorageDirectoryMapping.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
|
setBucket(String value)
public StorageDirectoryMapping.Builder setBucket(String value)Required. Name of the bucket.
string bucket = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe bucket to set. |
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
This builder for chaining. |
setBucketBytes(ByteString value)
public StorageDirectoryMapping.Builder setBucketBytes(ByteString value)Required. Name of the bucket.
string bucket = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for bucket to set. |
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
This builder for chaining. |
setBucketPrefix(String value)
public StorageDirectoryMapping.Builder setBucketPrefix(String value)Optional. Prefix inside the bucket.
string bucket_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe bucketPrefix to set. |
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
This builder for chaining. |
setBucketPrefixBytes(ByteString value)
public StorageDirectoryMapping.Builder setBucketPrefixBytes(ByteString value)Optional. Prefix inside the bucket.
string bucket_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for bucketPrefix to set. |
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
This builder for chaining. |
setDirectory(String value)
public StorageDirectoryMapping.Builder setDirectory(String value)Required. Directory where the user lands in the SFTP server.
string directory = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe directory to set. |
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
This builder for chaining. |
setDirectoryBytes(ByteString value)
public StorageDirectoryMapping.Builder setDirectoryBytes(ByteString value)Required. Directory where the user lands in the SFTP server.
string directory = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for directory to set. |
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
This builder for chaining. |
setPermission(StorageDirectoryMapping.Permission value)
public StorageDirectoryMapping.Builder setPermission(StorageDirectoryMapping.Permission value)Required. Permission to the bucket.
.google.cloud.ftp.v1.StorageDirectoryMapping.Permission permission = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StorageDirectoryMapping.PermissionThe permission to set. |
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
This builder for chaining. |
setPermissionValue(int value)
public StorageDirectoryMapping.Builder setPermissionValue(int value)Required. Permission to the bucket.
.google.cloud.ftp.v1.StorageDirectoryMapping.Permission permission = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for permission to set. |
| Returns | |
|---|---|
| Type | Description |
StorageDirectoryMapping.Builder |
This builder for chaining. |