Module io.helidon.integrations.oci

Package io.helidon.integrations.oci

Interface ImdsInstanceInfo

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

ImdsInstanceInfo.BuilderBase.ImdsInstanceInfoImpl

public interface ImdsInstanceInfo
extends Prototype.Api

Information about the instance retrieved from Imds.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ImdsInstanceInfo.Builder	Fluent API builder for ImdsInstanceInfo.
static class	ImdsInstanceInfo.BuilderBase<BUILDER extends ImdsInstanceInfo.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ImdsInstanceInfo>	Fluent API builder base for ImdsInstanceInfo.

Method Summary

Modifier and Type	Method	Description
static ImdsInstanceInfo.Builder	builder()	Create a new fluent API builder to customize configuration.
static ImdsInstanceInfo.Builder	builder(ImdsInstanceInfo instance)	Create a new fluent API builder from an existing instance.
String	canonicalRegionName()	Canonical Region Name.
String	compartmentId()	Compartment Id.
static ImdsInstanceInfo	create()	Create a new instance with default values.
static ImdsInstanceInfo	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static ImdsInstanceInfo	create(Config config)	Create a new instance from configuration.
String	displayName()	Display Name.
String	faultDomain()	Fault Domain Name.
String	hostName()	Host Name.
JsonObject	jsonObject()	Instance Data.
String	ociAdName()	Oci Availability Domain Name.
String	region()	Region Name.
String	tenantId()	Tenant Id.

Method Details

builder

static ImdsInstanceInfo.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static ImdsInstanceInfo.Builder builder(ImdsInstanceInfo instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static ImdsInstanceInfo create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

@Deprecated
static ImdsInstanceInfo create(Config config)

Deprecated.

use create(io.helidon.config.Config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static ImdsInstanceInfo create()

Create a new instance with default values.

Returns:

a new instance

displayName

String displayName()

Display Name.

Returns:

Display Name of the Instance

hostName

String hostName()

Host Name.

Returns:

Host Name of the Instance

canonicalRegionName

String canonicalRegionName()

Canonical Region Name.

Returns:

Canonical Region Name of where the Instance exists

region

String region()

Region Name.

Returns:

Short Region Name of where the Instance exists

ociAdName

String ociAdName()

Oci Availability Domain Name.

Returns:

Physical Availaibility Domain Name where the Instance exists

faultDomain

String faultDomain()

Fault Domain Name.

Returns:

Fault Domain Name where the Instance exists

compartmentId

String compartmentId()

Compartment Id.

Returns:

Compartment Id where the Instance was provisioned.

tenantId

String tenantId()

Tenant Id.

Returns:

Tenant Id where the Instance was provisioned.

jsonObject

JsonObject jsonObject()

Instance Data.

Returns:

Full information about the Instance as a JsonObject