Class AccessSummary (0.1.0)

public final class AccessSummary extends GeneratedMessage implements AccessSummaryOrBuilder

Message describing AccessSummary object

Protobuf type google.cloud.agentidentity.v1.AccessSummary

Static Fields

AUTH_PROVIDER_FIELD_NUMBER

public static final int AUTH_PROVIDER_FIELD_NUMBER
Field Value
Type Description
int

AUTH_PROVIDER_TYPE_FIELD_NUMBER

public static final int AUTH_PROVIDER_TYPE_FIELD_NUMBER
Field Value
Type Description
int

FIRST_ACCESS_TIME_FIELD_NUMBER

public static final int FIRST_ACCESS_TIME_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LAST_ACCESS_TIME_FIELD_NUMBER

public static final int LAST_ACCESS_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PURGE_TIME_FIELD_NUMBER

public static final int PURGE_TIME_FIELD_NUMBER
Field Value
Type Description
int

SCOPES_FIELD_NUMBER

public static final int SCOPES_FIELD_NUMBER
Field Value
Type Description
int

TOKEN_URL_FIELD_NUMBER

public static final int TOKEN_URL_FIELD_NUMBER
Field Value
Type Description
int

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER
Field Value
Type Description
int

WORKLOAD_ID_FIELD_NUMBER

public static final int WORKLOAD_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AccessSummary getDefaultInstance()
Returns
Type Description
AccessSummary

getDescriptor()

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

newBuilder()

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

newBuilder(AccessSummary prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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

getAuthProvider()

public String getAuthProvider()

Output only. The auth_provider that this access summary is associated with.

string auth_provider = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The authProvider.

getAuthProviderBytes()

public ByteString getAuthProviderBytes()

Output only. The auth_provider that this access summary is associated with.

string auth_provider = 9 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for authProvider.

getAuthProviderType()

public AuthProviderType getAuthProviderType()

Output only. The type of the connector that was used to create this access summary.

.google.cloud.agentidentity.v1.AuthProviderType auth_provider_type = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AuthProviderType

The authProviderType.

getAuthProviderTypeValue()

public int getAuthProviderTypeValue()

Output only. The type of the connector that was used to create this access summary.

.google.cloud.agentidentity.v1.AuthProviderType auth_provider_type = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for authProviderType.

getDefaultInstanceForType()

public AccessSummary getDefaultInstanceForType()
Returns
Type Description
AccessSummary

getFirstAccessTime()

public Timestamp getFirstAccessTime()

Output only. The first time this user has interacted with this workload. Rounded to the previous hour.

.google.protobuf.Timestamp first_access_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The firstAccessTime.

getFirstAccessTimeOrBuilder()

public TimestampOrBuilder getFirstAccessTimeOrBuilder()

Output only. The first time this user has interacted with this workload. Rounded to the previous hour.

.google.protobuf.Timestamp first_access_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

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

getLastAccessTime()

public Timestamp getLastAccessTime()

Output only. The most recent time this user has interacted with this workload. Rounded to the previous hour.

.google.protobuf.Timestamp last_access_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The lastAccessTime.

getLastAccessTimeOrBuilder()

public TimestampOrBuilder getLastAccessTimeOrBuilder()

Output only. The most recent time this user has interacted with this workload. Rounded to the previous hour.

.google.protobuf.Timestamp last_access_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getName()

public String getName()

Output only. Identifier. Name of the AccessSummary

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Identifier. Name of the AccessSummary

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPurgeTime()

public Timestamp getPurgeTime()

Output only. The time when this access summary is permanently deleted.

.google.protobuf.Timestamp purge_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The purgeTime.

getPurgeTimeOrBuilder()

public TimestampOrBuilder getPurgeTimeOrBuilder()

Output only. The time when this access summary is permanently deleted.

.google.protobuf.Timestamp purge_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getScopes(int index)

public String getScopes(int index)

Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200.

repeated string scopes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The scopes at the given index.

getScopesBytes(int index)

public ByteString getScopesBytes(int index)

Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200.

repeated string scopes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the scopes at the given index.

getScopesCount()

public int getScopesCount()

Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200.

repeated string scopes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of scopes.

getScopesList()

public ProtocolStringList getScopesList()

Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200.

repeated string scopes = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the scopes.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTokenUrl()

public String getTokenUrl()

Output only. The url of the authentication server that was accessed.

string token_url = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The tokenUrl.

getTokenUrlBytes()

public ByteString getTokenUrlBytes()

Output only. The url of the authentication server that was accessed.

string token_url = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for tokenUrl.

getUserId()

public String getUserId()

Output only. The user_id provided by the workload application for this user. Not verified by Google.

string user_id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The userId.

getUserIdBytes()

public ByteString getUserIdBytes()

Output only. The user_id provided by the workload application for this user. Not verified by Google.

string user_id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for userId.

getWorkloadId()

public String getWorkloadId()

Output only. The identity bound to the workload that this user interacted with to produce this AccessSummary. Will typically be an agentic spiffe id

string workload_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The workloadId.

getWorkloadIdBytes()

public ByteString getWorkloadIdBytes()

Output only. The identity bound to the workload that this user interacted with to produce this AccessSummary. Will typically be an agentic spiffe id

string workload_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for workloadId.

hasFirstAccessTime()

public boolean hasFirstAccessTime()

Output only. The first time this user has interacted with this workload. Rounded to the previous hour.

.google.protobuf.Timestamp first_access_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the firstAccessTime field is set.

hasLastAccessTime()

public boolean hasLastAccessTime()

Output only. The most recent time this user has interacted with this workload. Rounded to the previous hour.

.google.protobuf.Timestamp last_access_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the lastAccessTime field is set.

hasPurgeTime()

public boolean hasPurgeTime()

Output only. The time when this access summary is permanently deleted.

.google.protobuf.Timestamp purge_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the purgeTime 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 AccessSummary.Builder newBuilderForType()
Returns
Type Description
AccessSummary.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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