Interface PolicyItem.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PolicyItem.Builder,PolicyItem>, SdkBuilder<PolicyItem.Builder,PolicyItem>, SdkPojo
Enclosing class:
PolicyItem
@Mutable @NotThreadSafe public static interface PolicyItem.Builder extends SdkPojo, CopyableBuilder<PolicyItem.Builder,PolicyItem>

  • Method Details

    • policyStoreId

      PolicyItem.Builder policyStoreId(String policyStoreId)

      The identifier of the policy store where the policy you want information about is stored.

      Parameters:
      policyStoreId - The identifier of the policy store where the policy you want information about is stored.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policyId

      PolicyItem.Builder policyId(String policyId)

      The identifier of the policy you want information about.

      Parameters:
      policyId - The identifier of the policy you want information about.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policyType

      PolicyItem.Builder policyType(String policyType)

      The type of the policy. This is one of the following values:

      • STATIC

      • TEMPLATE_LINKED

      Parameters:
      policyType - The type of the policy. This is one of the following values:

      • STATIC

      • TEMPLATE_LINKED

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • policyType

      PolicyItem.Builder policyType(PolicyType policyType)

      The type of the policy. This is one of the following values:

      • STATIC

      • TEMPLATE_LINKED

      Parameters:
      policyType - The type of the policy. This is one of the following values:

      • STATIC

      • TEMPLATE_LINKED

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • principal

      PolicyItem.Builder principal(EntityIdentifier principal)

      The principal associated with the policy.

      Parameters:
      principal - The principal associated with the policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • principal

      default PolicyItem.Builder principal(Consumer<EntityIdentifier.Builder> principal)

      The principal associated with the policy.

      This is a convenience method that creates an instance of the EntityIdentifier.Builder avoiding the need to create one manually via EntityIdentifier.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to principal(EntityIdentifier).

      Parameters:
      principal - a consumer that will call methods on EntityIdentifier.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resource

      PolicyItem.Builder resource(EntityIdentifier resource)

      The resource associated with the policy.

      Parameters:
      resource - The resource associated with the policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resource

      default PolicyItem.Builder resource(Consumer<EntityIdentifier.Builder> resource)

      The resource associated with the policy.

      This is a convenience method that creates an instance of the EntityIdentifier.Builder avoiding the need to create one manually via EntityIdentifier.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resource(EntityIdentifier).

      Parameters:
      resource - a consumer that will call methods on EntityIdentifier.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • actions

      PolicyItem.Builder actions(Collection<ActionIdentifier> actions)

      The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]} .

      Parameters:
      actions - The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]} .
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actions

      PolicyItem.Builder actions(ActionIdentifier... actions)

      The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]} .

      Parameters:
      actions - The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]} .
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actions

      PolicyItem.Builder actions(Consumer<ActionIdentifier.Builder>... actions)

      The action that a policy permits or forbids. For example, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]} .

      This is a convenience method that creates an instance of the ActionIdentifier.Builder avoiding the need to create one manually via ActionIdentifier.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to actions(List<ActionIdentifier>).

      Parameters:
      actions - a consumer that will call methods on ActionIdentifier.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • definition

      PolicyItem.Builder definition(PolicyDefinitionItem definition)

      The policy definition of an item in the list of policies returned.

      Parameters:
      definition - The policy definition of an item in the list of policies returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • definition

      default PolicyItem.Builder definition(Consumer<PolicyDefinitionItem.Builder> definition)

      The policy definition of an item in the list of policies returned.

      This is a convenience method that creates an instance of the PolicyDefinitionItem.Builder avoiding the need to create one manually via PolicyDefinitionItem.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to definition(PolicyDefinitionItem).

      Parameters:
      definition - a consumer that will call methods on PolicyDefinitionItem.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdDate

      PolicyItem.Builder createdDate(Instant createdDate)

      The date and time the policy was created.

      Parameters:
      createdDate - The date and time the policy was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedDate

      PolicyItem.Builder lastUpdatedDate(Instant lastUpdatedDate)

      The date and time the policy was most recently updated.

      Parameters:
      lastUpdatedDate - The date and time the policy was most recently updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • effect

      PolicyItem.Builder effect(String effect)

      The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".

      Parameters:
      effect - The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • effect

      PolicyItem.Builder effect(PolicyEffect effect)

      The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".

      Parameters:
      effect - The effect of the decision that a policy returns to an authorization request. For example, "effect": "Permit".
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: