Interface GrantOrBuilder (0.3.0) 

public interface GrantOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdditionalEmailRecipients(int index)

public abstract String getAdditionalEmailRecipients(int index)

Optional. Additional email addresses to notify for all the actions performed on the grant.

repeated string additional_email_recipients = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The additionalEmailRecipients at the given index.

getAdditionalEmailRecipientsBytes(int index)

public abstract ByteString getAdditionalEmailRecipientsBytes(int index)

Optional. Additional email addresses to notify for all the actions performed on the grant.

repeated string additional_email_recipients = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the additionalEmailRecipients at the given index.

getAdditionalEmailRecipientsCount()

public abstract int getAdditionalEmailRecipientsCount()

Optional. Additional email addresses to notify for all the actions performed on the grant.

repeated string additional_email_recipients = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of additionalEmailRecipients.

getAdditionalEmailRecipientsList()

public abstract List<String> getAdditionalEmailRecipientsList()

Optional. Additional email addresses to notify for all the actions performed on the grant.

repeated string additional_email_recipients = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the additionalEmailRecipients.

getAuditTrail()

public abstract Grant.AuditTrail getAuditTrail()

Output only. Audit trail of access provided by this grant. If unspecified then access was never granted.

.google.cloud.privilegedaccessmanager.v1.Grant.AuditTrail audit_trail = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Grant.AuditTrail

The auditTrail.

getAuditTrailOrBuilder()

public abstract Grant.AuditTrailOrBuilder getAuditTrailOrBuilder()

Output only. Audit trail of access provided by this grant. If unspecified then access was never granted.

.google.cloud.privilegedaccessmanager.v1.Grant.AuditTrail audit_trail = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Grant.AuditTrailOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Create time stamp.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time stamp.

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

Returns
Type Description
TimestampOrBuilder

getExternallyModified()

public abstract boolean getExternallyModified()

Output only. Flag set by the PAM system to indicate that policy bindings made by this grant have been modified from outside PAM.

After it is set, this flag remains set forever irrespective of the grant state. A true value here indicates that PAM no longer has any certainty on the access a user has because of this grant.

bool externally_modified = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The externallyModified.

getJustification()

public abstract Justification getJustification()

Optional. Justification of why this access is needed.

.google.cloud.privilegedaccessmanager.v1.Justification justification = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Justification

The justification.

getJustificationOrBuilder()

public abstract JustificationOrBuilder getJustificationOrBuilder()

Optional. Justification of why this access is needed.

.google.cloud.privilegedaccessmanager.v1.Justification justification = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
JustificationOrBuilder

getName()

public abstract String getName()

Identifier. Name of this grant. Possible formats:

  • organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}
  • folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}

  • projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}

    The last segment of this name ({grant-id}) is autogenerated.

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. Name of this grant. Possible formats:

  • organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}
  • folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}

  • projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}/grants/{grant-id}

    The last segment of this name ({grant-id}) is autogenerated.

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

Returns
Type Description
ByteString

The bytes for name.

getPrivilegedAccess()

public abstract PrivilegedAccess getPrivilegedAccess()

Output only. The access that would be granted by this grant.

.google.cloud.privilegedaccessmanager.v1.PrivilegedAccess privileged_access = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PrivilegedAccess

The privilegedAccess.

getPrivilegedAccessOrBuilder()

public abstract PrivilegedAccessOrBuilder getPrivilegedAccessOrBuilder()

Output only. The access that would be granted by this grant.

.google.cloud.privilegedaccessmanager.v1.PrivilegedAccess privileged_access = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PrivilegedAccessOrBuilder

getRequestedDuration()

public abstract Duration getRequestedDuration()

Required. The amount of time access is needed for. This value should be less than the max_request_duration value of the entitlement.

.google.protobuf.Duration requested_duration = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Duration

The requestedDuration.

getRequestedDurationOrBuilder()

public abstract DurationOrBuilder getRequestedDurationOrBuilder()

Required. The amount of time access is needed for. This value should be less than the max_request_duration value of the entitlement.

.google.protobuf.Duration requested_duration = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DurationOrBuilder

getRequester()

public abstract String getRequester()

Output only. Username of the user who created this grant.

string requester = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The requester.

getRequesterBytes()

public abstract ByteString getRequesterBytes()

Output only. Username of the user who created this grant.

string requester = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for requester.

getState()

public abstract Grant.State getState()

Output only. Current state of this grant.

.google.cloud.privilegedaccessmanager.v1.Grant.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Grant.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. Current state of this grant.

.google.cloud.privilegedaccessmanager.v1.Grant.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTimeline()

public abstract Grant.Timeline getTimeline()

Output only. Timeline of this grant.

.google.cloud.privilegedaccessmanager.v1.Grant.Timeline timeline = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Grant.Timeline

The timeline.

getTimelineOrBuilder()

public abstract Grant.TimelineOrBuilder getTimelineOrBuilder()

Output only. Timeline of this grant.

.google.cloud.privilegedaccessmanager.v1.Grant.Timeline timeline = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Grant.TimelineOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Update time stamp.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time stamp.

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

Returns
Type Description
TimestampOrBuilder

hasAuditTrail()

public abstract boolean hasAuditTrail()

Output only. Audit trail of access provided by this grant. If unspecified then access was never granted.

.google.cloud.privilegedaccessmanager.v1.Grant.AuditTrail audit_trail = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the auditTrail field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Create time stamp.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasJustification()

public abstract boolean hasJustification()

Optional. Justification of why this access is needed.

.google.cloud.privilegedaccessmanager.v1.Justification justification = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the justification field is set.

hasPrivilegedAccess()

public abstract boolean hasPrivilegedAccess()

Output only. The access that would be granted by this grant.

.google.cloud.privilegedaccessmanager.v1.PrivilegedAccess privileged_access = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the privilegedAccess field is set.

hasRequestedDuration()

public abstract boolean hasRequestedDuration()

Required. The amount of time access is needed for. This value should be less than the max_request_duration value of the entitlement.

.google.protobuf.Duration requested_duration = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the requestedDuration field is set.

hasTimeline()

public abstract boolean hasTimeline()

Output only. Timeline of this grant.

.google.cloud.privilegedaccessmanager.v1.Grant.Timeline timeline = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the timeline field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Update time stamp.

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

Returns
Type Description
boolean

Whether the updateTime field is set.