Interface EntitlementOrBuilder (0.3.0) 

public interface EntitlementOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdditionalNotificationTargets()

public abstract Entitlement.AdditionalNotificationTargets getAdditionalNotificationTargets()

Optional. Additional email addresses to be notified based on actions taken.

.google.cloud.privilegedaccessmanager.v1.Entitlement.AdditionalNotificationTargets additional_notification_targets = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Entitlement.AdditionalNotificationTargets

The additionalNotificationTargets.

getAdditionalNotificationTargetsOrBuilder()

public abstract Entitlement.AdditionalNotificationTargetsOrBuilder getAdditionalNotificationTargetsOrBuilder()

Optional. Additional email addresses to be notified based on actions taken.

.google.cloud.privilegedaccessmanager.v1.Entitlement.AdditionalNotificationTargets additional_notification_targets = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Entitlement.AdditionalNotificationTargetsOrBuilder

getApprovalWorkflow()

public abstract ApprovalWorkflow getApprovalWorkflow()

Optional. The approvals needed before access are granted to a requester. No approvals are needed if this field is null.

.google.cloud.privilegedaccessmanager.v1.ApprovalWorkflow approval_workflow = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ApprovalWorkflow

The approvalWorkflow.

getApprovalWorkflowOrBuilder()

public abstract ApprovalWorkflowOrBuilder getApprovalWorkflowOrBuilder()

Optional. The approvals needed before access are granted to a requester. No approvals are needed if this field is null.

.google.cloud.privilegedaccessmanager.v1.ApprovalWorkflow approval_workflow = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ApprovalWorkflowOrBuilder

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

getEligibleUsers(int index)

public abstract AccessControlEntry getEligibleUsers(int index)

Optional. Who can create grants using this entitlement. This list should contain at most one entry.

repeated .google.cloud.privilegedaccessmanager.v1.AccessControlEntry eligible_users = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AccessControlEntry

getEligibleUsersCount()

public abstract int getEligibleUsersCount()

Optional. Who can create grants using this entitlement. This list should contain at most one entry.

repeated .google.cloud.privilegedaccessmanager.v1.AccessControlEntry eligible_users = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getEligibleUsersList()

public abstract List<AccessControlEntry> getEligibleUsersList()

Optional. Who can create grants using this entitlement. This list should contain at most one entry.

repeated .google.cloud.privilegedaccessmanager.v1.AccessControlEntry eligible_users = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<AccessControlEntry>

getEligibleUsersOrBuilder(int index)

public abstract AccessControlEntryOrBuilder getEligibleUsersOrBuilder(int index)

Optional. Who can create grants using this entitlement. This list should contain at most one entry.

repeated .google.cloud.privilegedaccessmanager.v1.AccessControlEntry eligible_users = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AccessControlEntryOrBuilder

getEligibleUsersOrBuilderList()

public abstract List<? extends AccessControlEntryOrBuilder> getEligibleUsersOrBuilderList()

Optional. Who can create grants using this entitlement. This list should contain at most one entry.

repeated .google.cloud.privilegedaccessmanager.v1.AccessControlEntry eligible_users = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.privilegedaccessmanager.v1.AccessControlEntryOrBuilder>

getEtag()

public abstract String getEtag()

An etag is used for optimistic concurrency control as a way to prevent simultaneous updates to the same entitlement. An etag is returned in the response to GetEntitlement and the caller should put the etag in the request to UpdateEntitlement so that their change is applied on the same version. If this field is omitted or if there is a mismatch while updating an entitlement, then the server rejects the request.

string etag = 12;

Returns
Type Description
String

The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

An etag is used for optimistic concurrency control as a way to prevent simultaneous updates to the same entitlement. An etag is returned in the response to GetEntitlement and the caller should put the etag in the request to UpdateEntitlement so that their change is applied on the same version. If this field is omitted or if there is a mismatch while updating an entitlement, then the server rejects the request.

string etag = 12;

Returns
Type Description
ByteString

The bytes for etag.

getMaxRequestDuration()

public abstract Duration getMaxRequestDuration()

Required. The maximum amount of time that access is granted for a request. A requester can ask for a duration less than this, but never more.

.google.protobuf.Duration max_request_duration = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Duration

The maxRequestDuration.

getMaxRequestDurationOrBuilder()

public abstract DurationOrBuilder getMaxRequestDurationOrBuilder()

Required. The maximum amount of time that access is granted for a request. A requester can ask for a duration less than this, but never more.

.google.protobuf.Duration max_request_duration = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DurationOrBuilder

getName()

public abstract String getName()

Identifier. Name of the entitlement. Possible formats:

  • organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}
  • folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}
  • projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. Name of the entitlement. Possible formats:

  • organizations/{organization-number}/locations/{region}/entitlements/{entitlement-id}
  • folders/{folder-number}/locations/{region}/entitlements/{entitlement-id}
  • projects/{project-id|project-number}/locations/{region}/entitlements/{entitlement-id}

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

Returns
Type Description
ByteString

The bytes for name.

getPrivilegedAccess()

public abstract PrivilegedAccess getPrivilegedAccess()

The access granted to a requester on successful approval.

.google.cloud.privilegedaccessmanager.v1.PrivilegedAccess privileged_access = 7;

Returns
Type Description
PrivilegedAccess

The privilegedAccess.

getPrivilegedAccessOrBuilder()

public abstract PrivilegedAccessOrBuilder getPrivilegedAccessOrBuilder()

The access granted to a requester on successful approval.

.google.cloud.privilegedaccessmanager.v1.PrivilegedAccess privileged_access = 7;

Returns
Type Description
PrivilegedAccessOrBuilder

getRequesterJustificationConfig()

public abstract Entitlement.RequesterJustificationConfig getRequesterJustificationConfig()

Required. The manner in which the requester should provide a justification for requesting access.

.google.cloud.privilegedaccessmanager.v1.Entitlement.RequesterJustificationConfig requester_justification_config = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Entitlement.RequesterJustificationConfig

The requesterJustificationConfig.

getRequesterJustificationConfigOrBuilder()

public abstract Entitlement.RequesterJustificationConfigOrBuilder getRequesterJustificationConfigOrBuilder()

Required. The manner in which the requester should provide a justification for requesting access.

.google.cloud.privilegedaccessmanager.v1.Entitlement.RequesterJustificationConfig requester_justification_config = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Entitlement.RequesterJustificationConfigOrBuilder

getState()

public abstract Entitlement.State getState()

Output only. Current state of this entitlement.

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

Returns
Type Description
Entitlement.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. Current state of this entitlement.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

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

hasAdditionalNotificationTargets()

public abstract boolean hasAdditionalNotificationTargets()

Optional. Additional email addresses to be notified based on actions taken.

.google.cloud.privilegedaccessmanager.v1.Entitlement.AdditionalNotificationTargets additional_notification_targets = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the additionalNotificationTargets field is set.

hasApprovalWorkflow()

public abstract boolean hasApprovalWorkflow()

Optional. The approvals needed before access are granted to a requester. No approvals are needed if this field is null.

.google.cloud.privilegedaccessmanager.v1.ApprovalWorkflow approval_workflow = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the approvalWorkflow 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.

hasMaxRequestDuration()

public abstract boolean hasMaxRequestDuration()

Required. The maximum amount of time that access is granted for a request. A requester can ask for a duration less than this, but never more.

.google.protobuf.Duration max_request_duration = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the maxRequestDuration field is set.

hasPrivilegedAccess()

public abstract boolean hasPrivilegedAccess()

The access granted to a requester on successful approval.

.google.cloud.privilegedaccessmanager.v1.PrivilegedAccess privileged_access = 7;

Returns
Type Description
boolean

Whether the privilegedAccess field is set.

hasRequesterJustificationConfig()

public abstract boolean hasRequesterJustificationConfig()

Required. The manner in which the requester should provide a justification for requesting access.

.google.cloud.privilegedaccessmanager.v1.Entitlement.RequesterJustificationConfig requester_justification_config = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the requesterJustificationConfig 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.