Class RoutingProfile
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.generativeai.model.RoutingProfile
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20231130") public final class RoutingProfile extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelA routing profile is a reusable set of policies that controls how Smart Router selects a target region and model for inference traffic.It can scope routing to allowed regions and allowed models.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resources](https://docs.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
Note: Objects should always be created or deserialized using theRoutingProfile.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 theRoutingProfile.Builder, which maintain a set of all explicitly set fields calledRoutingProfile.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 classRoutingProfile.Builderstatic classRoutingProfile.LifecycleStateThe current state of the routing profile.
-
Constructor Summary
Constructors Constructor Description RoutingProfile(String id, String displayName, String description, String compartmentId, Date timeCreated, Date timeUpdated, RoutingProfile.LifecycleState lifecycleState, String lifecycleDetails, RegionRoutingPolicy regionRoutingPolicy, ModelRoutingPolicy modelRoutingPolicy, PreviousRoutingProfileState previousState, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RoutingProfile.Builderbuilder()Create a new builder.booleanequals(Object o)StringgetCompartmentId()The OCID of the compartment in which the routing profile lives.Map<String,Map<String,Object>>getDefinedTags()Defined tags for this resource.StringgetDescription()An optional description of the routing profile.StringgetDisplayName()A user-friendly name.Map<String,String>getFreeformTags()Free-form tags for this resource.StringgetId()An OCID that uniquely identifies this routing profile resource.StringgetLifecycleDetails()A message describing the current state of the routing profile in more detail that can provide actionable information.RoutingProfile.LifecycleStategetLifecycleState()The current state of the routing profile.ModelRoutingPolicygetModelRoutingPolicy()PreviousRoutingProfileStategetPreviousState()RegionRoutingPolicygetRegionRoutingPolicy()Map<String,Map<String,Object>>getSystemTags()System tags for this resource.DategetTimeCreated()The date and time that the routing profile was created in the format of an RFC3339 datetime string.DategetTimeUpdated()The date and time that the routing profile was updated in the format of an RFC3339 datetime string.inthashCode()RoutingProfile.BuildertoBuilder()StringtoString()StringtoString(boolean includeByteArrayContents)Return a string representation of the object.
-
-
-
Constructor Detail
-
RoutingProfile
@Deprecated @ConstructorProperties({"id","displayName","description","compartmentId","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","regionRoutingPolicy","modelRoutingPolicy","previousState","freeformTags","definedTags","systemTags"}) public RoutingProfile(String id, String displayName, String description, String compartmentId, Date timeCreated, Date timeUpdated, RoutingProfile.LifecycleState lifecycleState, String lifecycleDetails, RegionRoutingPolicy regionRoutingPolicy, ModelRoutingPolicy modelRoutingPolicy, PreviousRoutingProfileState previousState, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
Deprecated.
-
-
Method Detail
-
builder
public static RoutingProfile.Builder builder()
Create a new builder.
-
toBuilder
public RoutingProfile.Builder toBuilder()
-
getId
public String getId()
An OCID that uniquely identifies this routing profile resource.- Returns:
- the value
-
getDisplayName
public String getDisplayName()
A user-friendly name.Does not have to be unique, and it’s changeable.
- Returns:
- the value
-
getDescription
public String getDescription()
An optional description of the routing profile.- Returns:
- the value
-
getCompartmentId
public String getCompartmentId()
The OCID of the compartment in which the routing profile lives.- Returns:
- the value
-
getTimeCreated
public Date getTimeCreated()
The date and time that the routing profile was created in the format of an RFC3339 datetime string.- Returns:
- the value
-
getTimeUpdated
public Date getTimeUpdated()
The date and time that the routing profile was updated in the format of an RFC3339 datetime string.- Returns:
- the value
-
getLifecycleState
public RoutingProfile.LifecycleState getLifecycleState()
The current state of the routing profile.- Returns:
- the value
-
getLifecycleDetails
public String getLifecycleDetails()
A message describing the current state of the routing profile in more detail that can provide actionable information.- Returns:
- the value
-
getRegionRoutingPolicy
public RegionRoutingPolicy getRegionRoutingPolicy()
-
getModelRoutingPolicy
public ModelRoutingPolicy getModelRoutingPolicy()
-
getPreviousState
public PreviousRoutingProfileState getPreviousState()
-
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 for this resource.Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}
- Returns:
- the value
-
toString
public String toString()
- Overrides:
toStringin 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:
equalsin classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCodein classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-