Class UserCredential (0.4.0)

public final class UserCredential extends GeneratedMessage implements UserCredentialOrBuilder

Message describing UserCredential object

Protobuf type google.cloud.ftp.v1.UserCredential

Static Fields

CREDENTIAL_NAME_FIELD_NUMBER

public static final int CREDENTIAL_NAME_FIELD_NUMBER
Field Value
Type Description
int

CREDENTIAL_TYPE_FIELD_NUMBER

public static final int CREDENTIAL_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SSH_PUBLIC_KEY_BODY_FIELD_NUMBER

public static final int SSH_PUBLIC_KEY_BODY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UserCredential getDefaultInstance()
Returns
Type Description
UserCredential

getDescriptor()

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

newBuilder()

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

newBuilder(UserCredential prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCredentialName()

public String getCredentialName()

Required. Name of the user credential.

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

Returns
Type Description
String

The credentialName.

getCredentialNameBytes()

public ByteString getCredentialNameBytes()

Required. Name of the user credential.

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

Returns
Type Description
ByteString

The bytes for credentialName.

getCredentialType()

public UserCredential.Type getCredentialType()

Required. Type of credential.

.google.cloud.ftp.v1.UserCredential.Type credential_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UserCredential.Type

The credentialType.

getCredentialTypeValue()

public int getCredentialTypeValue()

Required. Type of credential.

.google.cloud.ftp.v1.UserCredential.Type credential_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for credentialType.

getDefaultInstanceForType()

public UserCredential getDefaultInstanceForType()
Returns
Type Description
UserCredential

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSshPublicKeyBody()

public String getSshPublicKeyBody()

Optional. SSH public key body in OpenSSH format. Example: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ..."

string ssh_public_key_body = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sshPublicKeyBody.

getSshPublicKeyBodyBytes()

public ByteString getSshPublicKeyBodyBytes()

Optional. SSH public key body in OpenSSH format. Example: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ..."

string ssh_public_key_body = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sshPublicKeyBody.

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 UserCredential.Builder newBuilderForType()
Returns
Type Description
UserCredential.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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