Class ResourceSummary
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.resourcesearch.model.ResourceSummary
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20180409") public final class ResourceSummary extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A resource that exists in the cloud network that you’re querying.
Note: Objects should always be created or deserialized using theResourceSummary.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 theResourceSummary.Builder
, which maintain a set of all explicitly set fields calledResourceSummary.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
ResourceSummary.Builder
-
Constructor Summary
Constructors Constructor Description ResourceSummary(String resourceType, String identifier, String compartmentId, Date timeCreated, String displayName, String availabilityDomain, String lifecycleState, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, SearchContext searchContext, Map<String,Object> identityContext, Map<String,Object> additionalDetails)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ResourceSummary.Builder
builder()
Create a new builder.boolean
equals(Object o)
Map<String,Object>
getAdditionalDetails()
Additional resource attribute fields of this resource that match queries with a return clause, if any.String
getAvailabilityDomain()
The availability domain where this resource exists, if applicable.String
getCompartmentId()
The OCID of the compartment that contains this resource.Map<String,Map<String,Object>>
getDefinedTags()
Defined tags for this resource.String
getDisplayName()
The display name (or name) of this resource, if one exists.Map<String,String>
getFreeformTags()
Free-form tags for this resource.String
getIdentifier()
The unique identifier for this particular resource, usually an OCID.Map<String,Object>
getIdentityContext()
Additional identifiers to use together in a “Get” request for a specified resource, only required for resource types that explicitly cannot be retrieved by using a single identifier, such as the resource’s OCID.String
getLifecycleState()
The lifecycle state of this resource, if applicable.String
getResourceType()
The resource type name.SearchContext
getSearchContext()
Map<String,Map<String,Object>>
getSystemTags()
System tags associated with this resource, if any.Date
getTimeCreated()
The time that this resource was created.int
hashCode()
ResourceSummary.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
ResourceSummary
@Deprecated @ConstructorProperties({"resourceType","identifier","compartmentId","timeCreated","displayName","availabilityDomain","lifecycleState","freeformTags","definedTags","systemTags","searchContext","identityContext","additionalDetails"}) public ResourceSummary(String resourceType, String identifier, String compartmentId, Date timeCreated, String displayName, String availabilityDomain, String lifecycleState, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, SearchContext searchContext, Map<String,Object> identityContext, Map<String,Object> additionalDetails)
Deprecated.
-
-
Method Detail
-
builder
public static ResourceSummary.Builder builder()
Create a new builder.
-
toBuilder
public ResourceSummary.Builder toBuilder()
-
getResourceType
public String getResourceType()
The resource type name.- Returns:
- the value
-
getIdentifier
public String getIdentifier()
The unique identifier for this particular resource, usually an OCID.- Returns:
- the value
-
getCompartmentId
public String getCompartmentId()
The OCID of the compartment that contains this resource.- Returns:
- the value
-
getTimeCreated
public Date getTimeCreated()
The time that this resource was created.- Returns:
- the value
-
getDisplayName
public String getDisplayName()
The display name (or name) of this resource, if one exists.- Returns:
- the value
-
getAvailabilityDomain
public String getAvailabilityDomain()
The availability domain where this resource exists, if applicable.- Returns:
- the value
-
getLifecycleState
public String getLifecycleState()
The lifecycle state of this resource, if applicable.- Returns:
- the value
-
getFreeformTags
public Map<String,String> getFreeformTags()
Free-form tags for this resource.Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}
- Returns:
- the value
-
getDefinedTags
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource.Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}
- Returns:
- the value
-
getSystemTags
public Map<String,Map<String,Object>> getSystemTags()
System tags associated with this resource, if any.System tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
- Returns:
- the value
-
getSearchContext
public SearchContext getSearchContext()
-
getIdentityContext
public Map<String,Object> getIdentityContext()
Additional identifiers to use together in a “Get” request for a specified resource, only required for resource types that explicitly cannot be retrieved by using a single identifier, such as the resource’s OCID.- Returns:
- the value
-
getAdditionalDetails
public Map<String,Object> getAdditionalDetails()
Additional resource attribute fields of this resource that match queries with a return clause, if any.- For example, if you ran a query to find the private IP addresses, public IP
- addresses, and isPrimary field of the VNIC attachment on instance resources, that field would
- be included in the ResourceSummary object as: {“additionalDetails”: {“attachedVnic”:
- [{“publicIP” : “172.110.110.110”,“privateIP” : “10.10.10.10”,“isPrimary” : true}, {“publicIP”
- “172.110.110.111”,“privateIP” : “10.10.10.11”,“isPrimary” : false}]}. The structure of the additional details attribute fields depends on the matching resource.
- Returns:
- the value
-
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
-
-