Class Server.Builder (0.4.0)

public static final class Server.Builder extends GeneratedMessage.Builder<Server.Builder> implements ServerOrBuilder

Message describing Server object

Protobuf type google.cloud.ftp.v1.Server

Implements

ServerOrBuilder

Static Methods

getDescriptor()

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

Methods

build()

public Server build()
Returns
Type Description
Server

buildPartial()

public Server buildPartial()
Returns
Type Description
Server

clear()

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

clearAccessConfig()

public Server.Builder clearAccessConfig()
Returns
Type Description
Server.Builder

clearAccessType()

public Server.Builder clearAccessType()

Required. The access type of the Server.

.google.cloud.ftp.v1.Server.AccessType access_type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Server.Builder

This builder for chaining.

clearCreateTime()

public Server.Builder clearCreateTime()

Output only. [Output only] Create time stamp

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

Returns
Type Description
Server.Builder

clearDisplayName()

public Server.Builder clearDisplayName()

Optional. Display name of the Server

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

Returns
Type Description
Server.Builder

This builder for chaining.

clearExternalConfig()

public Server.Builder clearExternalConfig()

Configuration for external access.

.google.cloud.ftp.v1.ExternalServerConfig external_config = 7;

Returns
Type Description
Server.Builder

clearGoogleManagedServerCredential()

public Server.Builder clearGoogleManagedServerCredential()

Output only. Credentials of the FTP Server.

.google.cloud.ftp.v1.ServerCredential google_managed_server_credential = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Server.Builder

clearInternalConfig()

public Server.Builder clearInternalConfig()

Configuration for internal access.

.google.cloud.ftp.v1.InternalServerConfig internal_config = 8;

Returns
Type Description
Server.Builder

clearLabels()

public Server.Builder clearLabels()
Returns
Type Description
Server.Builder

clearName()

public Server.Builder clearName()

Identifier. name of resource

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

Returns
Type Description
Server.Builder

This builder for chaining.

clearServiceAgent()

public Server.Builder clearServiceAgent()

Output only. Service agent used to access the customer bucket.

string service_agent = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Server.Builder

This builder for chaining.

clearState()

public Server.Builder clearState()

Output only. The state of the server.

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

Returns
Type Description
Server.Builder

This builder for chaining.

clearUpdateTime()

public Server.Builder clearUpdateTime()

Output only. [Output only] Update time stamp

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

Returns
Type Description
Server.Builder

containsLabels(String key)

public 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

getAccessConfigCase()

public Server.AccessConfigCase getAccessConfigCase()
Returns
Type Description
Server.AccessConfigCase

getAccessType()

public Server.AccessType getAccessType()

Required. The access type of the Server.

.google.cloud.ftp.v1.Server.AccessType access_type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Server.AccessType

The accessType.

getAccessTypeValue()

public int getAccessTypeValue()

Required. The access type of the Server.

.google.cloud.ftp.v1.Server.AccessType access_type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for accessType.

getCreateTime()

public 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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. [Output only] Create time stamp

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public 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

getDefaultInstanceForType()

public Server getDefaultInstanceForType()
Returns
Type Description
Server

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Optional. Display name of the Server

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Display name of the Server

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

Returns
Type Description
ByteString

The bytes for displayName.

getExternalConfig()

public ExternalServerConfig getExternalConfig()

Configuration for external access.

.google.cloud.ftp.v1.ExternalServerConfig external_config = 7;

Returns
Type Description
ExternalServerConfig

The externalConfig.

getExternalConfigBuilder()

public ExternalServerConfig.Builder getExternalConfigBuilder()

Configuration for external access.

.google.cloud.ftp.v1.ExternalServerConfig external_config = 7;

Returns
Type Description
ExternalServerConfig.Builder

getExternalConfigOrBuilder()

public ExternalServerConfigOrBuilder getExternalConfigOrBuilder()

Configuration for external access.

.google.cloud.ftp.v1.ExternalServerConfig external_config = 7;

Returns
Type Description
ExternalServerConfigOrBuilder

getGoogleManagedServerCredential()

public ServerCredential getGoogleManagedServerCredential()

Output only. Credentials of the FTP Server.

.google.cloud.ftp.v1.ServerCredential google_managed_server_credential = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ServerCredential

The googleManagedServerCredential.

getGoogleManagedServerCredentialBuilder()

public ServerCredential.Builder getGoogleManagedServerCredentialBuilder()

Output only. Credentials of the FTP Server.

.google.cloud.ftp.v1.ServerCredential google_managed_server_credential = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ServerCredential.Builder

getGoogleManagedServerCredentialOrBuilder()

public ServerCredentialOrBuilder getGoogleManagedServerCredentialOrBuilder()

Output only. Credentials of the FTP Server.

.google.cloud.ftp.v1.ServerCredential google_managed_server_credential = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ServerCredentialOrBuilder

getInternalConfig()

public InternalServerConfig getInternalConfig()

Configuration for internal access.

.google.cloud.ftp.v1.InternalServerConfig internal_config = 8;

Returns
Type Description
InternalServerConfig

The internalConfig.

getInternalConfigBuilder()

public InternalServerConfig.Builder getInternalConfigBuilder()

Configuration for internal access.

.google.cloud.ftp.v1.InternalServerConfig internal_config = 8;

Returns
Type Description
InternalServerConfig.Builder

getInternalConfigOrBuilder()

public InternalServerConfigOrBuilder getInternalConfigOrBuilder()

Configuration for internal access.

.google.cloud.ftp.v1.InternalServerConfig internal_config = 8;

Returns
Type Description
InternalServerConfigOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels as key value pairs

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

Returns
Type Description
int

getLabelsMap()

public 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 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 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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Identifier. name of resource

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. name of resource

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

Returns
Type Description
ByteString

The bytes for name.

getServiceAgent()

public String getServiceAgent()

Output only. Service agent used to access the customer bucket.

string service_agent = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The serviceAgent.

getServiceAgentBytes()

public ByteString getServiceAgentBytes()

Output only. Service agent used to access the customer bucket.

string service_agent = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for serviceAgent.

getState()

public Server.State getState()

Output only. The state of the server.

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

Returns
Type Description
Server.State

The state.

getStateValue()

public int getStateValue()

Output only. The state of the server.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public 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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. [Output only] Update time stamp

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public 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

hasCreateTime()

public 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.

hasExternalConfig()

public boolean hasExternalConfig()

Configuration for external access.

.google.cloud.ftp.v1.ExternalServerConfig external_config = 7;

Returns
Type Description
boolean

Whether the externalConfig field is set.

hasGoogleManagedServerCredential()

public boolean hasGoogleManagedServerCredential()

Output only. Credentials of the FTP Server.

.google.cloud.ftp.v1.ServerCredential google_managed_server_credential = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the googleManagedServerCredential field is set.

hasInternalConfig()

public boolean hasInternalConfig()

Configuration for internal access.

.google.cloud.ftp.v1.InternalServerConfig internal_config = 8;

Returns
Type Description
boolean

Whether the internalConfig field is set.

hasUpdateTime()

public 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.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Server.Builder mergeCreateTime(Timestamp value)

Output only. [Output only] Create time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Server.Builder

mergeExternalConfig(ExternalServerConfig value)

public Server.Builder mergeExternalConfig(ExternalServerConfig value)

Configuration for external access.

.google.cloud.ftp.v1.ExternalServerConfig external_config = 7;

Parameter
Name Description
value ExternalServerConfig
Returns
Type Description
Server.Builder

mergeFrom(Server other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeGoogleManagedServerCredential(ServerCredential value)

public Server.Builder mergeGoogleManagedServerCredential(ServerCredential value)

Output only. Credentials of the FTP Server.

.google.cloud.ftp.v1.ServerCredential google_managed_server_credential = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ServerCredential
Returns
Type Description
Server.Builder

mergeInternalConfig(InternalServerConfig value)

public Server.Builder mergeInternalConfig(InternalServerConfig value)

Configuration for internal access.

.google.cloud.ftp.v1.InternalServerConfig internal_config = 8;

Parameter
Name Description
value InternalServerConfig
Returns
Type Description
Server.Builder

mergeUpdateTime(Timestamp value)

public Server.Builder mergeUpdateTime(Timestamp value)

Output only. [Output only] Update time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Server.Builder

putAllLabels(Map<String,String> values)

public Server.Builder putAllLabels(Map<String,String> values)

Optional. Labels as key value pairs

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

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Server.Builder

putLabels(String key, String value)

public Server.Builder putLabels(String key, String value)

Optional. Labels as key value pairs

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

Parameters
Name Description
key String
value String
Returns
Type Description
Server.Builder

removeLabels(String key)

public Server.Builder removeLabels(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
Server.Builder

setAccessType(Server.AccessType value)

public Server.Builder setAccessType(Server.AccessType value)

Required. The access type of the Server.

.google.cloud.ftp.v1.Server.AccessType access_type = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Server.AccessType

The accessType to set.

Returns
Type Description
Server.Builder

This builder for chaining.

setAccessTypeValue(int value)

public Server.Builder setAccessTypeValue(int value)

Required. The access type of the Server.

.google.cloud.ftp.v1.Server.AccessType access_type = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for accessType to set.

Returns
Type Description
Server.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Server.Builder setCreateTime(Timestamp value)

Output only. [Output only] Create time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Server.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Server.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. [Output only] Create time stamp

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Server.Builder

setDisplayName(String value)

public Server.Builder setDisplayName(String value)

Optional. Display name of the Server

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Server.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Server.Builder setDisplayNameBytes(ByteString value)

Optional. Display name of the Server

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Server.Builder

This builder for chaining.

setExternalConfig(ExternalServerConfig value)

public Server.Builder setExternalConfig(ExternalServerConfig value)

Configuration for external access.

.google.cloud.ftp.v1.ExternalServerConfig external_config = 7;

Parameter
Name Description
value ExternalServerConfig
Returns
Type Description
Server.Builder

setExternalConfig(ExternalServerConfig.Builder builderForValue)

public Server.Builder setExternalConfig(ExternalServerConfig.Builder builderForValue)

Configuration for external access.

.google.cloud.ftp.v1.ExternalServerConfig external_config = 7;

Parameter
Name Description
builderForValue ExternalServerConfig.Builder
Returns
Type Description
Server.Builder

setGoogleManagedServerCredential(ServerCredential value)

public Server.Builder setGoogleManagedServerCredential(ServerCredential value)

Output only. Credentials of the FTP Server.

.google.cloud.ftp.v1.ServerCredential google_managed_server_credential = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ServerCredential
Returns
Type Description
Server.Builder

setGoogleManagedServerCredential(ServerCredential.Builder builderForValue)

public Server.Builder setGoogleManagedServerCredential(ServerCredential.Builder builderForValue)

Output only. Credentials of the FTP Server.

.google.cloud.ftp.v1.ServerCredential google_managed_server_credential = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue ServerCredential.Builder
Returns
Type Description
Server.Builder

setInternalConfig(InternalServerConfig value)

public Server.Builder setInternalConfig(InternalServerConfig value)

Configuration for internal access.

.google.cloud.ftp.v1.InternalServerConfig internal_config = 8;

Parameter
Name Description
value InternalServerConfig
Returns
Type Description
Server.Builder

setInternalConfig(InternalServerConfig.Builder builderForValue)

public Server.Builder setInternalConfig(InternalServerConfig.Builder builderForValue)

Configuration for internal access.

.google.cloud.ftp.v1.InternalServerConfig internal_config = 8;

Parameter
Name Description
builderForValue InternalServerConfig.Builder
Returns
Type Description
Server.Builder

setName(String value)

public Server.Builder setName(String value)

Identifier. name of resource

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Server.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Server.Builder setNameBytes(ByteString value)

Identifier. name of resource

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Server.Builder

This builder for chaining.

setServiceAgent(String value)

public Server.Builder setServiceAgent(String value)

Output only. Service agent used to access the customer bucket.

string service_agent = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The serviceAgent to set.

Returns
Type Description
Server.Builder

This builder for chaining.

setServiceAgentBytes(ByteString value)

public Server.Builder setServiceAgentBytes(ByteString value)

Output only. Service agent used to access the customer bucket.

string service_agent = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for serviceAgent to set.

Returns
Type Description
Server.Builder

This builder for chaining.

setState(Server.State value)

public Server.Builder setState(Server.State value)

Output only. The state of the server.

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

Parameter
Name Description
value Server.State

The state to set.

Returns
Type Description
Server.Builder

This builder for chaining.

setStateValue(int value)

public Server.Builder setStateValue(int value)

Output only. The state of the server.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
Server.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public Server.Builder setUpdateTime(Timestamp value)

Output only. [Output only] Update time stamp

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Server.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Server.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. [Output only] Update time stamp

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Server.Builder