com.google.cloud.securitycenter.v1

Interface AccessOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Access, Access.Builder

public interface AccessOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getCallerIp() Caller's IP address, such as "1.1.1.1".
com.google.protobuf.ByteString	getCallerIpBytes() Caller's IP address, such as "1.1.1.1".
Geolocation	getCallerIpGeo() The caller IP's geolocation, which identifies where the call came from.
GeolocationOrBuilder	getCallerIpGeoOrBuilder() The caller IP's geolocation, which identifies where the call came from.
String	getMethodName() The method that the service account called, e.g.
com.google.protobuf.ByteString	getMethodNameBytes() The method that the service account called, e.g.
String	getPrincipalEmail() Associated email, such as "foo@google.com".
com.google.protobuf.ByteString	getPrincipalEmailBytes() Associated email, such as "foo@google.com".
String	getPrincipalSubject() A string that represents the principal_subject that is associated with the identity.
com.google.protobuf.ByteString	getPrincipalSubjectBytes() A string that represents the principal_subject that is associated with the identity.
ServiceAccountDelegationInfo	getServiceAccountDelegationInfo(int index) The identity delegation history of an authenticated service account that made the request.
int	getServiceAccountDelegationInfoCount() The identity delegation history of an authenticated service account that made the request.
List<ServiceAccountDelegationInfo>	getServiceAccountDelegationInfoList() The identity delegation history of an authenticated service account that made the request.
ServiceAccountDelegationInfoOrBuilder	getServiceAccountDelegationInfoOrBuilder(int index) The identity delegation history of an authenticated service account that made the request.
List<? extends ServiceAccountDelegationInfoOrBuilder>	getServiceAccountDelegationInfoOrBuilderList() The identity delegation history of an authenticated service account that made the request.
String	getServiceAccountKeyName() The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request.
com.google.protobuf.ByteString	getServiceAccountKeyNameBytes() The name of the service account key that was used to create or exchange credentials when authenticating the service account that made the request.
String	getServiceName() This is the API service that the service account made a call to, e.g.
com.google.protobuf.ByteString	getServiceNameBytes() This is the API service that the service account made a call to, e.g.
String	getUserAgent() The caller's user agent string associated with the finding.
com.google.protobuf.ByteString	getUserAgentBytes() The caller's user agent string associated with the finding.
String	getUserAgentFamily() Type of user agent associated with the finding.
com.google.protobuf.ByteString	getUserAgentFamilyBytes() Type of user agent associated with the finding.
String	getUserName() A string that represents a username.
com.google.protobuf.ByteString	getUserNameBytes() A string that represents a username.
boolean	hasCallerIpGeo() The caller IP's geolocation, which identifies where the call came from.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getPrincipalEmail

String getPrincipalEmail()

 Associated email, such as "foo@google.com".

 The email address of the authenticated user or a service account acting on
 behalf of a 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](https://cloud.google.com/logging/docs/audit#user-id).
 

string principal_email = 1;

Returns:

The principalEmail.

getPrincipalEmailBytes

com.google.protobuf.ByteString getPrincipalEmailBytes()

 Associated email, such as "foo@google.com".

 The email address of the authenticated user or a service account acting on
 behalf of a 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](https://cloud.google.com/logging/docs/audit#user-id).
 

string principal_email = 1;

Returns:

The bytes for principalEmail.

getCallerIp

String getCallerIp()

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

string caller_ip = 2;

Returns:

The callerIp.

getCallerIpBytes

com.google.protobuf.ByteString getCallerIpBytes()

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

string caller_ip = 2;

Returns:

The bytes for callerIp.

hasCallerIpGeo

boolean hasCallerIpGeo()

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

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

Returns:

Whether the callerIpGeo field is set.

getCallerIpGeo

Geolocation getCallerIpGeo()

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

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

Returns:

The callerIpGeo.

getCallerIpGeoOrBuilder

GeolocationOrBuilder getCallerIpGeoOrBuilder()

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

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

getUserAgentFamily

String getUserAgentFamily()

 Type of user agent associated with the finding. For example, an operating
 system shell or an embedded or standalone application.
 

string user_agent_family = 4;

Returns:

The userAgentFamily.

getUserAgentFamilyBytes

com.google.protobuf.ByteString getUserAgentFamilyBytes()

 Type of user agent associated with the finding. For example, an operating
 system shell or an embedded or standalone application.
 

string user_agent_family = 4;

Returns:

The bytes for userAgentFamily.

getUserAgent

String getUserAgent()

 The caller's user agent string associated with the finding.
 

string user_agent = 12;

Returns:

The userAgent.

getUserAgentBytes

com.google.protobuf.ByteString getUserAgentBytes()

 The caller's user agent string associated with the finding.
 

string user_agent = 12;

Returns:

The bytes for userAgent.

getServiceName

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:

The serviceName.

getServiceNameBytes

com.google.protobuf.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:

The bytes for serviceName.

getMethodName

String getMethodName()

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

string method_name = 6;

Returns:

The methodName.

getMethodNameBytes

com.google.protobuf.ByteString getMethodNameBytes()

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

string method_name = 6;

Returns:

The bytes for methodName.

getPrincipalSubject

String getPrincipalSubject()

 A string that represents the principal_subject that is associated with the
 identity. Unlike `principal_email`, `principal_subject` supports principals
 that aren't associated with email addresses, such as third party
 principals. For most identities, the format is
 `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`.
 Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD,
 still use the legacy format `serviceAccount:{identity pool
 name}[{subject}]`.
 

string principal_subject = 7;

Returns:

The principalSubject.

getPrincipalSubjectBytes

com.google.protobuf.ByteString getPrincipalSubjectBytes()

 A string that represents the principal_subject that is associated with the
 identity. Unlike `principal_email`, `principal_subject` supports principals
 that aren't associated with email addresses, such as third party
 principals. For most identities, the format is
 `principal://iam.googleapis.com/{identity pool name}/subject/{subject}`.
 Some GKE identities, such as GKE_WORKLOAD, FREEFORM, and GKE_HUB_WORKLOAD,
 still use the legacy format `serviceAccount:{identity pool
 name}[{subject}]`.
 

string principal_subject = 7;

Returns:

The bytes for principalSubject.

getServiceAccountKeyName

String getServiceAccountKeyName()

 The name of the service account key that was used to create or exchange
 credentials when authenticating the service account that made 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:

The serviceAccountKeyName.

getServiceAccountKeyNameBytes

com.google.protobuf.ByteString getServiceAccountKeyNameBytes()

 The name of the service account key that was used to create or exchange
 credentials when authenticating the service account that made 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:

The bytes for serviceAccountKeyName.

getServiceAccountDelegationInfoList

List<ServiceAccountDelegationInfo> getServiceAccountDelegationInfoList()

 The identity delegation history of an authenticated service account that
 made the request. The `serviceAccountDelegationInfo[]` object contains
 information about the real authorities that try to access Google Cloud
 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;

getServiceAccountDelegationInfo

ServiceAccountDelegationInfo getServiceAccountDelegationInfo(int index)

 The identity delegation history of an authenticated service account that
 made the request. The `serviceAccountDelegationInfo[]` object contains
 information about the real authorities that try to access Google Cloud
 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;

getServiceAccountDelegationInfoCount

int getServiceAccountDelegationInfoCount()

 The identity delegation history of an authenticated service account that
 made the request. The `serviceAccountDelegationInfo[]` object contains
 information about the real authorities that try to access Google Cloud
 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;

getServiceAccountDelegationInfoOrBuilderList

List<? extends ServiceAccountDelegationInfoOrBuilder> getServiceAccountDelegationInfoOrBuilderList()

 The identity delegation history of an authenticated service account that
 made the request. The `serviceAccountDelegationInfo[]` object contains
 information about the real authorities that try to access Google Cloud
 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;

getServiceAccountDelegationInfoOrBuilder

ServiceAccountDelegationInfoOrBuilder getServiceAccountDelegationInfoOrBuilder(int index)

 The identity delegation history of an authenticated service account that
 made the request. The `serviceAccountDelegationInfo[]` object contains
 information about the real authorities that try to access Google Cloud
 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;

getUserName

String getUserName()

 A string that represents a username. The username provided depends on the
 type of the finding and is likely not an IAM principal. For example, this
 can be a system username if the finding is related to a virtual machine, or
 it can be an application login username.
 

string user_name = 11;

Returns:

The userName.

getUserNameBytes

com.google.protobuf.ByteString getUserNameBytes()

 A string that represents a username. The username provided depends on the
 type of the finding and is likely not an IAM principal. For example, this
 can be a system username if the finding is related to a virtual machine, or
 it can be an application login username.
 

string user_name = 11;

Returns:

The bytes for userName.