Class Actor (0.29.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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Actor

Implements

ActorOrBuilder

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EMAIL_FIELD_NUMBER

public static final int EMAIL_FIELD_NUMBER
Field Value
Type Description
int

GOOGLE_SUPPORT_FIELD_NUMBER

public static final int GOOGLE_SUPPORT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Actor getDefaultInstance()
Returns
Type Description
Actor

getDescriptor()

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

newBuilder()

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

newBuilder(Actor prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Actor getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

The googleSupport.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Actor.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Actor.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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