Class Grant
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.identitydomains.model.Grant
-
@Generated(value="OracleSDKGenerator", comments="API Version: v1") public final class Grant extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Schema for Grant Resource
Note: Objects should always be created or deserialized using theGrant.Builder
.This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the
Grant.Builder
, which maintain a set of all explicitly set fields calledGrant.Builder.__explicitlySet__
. ThehashCode()
andequals(Object)
methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Grant.Builder
static class
Grant.GrantMechanism
Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted.
-
Constructor Summary
Constructors Constructor Description Grant(String id, String ocid, List<String> schemas, Meta meta, IdcsCreatedBy idcsCreatedBy, IdcsLastModifiedBy idcsLastModifiedBy, List<IdcsPreventedOperations> idcsPreventedOperations, List<Tags> tags, Boolean deleteInProgress, String idcsLastUpgradedInRelease, String domainOcid, String compartmentOcid, String tenancyOcid, Grant.GrantMechanism grantMechanism, String compositeKey, Boolean isFulfilled, String grantedAttributeValuesJson, GrantAppEntitlementCollection appEntitlementCollection, GrantGrantor grantor, GrantGrantee grantee, GrantApp app, GrantEntitlement entitlement)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Grant.Builder
builder()
Create a new builder.boolean
equals(Object o)
GrantApp
getApp()
GrantAppEntitlementCollection
getAppEntitlementCollection()
String
getCompartmentOcid()
OCI Compartment Id (ocid) in which the resource lives.String
getCompositeKey()
Unique key of grant, composed by combining a subset of app, entitlement, grantee, grantor and grantMechanism.Boolean
getDeleteInProgress()
A boolean flag indicating this resource in the process of being deleted.String
getDomainOcid()
OCI Domain Id (ocid) in which the resource lives.GrantEntitlement
getEntitlement()
String
getGrantedAttributeValuesJson()
Store granted attribute-values as a string in Javascript Object Notation (JSON) format.GrantGrantee
getGrantee()
Grant.GrantMechanism
getGrantMechanism()
Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted.GrantGrantor
getGrantor()
String
getId()
Unique identifier for the SCIM Resource as defined by the Service Provider.IdcsCreatedBy
getIdcsCreatedBy()
IdcsLastModifiedBy
getIdcsLastModifiedBy()
String
getIdcsLastUpgradedInRelease()
The release number when the resource was upgraded.List<IdcsPreventedOperations>
getIdcsPreventedOperations()
Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.Boolean
getIsFulfilled()
If true, this Grant has been fulfilled successfully.Meta
getMeta()
String
getOcid()
Unique OCI identifier for the SCIM Resource.List<String>
getSchemas()
REQUIRED.List<Tags>
getTags()
A list of tags on this resource.String
getTenancyOcid()
OCI Tenant Id (ocid) in which the resource lives.int
hashCode()
Grant.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
Grant
@Deprecated @ConstructorProperties({"id","ocid","schemas","meta","idcsCreatedBy","idcsLastModifiedBy","idcsPreventedOperations","tags","deleteInProgress","idcsLastUpgradedInRelease","domainOcid","compartmentOcid","tenancyOcid","grantMechanism","compositeKey","isFulfilled","grantedAttributeValuesJson","appEntitlementCollection","grantor","grantee","app","entitlement"}) public Grant(String id, String ocid, List<String> schemas, Meta meta, IdcsCreatedBy idcsCreatedBy, IdcsLastModifiedBy idcsLastModifiedBy, List<IdcsPreventedOperations> idcsPreventedOperations, List<Tags> tags, Boolean deleteInProgress, String idcsLastUpgradedInRelease, String domainOcid, String compartmentOcid, String tenancyOcid, Grant.GrantMechanism grantMechanism, String compositeKey, Boolean isFulfilled, String grantedAttributeValuesJson, GrantAppEntitlementCollection appEntitlementCollection, GrantGrantor grantor, GrantGrantee grantee, GrantApp app, GrantEntitlement entitlement)
Deprecated.
-
-
Method Detail
-
builder
public static Grant.Builder builder()
Create a new builder.
-
toBuilder
public Grant.Builder toBuilder()
-
getId
public String getId()
Unique identifier for the SCIM Resource as defined by the Service Provider.Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider’s entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: always - type: string - uniqueness: global
- Returns:
- the value
-
getOcid
public String getOcid()
Unique OCI identifier for the SCIM Resource.*SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: string - uniqueness: global
- Returns:
- the value
-
getSchemas
public List<String> getSchemas()
REQUIRED.The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \“enterprise\” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: true - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none
- Returns:
- the value
-
getMeta
public Meta getMeta()
-
getIdcsCreatedBy
public IdcsCreatedBy getIdcsCreatedBy()
-
getIdcsLastModifiedBy
public IdcsLastModifiedBy getIdcsLastModifiedBy()
-
getIdcsPreventedOperations
public List<IdcsPreventedOperations> getIdcsPreventedOperations()
Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.*SCIM++ Properties:** - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none
- Returns:
- the value
-
getTags
public List<Tags> getTags()
A list of tags on this resource.*SCIM++ Properties:** - idcsCompositeKey: [key, value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none
- Returns:
- the value
-
getDeleteInProgress
public Boolean getDeleteInProgress()
A boolean flag indicating this resource in the process of being deleted.Usually set to true when synchronous deletion of the resource would take too long.
*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none
- Returns:
- the value
-
getIdcsLastUpgradedInRelease
public String getIdcsLastUpgradedInRelease()
The release number when the resource was upgraded.*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none
- Returns:
- the value
-
getDomainOcid
public String getDomainOcid()
OCI Domain Id (ocid) in which the resource lives.*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none
- Returns:
- the value
-
getCompartmentOcid
public String getCompartmentOcid()
OCI Compartment Id (ocid) in which the resource lives.*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none
- Returns:
- the value
-
getTenancyOcid
public String getTenancyOcid()
OCI Tenant Id (ocid) in which the resource lives.*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none
- Returns:
- the value
-
getGrantMechanism
public Grant.GrantMechanism getGrantMechanism()
Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted.A customer or the UI should use only grantMechanism values that start with ‘ADMINISTRATOR’: - ‘ADMINISTRATOR_TO_USER’ is for a direct grant to a specific User. - ‘ADMINISTRATOR_TO_GROUP’ is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. - ‘ADMINISTRATOR_TO_APP’ is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App.
*SCIM++ Properties:** - caseExact: true - idcsCsvAttributeNameMappings: [[defaultValue:IMPORT_GRANTS]] - idcsSearchable: true - multiValued: false - mutability: immutable - required: true - returned: default - type: string - uniqueness: none
- Returns:
- the value
-
getCompositeKey
public String getCompositeKey()
Unique key of grant, composed by combining a subset of app, entitlement, grantee, grantor and grantMechanism.Used to prevent duplicate Grants.
*Added In:** 18.1.2
*SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: server
- Returns:
- the value
-
getIsFulfilled
public Boolean getIsFulfilled()
If true, this Grant has been fulfilled successfully.*SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none
- Returns:
- the value
-
getGrantedAttributeValuesJson
public String getGrantedAttributeValuesJson()
Store granted attribute-values as a string in Javascript Object Notation (JSON) format.*Added In:** 18.3.4
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
- Returns:
- the value
-
getAppEntitlementCollection
public GrantAppEntitlementCollection getAppEntitlementCollection()
-
getGrantor
public GrantGrantor getGrantor()
-
getGrantee
public GrantGrantee getGrantee()
-
getApp
public GrantApp getApp()
-
getEntitlement
public GrantEntitlement getEntitlement()
-
toString
public String toString()
- Overrides:
toString
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
toString
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.- Parameters:
includeByteArrayContents
- true to include the full contents of byte arrays- Returns:
- string representation
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-