Class LoginProfile (2.40.0)

public final class LoginProfile extends GeneratedMessageV3 implements LoginProfileOrBuilder

The user profile information used for logging in to a virtual machine on Google Compute Engine.

Protobuf type google.cloud.oslogin.v1.LoginProfile

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

POSIX_ACCOUNTS_FIELD_NUMBER

public static final int POSIX_ACCOUNTS_FIELD_NUMBER
Field Value
TypeDescription
int

SSH_PUBLIC_KEYS_FIELD_NUMBER

public static final int SSH_PUBLIC_KEYS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static LoginProfile getDefaultInstance()
Returns
TypeDescription
LoginProfile

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static LoginProfile.Builder newBuilder()
Returns
TypeDescription
LoginProfile.Builder

newBuilder(LoginProfile prototype)

public static LoginProfile.Builder newBuilder(LoginProfile prototype)
Parameter
NameDescription
prototypeLoginProfile
Returns
TypeDescription
LoginProfile.Builder

parseDelimitedFrom(InputStream input)

public static LoginProfile parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
LoginProfile
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LoginProfile parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LoginProfile
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static LoginProfile parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
LoginProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LoginProfile parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LoginProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LoginProfile parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
LoginProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LoginProfile parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LoginProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LoginProfile parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
LoginProfile
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LoginProfile parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LoginProfile
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static LoginProfile parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
LoginProfile
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LoginProfile parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LoginProfile
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static LoginProfile parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
LoginProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LoginProfile parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LoginProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<LoginProfile> parser()
Returns
TypeDescription
Parser<LoginProfile>

Methods

containsSshPublicKeys(String key)

public boolean containsSshPublicKeys(String key)

A map from SSH public key fingerprint to the associated key object.

map<string, .google.cloud.oslogin.common.SshPublicKey> ssh_public_keys = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public LoginProfile getDefaultInstanceForType()
Returns
TypeDescription
LoginProfile

getName()

public String getName()

Required. A unique user ID.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. A unique user ID.

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<LoginProfile> getParserForType()
Returns
TypeDescription
Parser<LoginProfile>
Overrides

getPosixAccounts(int index)

public OsLoginProto.PosixAccount getPosixAccounts(int index)

The list of POSIX accounts associated with the user.

repeated .google.cloud.oslogin.common.PosixAccount posix_accounts = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
OsLoginProto.PosixAccount

getPosixAccountsCount()

public int getPosixAccountsCount()

The list of POSIX accounts associated with the user.

repeated .google.cloud.oslogin.common.PosixAccount posix_accounts = 2;

Returns
TypeDescription
int

getPosixAccountsList()

public List<OsLoginProto.PosixAccount> getPosixAccountsList()

The list of POSIX accounts associated with the user.

repeated .google.cloud.oslogin.common.PosixAccount posix_accounts = 2;

Returns
TypeDescription
List<PosixAccount>

getPosixAccountsOrBuilder(int index)

public OsLoginProto.PosixAccountOrBuilder getPosixAccountsOrBuilder(int index)

The list of POSIX accounts associated with the user.

repeated .google.cloud.oslogin.common.PosixAccount posix_accounts = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
OsLoginProto.PosixAccountOrBuilder

getPosixAccountsOrBuilderList()

public List<? extends OsLoginProto.PosixAccountOrBuilder> getPosixAccountsOrBuilderList()

The list of POSIX accounts associated with the user.

repeated .google.cloud.oslogin.common.PosixAccount posix_accounts = 2;

Returns
TypeDescription
List<? extends com.google.cloud.oslogin.common.OsLoginProto.PosixAccountOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSshPublicKeys() (deprecated)

public Map<String,OsLoginProto.SshPublicKey> getSshPublicKeys()
Returns
TypeDescription
Map<String,SshPublicKey>

getSshPublicKeysCount()

public int getSshPublicKeysCount()

A map from SSH public key fingerprint to the associated key object.

map<string, .google.cloud.oslogin.common.SshPublicKey> ssh_public_keys = 3;

Returns
TypeDescription
int

getSshPublicKeysMap()

public Map<String,OsLoginProto.SshPublicKey> getSshPublicKeysMap()

A map from SSH public key fingerprint to the associated key object.

map<string, .google.cloud.oslogin.common.SshPublicKey> ssh_public_keys = 3;

Returns
TypeDescription
Map<String,SshPublicKey>

getSshPublicKeysOrDefault(String key, OsLoginProto.SshPublicKey defaultValue)

public OsLoginProto.SshPublicKey getSshPublicKeysOrDefault(String key, OsLoginProto.SshPublicKey defaultValue)

A map from SSH public key fingerprint to the associated key object.

map<string, .google.cloud.oslogin.common.SshPublicKey> ssh_public_keys = 3;

Parameters
NameDescription
keyString
defaultValueOsLoginProto.SshPublicKey
Returns
TypeDescription
OsLoginProto.SshPublicKey

getSshPublicKeysOrThrow(String key)

public OsLoginProto.SshPublicKey getSshPublicKeysOrThrow(String key)

A map from SSH public key fingerprint to the associated key object.

map<string, .google.cloud.oslogin.common.SshPublicKey> ssh_public_keys = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
OsLoginProto.SshPublicKey

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public LoginProfile.Builder newBuilderForType()
Returns
TypeDescription
LoginProfile.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LoginProfile.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
LoginProfile.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public LoginProfile.Builder toBuilder()
Returns
TypeDescription
LoginProfile.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException