public static final class Entitlement.Builder extends GeneratedMessageV3.Builder<Entitlement.Builder> implements EntitlementOrBuilderAn 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Entitlement.BuilderImplements
EntitlementOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllEligibleUsers(Iterable<? extends AccessControlEntry> values)
public Entitlement.Builder addAllEligibleUsers(Iterable<? extends AccessControlEntry> values)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 |
values |
Iterable<? extends com.google.cloud.privilegedaccessmanager.v1.AccessControlEntry> |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
addEligibleUsers(AccessControlEntry value)
public Entitlement.Builder addEligibleUsers(AccessControlEntry value)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 |
value |
AccessControlEntry |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
addEligibleUsers(AccessControlEntry.Builder builderForValue)
public Entitlement.Builder addEligibleUsers(AccessControlEntry.Builder builderForValue)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 |
builderForValue |
AccessControlEntry.Builder |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
addEligibleUsers(int index, AccessControlEntry value)
public Entitlement.Builder addEligibleUsers(int index, AccessControlEntry value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
AccessControlEntry |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
addEligibleUsers(int index, AccessControlEntry.Builder builderForValue)
public Entitlement.Builder addEligibleUsers(int index, AccessControlEntry.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
AccessControlEntry.Builder |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
addEligibleUsersBuilder()
public AccessControlEntry.Builder addEligibleUsersBuilder()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 |
AccessControlEntry.Builder |
|
addEligibleUsersBuilder(int index)
public AccessControlEntry.Builder addEligibleUsersBuilder(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.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Entitlement.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
build()
public Entitlement build()| Returns | |
|---|---|
| Type | Description |
Entitlement |
|
buildPartial()
public Entitlement buildPartial()| Returns | |
|---|---|
| Type | Description |
Entitlement |
|
clear()
public Entitlement.Builder clear()| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
clearAdditionalNotificationTargets()
public Entitlement.Builder clearAdditionalNotificationTargets()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.Builder |
|
clearApprovalWorkflow()
public Entitlement.Builder clearApprovalWorkflow()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 |
Entitlement.Builder |
|
clearCreateTime()
public Entitlement.Builder clearCreateTime()Output only. Create time stamp.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
clearEligibleUsers()
public Entitlement.Builder clearEligibleUsers()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 |
Entitlement.Builder |
|
clearEtag()
public Entitlement.Builder clearEtag() 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 |
Entitlement.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Entitlement.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
clearMaxRequestDuration()
public Entitlement.Builder clearMaxRequestDuration()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 |
Entitlement.Builder |
|
clearName()
public Entitlement.Builder clearName()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 |
Entitlement.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Entitlement.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
clearPrivilegedAccess()
public Entitlement.Builder clearPrivilegedAccess()The access granted to a requester on successful approval.
.google.cloud.privilegedaccessmanager.v1.PrivilegedAccess privileged_access = 7;
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
clearRequesterJustificationConfig()
public Entitlement.Builder clearRequesterJustificationConfig()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.Builder |
|
clearState()
public Entitlement.Builder clearState()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.Builder |
This builder for chaining. |
clearUpdateTime()
public Entitlement.Builder clearUpdateTime()Output only. Update time stamp.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
clone()
public Entitlement.Builder clone()| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
Entitlement.AdditionalNotificationTargets |
The additionalNotificationTargets. |
getAdditionalNotificationTargetsBuilder()
public Entitlement.AdditionalNotificationTargets.Builder getAdditionalNotificationTargetsBuilder()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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
Entitlement.AdditionalNotificationTargetsOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
ApprovalWorkflow |
The approvalWorkflow. |
getApprovalWorkflowBuilder()
public ApprovalWorkflow.Builder getApprovalWorkflowBuilder()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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
ApprovalWorkflowOrBuilder |
|
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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Create time stamp.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. Create time stamp.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public Entitlement getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Entitlement |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
| Returns | |
|---|---|
| Type | Description |
AccessControlEntry |
|
getEligibleUsersBuilder(int index)
public AccessControlEntry.Builder getEligibleUsersBuilder(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.Builder |
|
getEligibleUsersBuilderList()
public List<AccessControlEntry.Builder> getEligibleUsersBuilderList()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<Builder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
List<AccessControlEntry> |
|
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 |
| Returns | |
|---|---|
| Type | Description |
AccessControlEntryOrBuilder |
|
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()
public 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 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. |
getMaxRequestDurationBuilder()
public Duration.Builder getMaxRequestDurationBuilder()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 |
Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getName()
public 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 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 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. |
getPrivilegedAccessBuilder()
public PrivilegedAccess.Builder getPrivilegedAccessBuilder()The access granted to a requester on successful approval.
.google.cloud.privilegedaccessmanager.v1.PrivilegedAccess privileged_access = 7;
| Returns | |
|---|---|
| Type | Description |
PrivilegedAccess.Builder |
|
getPrivilegedAccessOrBuilder()
public 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 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. |
getRequesterJustificationConfigBuilder()
public Entitlement.RequesterJustificationConfig.Builder getRequesterJustificationConfigBuilder()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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
Entitlement.RequesterJustificationConfigOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
Entitlement.State |
The state. |
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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. Update time stamp.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getUpdateTimeOrBuilder()
public 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAdditionalNotificationTargets(Entitlement.AdditionalNotificationTargets value)
public Entitlement.Builder mergeAdditionalNotificationTargets(Entitlement.AdditionalNotificationTargets value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Entitlement.AdditionalNotificationTargets |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
mergeApprovalWorkflow(ApprovalWorkflow value)
public Entitlement.Builder mergeApprovalWorkflow(ApprovalWorkflow value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ApprovalWorkflow |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
mergeCreateTime(Timestamp value)
public Entitlement.Builder mergeCreateTime(Timestamp value)Output only. Create time stamp.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
mergeFrom(Entitlement other)
public Entitlement.Builder mergeFrom(Entitlement other)| Parameter | |
|---|---|
| Name | Description |
other |
Entitlement |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Entitlement.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Entitlement.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
mergeMaxRequestDuration(Duration value)
public Entitlement.Builder mergeMaxRequestDuration(Duration value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
mergePrivilegedAccess(PrivilegedAccess value)
public Entitlement.Builder mergePrivilegedAccess(PrivilegedAccess value)The access granted to a requester on successful approval.
.google.cloud.privilegedaccessmanager.v1.PrivilegedAccess privileged_access = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
PrivilegedAccess |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
mergeRequesterJustificationConfig(Entitlement.RequesterJustificationConfig value)
public Entitlement.Builder mergeRequesterJustificationConfig(Entitlement.RequesterJustificationConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Entitlement.RequesterJustificationConfig |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Entitlement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
mergeUpdateTime(Timestamp value)
public Entitlement.Builder mergeUpdateTime(Timestamp value)Output only. Update time stamp.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
removeEligibleUsers(int index)
public Entitlement.Builder removeEligibleUsers(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 |
Entitlement.Builder |
|
setAdditionalNotificationTargets(Entitlement.AdditionalNotificationTargets value)
public Entitlement.Builder setAdditionalNotificationTargets(Entitlement.AdditionalNotificationTargets value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Entitlement.AdditionalNotificationTargets |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setAdditionalNotificationTargets(Entitlement.AdditionalNotificationTargets.Builder builderForValue)
public Entitlement.Builder setAdditionalNotificationTargets(Entitlement.AdditionalNotificationTargets.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Entitlement.AdditionalNotificationTargets.Builder |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setApprovalWorkflow(ApprovalWorkflow value)
public Entitlement.Builder setApprovalWorkflow(ApprovalWorkflow value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ApprovalWorkflow |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setApprovalWorkflow(ApprovalWorkflow.Builder builderForValue)
public Entitlement.Builder setApprovalWorkflow(ApprovalWorkflow.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ApprovalWorkflow.Builder |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setCreateTime(Timestamp value)
public Entitlement.Builder setCreateTime(Timestamp value)Output only. Create time stamp.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public Entitlement.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Create time stamp.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setEligibleUsers(int index, AccessControlEntry value)
public Entitlement.Builder setEligibleUsers(int index, AccessControlEntry value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
AccessControlEntry |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setEligibleUsers(int index, AccessControlEntry.Builder builderForValue)
public Entitlement.Builder setEligibleUsers(int index, AccessControlEntry.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
AccessControlEntry.Builder |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setEtag(String value)
public Entitlement.Builder setEtag(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe etag to set. |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
This builder for chaining. |
setEtagBytes(ByteString value)
public Entitlement.Builder setEtagBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for etag to set. |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Entitlement.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setMaxRequestDuration(Duration value)
public Entitlement.Builder setMaxRequestDuration(Duration value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setMaxRequestDuration(Duration.Builder builderForValue)
public Entitlement.Builder setMaxRequestDuration(Duration.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setName(String value)
public Entitlement.Builder setName(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Entitlement.Builder setNameBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
This builder for chaining. |
setPrivilegedAccess(PrivilegedAccess value)
public Entitlement.Builder setPrivilegedAccess(PrivilegedAccess value)The access granted to a requester on successful approval.
.google.cloud.privilegedaccessmanager.v1.PrivilegedAccess privileged_access = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
PrivilegedAccess |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setPrivilegedAccess(PrivilegedAccess.Builder builderForValue)
public Entitlement.Builder setPrivilegedAccess(PrivilegedAccess.Builder builderForValue)The access granted to a requester on successful approval.
.google.cloud.privilegedaccessmanager.v1.PrivilegedAccess privileged_access = 7;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
PrivilegedAccess.Builder |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Entitlement.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setRequesterJustificationConfig(Entitlement.RequesterJustificationConfig value)
public Entitlement.Builder setRequesterJustificationConfig(Entitlement.RequesterJustificationConfig value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Entitlement.RequesterJustificationConfig |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setRequesterJustificationConfig(Entitlement.RequesterJustificationConfig.Builder builderForValue)
public Entitlement.Builder setRequesterJustificationConfig(Entitlement.RequesterJustificationConfig.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Entitlement.RequesterJustificationConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setState(Entitlement.State value)
public Entitlement.Builder setState(Entitlement.State value)Output only. Current state of this entitlement.
.google.cloud.privilegedaccessmanager.v1.Entitlement.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Entitlement.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
This builder for chaining. |
setStateValue(int value)
public Entitlement.Builder setStateValue(int value)Output only. Current state of this entitlement.
.google.cloud.privilegedaccessmanager.v1.Entitlement.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Entitlement.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setUpdateTime(Timestamp value)
public Entitlement.Builder setUpdateTime(Timestamp value)Output only. Update time stamp.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public Entitlement.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. Update time stamp.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Entitlement.Builder |
|