Class Actor (0.21.0)

public final class Actor extends GeneratedMessageV3 implements ActorOrBuilder

An object containing information about the effective user and authenticated principal responsible for an action.

Protobuf type google.cloud.support.v2.Actor

Implements

ActorOrBuilder

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

EMAIL_FIELD_NUMBER

public static final int EMAIL_FIELD_NUMBER
Field Value
TypeDescription
int

GOOGLE_SUPPORT_FIELD_NUMBER

public static final int GOOGLE_SUPPORT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Actor getDefaultInstance()
Returns
TypeDescription
Actor

getDescriptor()

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

newBuilder()

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

newBuilder(Actor prototype)

public static Actor.Builder newBuilder(Actor prototype)
Parameter
NameDescription
prototypeActor
Returns
TypeDescription
Actor.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Actor getDefaultInstanceForType()
Returns
TypeDescription
Actor

getDisplayName()

public String getDisplayName()

The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.

string display_name = 1;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.

string display_name = 1;

Returns
TypeDescription
ByteString

The bytes for displayName.

getEmail()

public String getEmail()

The email address of the actor. If not provided, it is inferred from credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.

string email = 2;

Returns
TypeDescription
String

The email.

getEmailBytes()

public ByteString getEmailBytes()

The email address of the actor. If not provided, it is inferred from credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.

string email = 2;

Returns
TypeDescription
ByteString

The bytes for email.

getGoogleSupport()

public boolean getGoogleSupport()

Output only. Whether the actor is a Google support actor.

bool google_support = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

The googleSupport.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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