Class HostedApplication
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.generativeai.model.HostedApplication
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20231130") public final class HostedApplication extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelHosted Application, defines shared configurations that apply across multiple deployments of the Agent or MCP application.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 theHostedApplication.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 theHostedApplication.Builder, which maintain a set of all explicitly set fields calledHostedApplication.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 classHostedApplication.Builderstatic classHostedApplication.LifecycleStateThe current state of the hosted application.
-
Constructor Summary
Constructors Constructor Description HostedApplication(String id, String displayName, String description, String compartmentId, Date timeCreated, Date timeUpdated, HostedApplication.LifecycleState lifecycleState, String lifecycleDetails, ScalingConfig scalingConfig, List<StorageConfig> storageConfigs, InboundAuthConfig inboundAuthConfig, NetworkingConfig networkingConfig, List<EnvironmentVariable> environmentVariables, 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 HostedApplication.Builderbuilder()Create a new builder.booleanequals(Object o)StringgetCompartmentId()The compartment OCID to create the hosted application in.Map<String,Map<String,Object>>getDefinedTags()Defined tags for this resource.StringgetDescription()An optional description of the hosted application.StringgetDisplayName()A user-friendly name.List<EnvironmentVariable>getEnvironmentVariables()The list of environment variables for the Hosted Application.Map<String,String>getFreeformTags()Free-form tags for this resource.StringgetId()The OCID of the hosted application.InboundAuthConfiggetInboundAuthConfig()StringgetLifecycleDetails()A message describing the current state of the endpoint in more detail that can provide actionable information.HostedApplication.LifecycleStategetLifecycleState()The current state of the hosted application.NetworkingConfiggetNetworkingConfig()ScalingConfiggetScalingConfig()List<StorageConfig>getStorageConfigs()A list of storageConfigs managed by the OCI GenAI Platform and attached to the application.Map<String,Map<String,Object>>getSystemTags()System tags for this resource.DategetTimeCreated()The date and time the hosted application was created, in the format defined by RFC 3339DategetTimeUpdated()The date and time the hosted application was updated, in the format defined by RFC 3339inthashCode()HostedApplication.BuildertoBuilder()StringtoString()StringtoString(boolean includeByteArrayContents)Return a string representation of the object.
-
-
-
Constructor Detail
-
HostedApplication
@Deprecated @ConstructorProperties({"id","displayName","description","compartmentId","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","scalingConfig","storageConfigs","inboundAuthConfig","networkingConfig","environmentVariables","freeformTags","definedTags","systemTags"}) public HostedApplication(String id, String displayName, String description, String compartmentId, Date timeCreated, Date timeUpdated, HostedApplication.LifecycleState lifecycleState, String lifecycleDetails, ScalingConfig scalingConfig, List<StorageConfig> storageConfigs, InboundAuthConfig inboundAuthConfig, NetworkingConfig networkingConfig, List<EnvironmentVariable> environmentVariables, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
Deprecated.
-
-
Method Detail
-
builder
public static HostedApplication.Builder builder()
Create a new builder.
-
toBuilder
public HostedApplication.Builder toBuilder()
-
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 hosted application.- Returns:
- the value
-
getCompartmentId
public String getCompartmentId()
The compartment OCID to create the hosted application in.- Returns:
- the value
-
getTimeCreated
public Date getTimeCreated()
The date and time the hosted application was created, in the format defined by RFC 3339- Returns:
- the value
-
getTimeUpdated
public Date getTimeUpdated()
The date and time the hosted application was updated, in the format defined by RFC 3339- Returns:
- the value
-
getLifecycleState
public HostedApplication.LifecycleState getLifecycleState()
The current state of the hosted application.- Returns:
- the value
-
getLifecycleDetails
public String getLifecycleDetails()
A message describing the current state of the endpoint in more detail that can provide actionable information.- Returns:
- the value
-
getScalingConfig
public ScalingConfig getScalingConfig()
-
getStorageConfigs
public List<StorageConfig> getStorageConfigs()
A list of storageConfigs managed by the OCI GenAI Platform and attached to the application.- Returns:
- the value
-
getInboundAuthConfig
public InboundAuthConfig getInboundAuthConfig()
-
getNetworkingConfig
public NetworkingConfig getNetworkingConfig()
-
getEnvironmentVariables
public List<EnvironmentVariable> getEnvironmentVariables()
The list of environment variables for the Hosted Application.Defines a list of environment variables injected at runtime.
- 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 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
-
-