Class Access (2.16.0)

public final class Access extends GeneratedMessageV3 implements AccessOrBuilder

Represents an access event.

Protobuf type google.cloud.securitycenter.v1.Access

Implements

AccessOrBuilder

Static Fields

CALLER_IP_FIELD_NUMBER

public static final int CALLER_IP_FIELD_NUMBER
Field Value
TypeDescription
int

CALLER_IP_GEO_FIELD_NUMBER

public static final int CALLER_IP_GEO_FIELD_NUMBER
Field Value
TypeDescription
int

METHOD_NAME_FIELD_NUMBER

public static final int METHOD_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PRINCIPAL_EMAIL_FIELD_NUMBER

public static final int PRINCIPAL_EMAIL_FIELD_NUMBER
Field Value
TypeDescription
int

PRINCIPAL_SUBJECT_FIELD_NUMBER

public static final int PRINCIPAL_SUBJECT_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_DELEGATION_INFO_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_DELEGATION_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_KEY_NAME_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_KEY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_NAME_FIELD_NUMBER

public static final int SERVICE_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

USER_AGENT_FAMILY_FIELD_NUMBER

public static final int USER_AGENT_FAMILY_FIELD_NUMBER
Field Value
TypeDescription
int

USER_NAME_FIELD_NUMBER

public static final int USER_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Access getDefaultInstance()
Returns
TypeDescription
Access

getDescriptor()

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

newBuilder()

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

newBuilder(Access prototype)

public static Access.Builder newBuilder(Access prototype)
Parameter
NameDescription
prototypeAccess
Returns
TypeDescription
Access.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCallerIp()

public String getCallerIp()

Caller's IP address, such as "1.1.1.1".

string caller_ip = 2;

Returns
TypeDescription
String

The callerIp.

getCallerIpBytes()

public ByteString getCallerIpBytes()

Caller's IP address, such as "1.1.1.1".

string caller_ip = 2;

Returns
TypeDescription
ByteString

The bytes for callerIp.

getCallerIpGeo()

public Geolocation getCallerIpGeo()

The caller IP's geolocation, which identifies where the call came from.

.google.cloud.securitycenter.v1.Geolocation caller_ip_geo = 3;

Returns
TypeDescription
Geolocation

The callerIpGeo.

getCallerIpGeoOrBuilder()

public GeolocationOrBuilder getCallerIpGeoOrBuilder()

The caller IP's geolocation, which identifies where the call came from.

.google.cloud.securitycenter.v1.Geolocation caller_ip_geo = 3;

Returns
TypeDescription
GeolocationOrBuilder

getDefaultInstanceForType()

public Access getDefaultInstanceForType()
Returns
TypeDescription
Access

getMethodName()

public String getMethodName()

The method that the service account called, e.g. "SetIamPolicy".

string method_name = 6;

Returns
TypeDescription
String

The methodName.

getMethodNameBytes()

public ByteString getMethodNameBytes()

The method that the service account called, e.g. "SetIamPolicy".

string method_name = 6;

Returns
TypeDescription
ByteString

The bytes for methodName.

getParserForType()

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

getPrincipalEmail()

public String getPrincipalEmail()

Associated email, such as "foo@google.com". The email address of the authenticated user (or service account on behalf of third party principal) making the request. For third party identity callers, the principal_subject field is populated instead of this field. For privacy reasons, the principal email address is sometimes redacted. For more information, see Caller identities in audit logs.

string principal_email = 1;

Returns
TypeDescription
String

The principalEmail.

getPrincipalEmailBytes()

public ByteString getPrincipalEmailBytes()

Associated email, such as "foo@google.com". The email address of the authenticated user (or service account on behalf of third party principal) making the request. For third party identity callers, the principal_subject field is populated instead of this field. For privacy reasons, the principal email address is sometimes redacted. For more information, see Caller identities in audit logs.

string principal_email = 1;

Returns
TypeDescription
ByteString

The bytes for principalEmail.

getPrincipalSubject()

public String getPrincipalSubject()

A string representing the principal_subject associated with the identity. As compared to principal_email, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be principal://iam.googleapis.com/{identity pool name}/subjects/{subject} except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format serviceAccount:{identity pool name}[{subject}]

string principal_subject = 7;

Returns
TypeDescription
String

The principalSubject.

getPrincipalSubjectBytes()

public ByteString getPrincipalSubjectBytes()

A string representing the principal_subject associated with the identity. As compared to principal_email, supports principals that aren't associated with email addresses, such as third party principals. For most identities, the format will be principal://iam.googleapis.com/{identity pool name}/subjects/{subject} except for some GKE identities (GKE_WORKLOAD, FREEFORM, GKE_HUB_WORKLOAD) that are still in the legacy format serviceAccount:{identity pool name}[{subject}]

string principal_subject = 7;

Returns
TypeDescription
ByteString

The bytes for principalSubject.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getServiceAccountDelegationInfo(int index)

public ServiceAccountDelegationInfo getServiceAccountDelegationInfo(int index)

Identity delegation history of an authenticated service account that makes the request. It contains information on the real authorities that try to access GCP resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.

repeated .google.cloud.securitycenter.v1.ServiceAccountDelegationInfo service_account_delegation_info = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
ServiceAccountDelegationInfo

getServiceAccountDelegationInfoCount()

public int getServiceAccountDelegationInfoCount()

Identity delegation history of an authenticated service account that makes the request. It contains information on the real authorities that try to access GCP resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.

repeated .google.cloud.securitycenter.v1.ServiceAccountDelegationInfo service_account_delegation_info = 9;

Returns
TypeDescription
int

getServiceAccountDelegationInfoList()

public List<ServiceAccountDelegationInfo> getServiceAccountDelegationInfoList()

Identity delegation history of an authenticated service account that makes the request. It contains information on the real authorities that try to access GCP resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.

repeated .google.cloud.securitycenter.v1.ServiceAccountDelegationInfo service_account_delegation_info = 9;

Returns
TypeDescription
List<ServiceAccountDelegationInfo>

getServiceAccountDelegationInfoOrBuilder(int index)

public ServiceAccountDelegationInfoOrBuilder getServiceAccountDelegationInfoOrBuilder(int index)

Identity delegation history of an authenticated service account that makes the request. It contains information on the real authorities that try to access GCP resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.

repeated .google.cloud.securitycenter.v1.ServiceAccountDelegationInfo service_account_delegation_info = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
ServiceAccountDelegationInfoOrBuilder

getServiceAccountDelegationInfoOrBuilderList()

public List<? extends ServiceAccountDelegationInfoOrBuilder> getServiceAccountDelegationInfoOrBuilderList()

Identity delegation history of an authenticated service account that makes the request. It contains information on the real authorities that try to access GCP resources by delegating on a service account. When multiple authorities are present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.

repeated .google.cloud.securitycenter.v1.ServiceAccountDelegationInfo service_account_delegation_info = 9;

Returns
TypeDescription
List<? extends com.google.cloud.securitycenter.v1.ServiceAccountDelegationInfoOrBuilder>

getServiceAccountKeyName()

public String getServiceAccountKeyName()

The name of the service account key used to create or exchange credentials for authenticating the service account making the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}"

string service_account_key_name = 8;

Returns
TypeDescription
String

The serviceAccountKeyName.

getServiceAccountKeyNameBytes()

public ByteString getServiceAccountKeyNameBytes()

The name of the service account key used to create or exchange credentials for authenticating the service account making the request. This is a scheme-less URI full resource name. For example: "//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}"

string service_account_key_name = 8;

Returns
TypeDescription
ByteString

The bytes for serviceAccountKeyName.

getServiceName()

public String getServiceName()

This is the API service that the service account made a call to, e.g. "iam.googleapis.com"

string service_name = 5;

Returns
TypeDescription
String

The serviceName.

getServiceNameBytes()

public ByteString getServiceNameBytes()

This is the API service that the service account made a call to, e.g. "iam.googleapis.com"

string service_name = 5;

Returns
TypeDescription
ByteString

The bytes for serviceName.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUserAgentFamily()

public String getUserAgentFamily()

What kind of user agent is associated, for example operating system shells, embedded or stand-alone applications, etc.

string user_agent_family = 4;

Returns
TypeDescription
String

The userAgentFamily.

getUserAgentFamilyBytes()

public ByteString getUserAgentFamilyBytes()

What kind of user agent is associated, for example operating system shells, embedded or stand-alone applications, etc.

string user_agent_family = 4;

Returns
TypeDescription
ByteString

The bytes for userAgentFamily.

getUserName()

public String getUserName()

A string that represents the username of a user, user account, or other entity involved in the access event. What the entity is and what its role in the access event is depends on the finding that this field appears in. The entity is likely not an IAM principal, but could be a user that is logged into an operating system, if the finding is VM-related, or a user that is logged into some type of application that is involved in the access event.

string user_name = 11;

Returns
TypeDescription
String

The userName.

getUserNameBytes()

public ByteString getUserNameBytes()

A string that represents the username of a user, user account, or other entity involved in the access event. What the entity is and what its role in the access event is depends on the finding that this field appears in. The entity is likely not an IAM principal, but could be a user that is logged into an operating system, if the finding is VM-related, or a user that is logged into some type of application that is involved in the access event.

string user_name = 11;

Returns
TypeDescription
ByteString

The bytes for userName.

hasCallerIpGeo()

public boolean hasCallerIpGeo()

The caller IP's geolocation, which identifies where the call came from.

.google.cloud.securitycenter.v1.Geolocation caller_ip_geo = 3;

Returns
TypeDescription
boolean

Whether the callerIpGeo field is set.

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 Access.Builder newBuilderForType()
Returns
TypeDescription
Access.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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