public final class Entitlement extends GeneratedMessageV3 implements EntitlementOrBuilder
An entitlement defines the eligibility of a set of users to obtain
predefined access for some time possibly after going through an approval
workflow.
Protobuf type google.cloud.privilegedaccessmanager.v1.Entitlement
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ADDITIONAL_NOTIFICATION_TARGETS_FIELD_NUMBER
public static final int ADDITIONAL_NOTIFICATION_TARGETS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
APPROVAL_WORKFLOW_FIELD_NUMBER
public static final int APPROVAL_WORKFLOW_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ELIGIBLE_USERS_FIELD_NUMBER
public static final int ELIGIBLE_USERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_REQUEST_DURATION_FIELD_NUMBER
public static final int MAX_REQUEST_DURATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PRIVILEGED_ACCESS_FIELD_NUMBER
public static final int PRIVILEGED_ACCESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUESTER_JUSTIFICATION_CONFIG_FIELD_NUMBER
public static final int REQUESTER_JUSTIFICATION_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Entitlement getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Entitlement.Builder newBuilder()
newBuilder(Entitlement prototype)
public static Entitlement.Builder newBuilder(Entitlement prototype)
public static Entitlement parseDelimitedFrom(InputStream input)
public static Entitlement parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Entitlement parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Entitlement parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Entitlement parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Entitlement parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Entitlement parseFrom(CodedInputStream input)
public static Entitlement parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Entitlement parseFrom(InputStream input)
public static Entitlement parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Entitlement parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Entitlement parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Entitlement> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAdditionalNotificationTargets()
public 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];
getAdditionalNotificationTargetsOrBuilder()
public 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];
getApprovalWorkflow()
public 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];
getApprovalWorkflowOrBuilder()
public 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];
getCreateTime()
public 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 TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Create time stamp.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Entitlement getDefaultInstanceForType()
getEligibleUsers(int index)
public 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
|
getEligibleUsersCount()
public 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 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];
getEligibleUsersOrBuilder(int index)
public 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
|
getEligibleUsersOrBuilderList()
public 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()
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 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 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 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];
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 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.
|
getParserForType()
public Parser<Entitlement> getParserForType()
Overrides
getPrivilegedAccess()
public PrivilegedAccess getPrivilegedAccess()
The access granted to a requester on successful approval.
.google.cloud.privilegedaccessmanager.v1.PrivilegedAccess privileged_access = 7;
getPrivilegedAccessOrBuilder()
public PrivilegedAccessOrBuilder getPrivilegedAccessOrBuilder()
The access granted to a requester on successful approval.
.google.cloud.privilegedaccessmanager.v1.PrivilegedAccess privileged_access = 7;
getRequesterJustificationConfig()
public 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];
getRequesterJustificationConfigOrBuilder()
public 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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getState()
public Entitlement.State getState()
Output only. Current state of this entitlement.
.google.cloud.privilegedaccessmanager.v1.Entitlement.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public 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 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 TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Update time stamp.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasAdditionalNotificationTargets()
public 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 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 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 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 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 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Entitlement.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Entitlement.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Entitlement.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
