Interface AccessOrBuilder (2.17.0)

Version 2.17.0

• 2.63.0 (latest)
• 2.62.0
• 2.61.0
• 2.60.0
• 2.59.0
• 2.57.0
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.1
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.1
• 2.6.0
• 2.5.6
• 2.3.2

public interface AccessOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCallerIp()

public abstract String getCallerIp()

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

string caller_ip = 2;

Returns

Type	Description
String	The callerIp.

getCallerIpBytes()

public abstract ByteString getCallerIpBytes()

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

string caller_ip = 2;

Returns

Type	Description
ByteString	The bytes for callerIp.

getCallerIpGeo()

public abstract Geolocation getCallerIpGeo()

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

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

Returns

Type	Description
Geolocation	The callerIpGeo.

getCallerIpGeoOrBuilder()

public abstract GeolocationOrBuilder getCallerIpGeoOrBuilder()

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

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

Returns

Type	Description
GeolocationOrBuilder

getMethodName()

public abstract String getMethodName()

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

string method_name = 6;

Returns

Type	Description
String	The methodName.

getMethodNameBytes()

public abstract ByteString getMethodNameBytes()

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

string method_name = 6;

Returns

Type	Description
ByteString	The bytes for methodName.

getPrincipalEmail()

public abstract String getPrincipalEmail()

Associated email, such as "[e-mail]". 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

Type	Description
String	The principalEmail.

getPrincipalEmailBytes()

public abstract ByteString getPrincipalEmailBytes()

Associated email, such as "[e-mail]". 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

Type	Description
ByteString	The bytes for principalEmail.

getPrincipalSubject()

public abstract 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

Type	Description
String	The principalSubject.

getPrincipalSubjectBytes()

public abstract 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

Type	Description
ByteString	The bytes for principalSubject.

getServiceAccountDelegationInfo(int index)

public abstract 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

Name	Description
index	int

Returns

Type	Description
ServiceAccountDelegationInfo

getServiceAccountDelegationInfoCount()

public abstract 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

Type	Description
int

getServiceAccountDelegationInfoList()

public abstract 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

Type	Description
List<ServiceAccountDelegationInfo>

getServiceAccountDelegationInfoOrBuilder(int index)

public abstract 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

Name	Description
index	int

Returns

Type	Description
ServiceAccountDelegationInfoOrBuilder

getServiceAccountDelegationInfoOrBuilderList()

public abstract 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

Type	Description
List<? extends com.google.cloud.securitycenter.v1.ServiceAccountDelegationInfoOrBuilder>

getServiceAccountKeyName()

public abstract 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

Type	Description
String	The serviceAccountKeyName.

getServiceAccountKeyNameBytes()

public abstract 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

Type	Description
ByteString	The bytes for serviceAccountKeyName.

getServiceName()

public abstract 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

Type	Description
String	The serviceName.

getServiceNameBytes()

public abstract 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

Type	Description
ByteString	The bytes for serviceName.

getUserAgentFamily()

public abstract 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

Type	Description
String	The userAgentFamily.

getUserAgentFamilyBytes()

public abstract 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

Type	Description
ByteString	The bytes for userAgentFamily.

getUserName()

public abstract 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

Type	Description
String	The userName.

getUserNameBytes()

public abstract 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

Type	Description
ByteString	The bytes for userName.

hasCallerIpGeo()

public abstract boolean hasCallerIpGeo()

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

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

Returns

Type	Description
boolean	Whether the callerIpGeo field is set.