Class Server (0.4.0)

public final class Server extends GeneratedMessage implements ServerOrBuilder

Message describing Server object

Protobuf type google.cloud.ftp.v1.Server

Implements

ServerOrBuilder

Static Fields

ACCESS_TYPE_FIELD_NUMBER

public static final int ACCESS_TYPE_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EXTERNAL_CONFIG_FIELD_NUMBER

public static final int EXTERNAL_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

GOOGLE_MANAGED_SERVER_CREDENTIAL_FIELD_NUMBER

public static final int GOOGLE_MANAGED_SERVER_CREDENTIAL_FIELD_NUMBER
Field Value
Type Description
int

INTERNAL_CONFIG_FIELD_NUMBER

public static final int INTERNAL_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_AGENT_FIELD_NUMBER

public static final int SERVICE_AGENT_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Server getDefaultInstance()
Returns
Type Description
Server

getDescriptor()

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

newBuilder()

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

newBuilder(Server prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

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

equals(Object obj)

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

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.

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

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.

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.

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.

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

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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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