Privileged Access Manager V1 API - Class Google::Cloud::PrivilegedAccessManager::V1::Entitlement (v0.1.1)

Reference documentation and code samples for the Privileged Access Manager V1 API class Google::Cloud::PrivilegedAccessManager::V1::Entitlement.

An entitlement defines the eligibility of a set of users to obtain predefined access for some time possibly after going through an approval workflow.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#additional_notification_targets

def additional_notification_targets() -> ::Google::Cloud::PrivilegedAccessManager::V1::Entitlement::AdditionalNotificationTargets
Returns

#additional_notification_targets=

def additional_notification_targets=(value) -> ::Google::Cloud::PrivilegedAccessManager::V1::Entitlement::AdditionalNotificationTargets
Parameter
Returns

#approval_workflow

def approval_workflow() -> ::Google::Cloud::PrivilegedAccessManager::V1::ApprovalWorkflow
Returns

#approval_workflow=

def approval_workflow=(value) -> ::Google::Cloud::PrivilegedAccessManager::V1::ApprovalWorkflow
Parameter
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#eligible_users

def eligible_users() -> ::Array<::Google::Cloud::PrivilegedAccessManager::V1::AccessControlEntry>
Returns

#eligible_users=

def eligible_users=(value) -> ::Array<::Google::Cloud::PrivilegedAccessManager::V1::AccessControlEntry>
Parameter
Returns

#etag

def etag() -> ::String
Returns
  • (::String) — 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.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#max_request_duration

def max_request_duration() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — 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.

#max_request_duration=

def max_request_duration=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — 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.
Returns
  • (::Google::Protobuf::Duration) — 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.

#name

def name() -> ::String
Returns
  • (::String) —

    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}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) —

    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}
Returns
  • (::String) —

    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}

#privileged_access

def privileged_access() -> ::Google::Cloud::PrivilegedAccessManager::V1::PrivilegedAccess
Returns

#privileged_access=

def privileged_access=(value) -> ::Google::Cloud::PrivilegedAccessManager::V1::PrivilegedAccess
Parameter
Returns

#requester_justification_config

def requester_justification_config() -> ::Google::Cloud::PrivilegedAccessManager::V1::Entitlement::RequesterJustificationConfig
Returns

#requester_justification_config=

def requester_justification_config=(value) -> ::Google::Cloud::PrivilegedAccessManager::V1::Entitlement::RequesterJustificationConfig
Parameter
Returns

#state

def state() -> ::Google::Cloud::PrivilegedAccessManager::V1::Entitlement::State
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns