Namespace Oci.BdsService.Models

Classes

ActivateBdsMetastoreConfigurationDetails

The reqeust body when activating a BDS metastore configuration

ActivateIamUserSyncConfigurationDetails

Details for activating IAM user sync configuration

ActivateUpstConfigurationDetails

Details for activating UPST config on the cluster

AddAutoScalePolicyDetails

Policy definition for the autoscale configuration.
An autoscaling policy is part of an autoscaling configuration. For more information, see Autoscaling
You can create following type of autoscaling policies:

MetricBasedVerticalScalingPolicy: Vertical autoscaling action is triggered when a performance metric exceeds a threshold
MetricBasedHorizontalScalingPolicy: Horizontal autoscaling action is triggered when a performance metric exceeds a threshold
ScheduleBasedVerticalScalingPolicy: Vertical autoscaling action is triggered at the specific times that you schedule.
ScheduleBasedHorizontalScalingPolicy: Horizontal autoscaling action is triggered at the specific times that you schedule.
An autoscaling configuration can have one of above supported policies.

AddAutoScalePolicyDetailsModelConverter

AddAutoScalingConfigurationDetails

The information about the autoscale configuration.

AddBlockStorageDetails

The information about added block volumes.

AddCloudSqlDetails

The information about the added Cloud SQL.

AddKafkaDetails

The information about the Kafka service to be added.

AddMasterNodesDetails

The information about added master nodes.

AddMetricBasedHorizontalScalingPolicyDetails

Details of a metric based horizontal autoscaling policy.
In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.

AddMetricBasedVerticalScalingPolicyDetails

Details of a metric based vertical autoscaling policy.
In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.

AddScheduleBasedHorizontalScalingPolicyDetails

Details of a schedule based horizontal autoscaling policy.
In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.

AddScheduleBasedVerticalScalingPolicyDetails

Details of a schedule based vertical autoscaling policy.
In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.

AddUtilityNodesDetails

The information about added utility nodes.

AddWorkerNodesDetails

The information about added nodes.

AutoScalePolicy

This model for autoscaling policy is deprecated and not supported for ODH clusters. Use the AutoScalePolicyDetails model to manage autoscale policy details for ODH clusters.

AutoScalePolicyDetails

Details of an autoscale policy.
You can create following types of autoscaling policies:

MetricBasedVerticalScalingPolicy: Vertical autoscaling action is triggered when a performance metric exceeds a threshold
MetricBasedHorizontalScalingPolicy: Horizontal autoscaling action is triggered when a performance metric exceeds a threshold
ScheduleBasedVerticalScalingPolicy: Vertical autoscaling action is triggered at the specific times that you schedule.
ScheduleBasedHorizontalScalingPolicy: Horizontal autoscaling action is triggered at the specific times that you schedule.

AutoScalePolicyDetailsModelConverter

AutoScalePolicyMetricRule

Metric and threshold details for triggering an autoscale action.

AutoScalePolicyRule

A rule that defines a specific autoscale action to take and the metric that triggers that action.

AutoScalingConfiguration

The information about the autoscale configuration.

AutoScalingConfigurationSummary

The information about the autoscale configuration.

BackupNodeDetails

The information about the nodes to backup.

BatchingBasedOdhPatchingConfig

Patching configurations which allows patch the nodes batch by batch.

BatchingBasedPatchingConfigs

Configuration that applies the patch in batches, the batch size is a user defined parameter.

BdsApiKey

The API key information.

BdsApiKeySummary

The API key summary.

BdsCapacityReport

A report of the host capacity within an availability domain that is available for you to create bds clusters. Host capacity is the physical infrastructure that resources such as compute instances run on. Use the capacity report to determine whether sufficient capacity is available for a shape before you create a bds cluster or change the shape of a bds cluster.

BdsClusterVersionSummary

Cluster version details including bds and odh version information.

BdsInstance

Description of the cluster.

BdsInstanceSummary

Summary details of the Big Data Service cluster.

BdsMetastoreConfiguration

The metastore configuration information.

BdsMetastoreConfigurationSummary

The summary of metastore configuration information.

BdsSoftwareUpdate

Details about the given BDS type of software update. Previously known as Micro Service Patch.

CapacityAvailability

Information about the available capacity for a shape.

CapacityReportShapeAvailability

Detailed information about the availabilities of a shape in each domain.

CertificateServiceInfoDetails

Details for certificate service info

CertificateServiceInfoSummary

List of TLS/SSL information of services

ChangeBdsInstanceCompartmentDetails

Move a Cluster to a Different Compartment

ChangeShapeDetails

Resize details specified for individual nodes.

ChangeShapeNodes

Individual worker nodes groups details.

CloudSqlDetails

The information about added Cloud SQL capability

ClusterDetails

Specific info about a Hadoop cluster

CreateBdsApiKeyDetails

API key created on user's behalf.

CreateBdsCapacityReportDetails

The data to create a report of available BDS capacity.

CreateBdsInstanceDetails

The information about the new cluster.

CreateBdsMetastoreConfigurationDetails

The request body when creating BDS metastore configuration.

CreateCapacityReportShapeAvailabilityDetails

Information about the shapes in a capacity report.

CreateIdentityConfigurationDetails

Details for creating the identity configuration.

CreateNodeBackupConfigurationDetails

The information about the NodeBackupConfiguration.

CreateNodeDetails

The information about the new node.

CreateNodeReplaceConfigurationDetails

The information about the NodeReplaceConfiguration

CreateResourcePrincipalConfigurationDetails

Details of creating a resource principal configuration for the cluster.

DayBasedHorizontalScalingScheduleDetails

Details of day based horizontal scaling schedule.

DayBasedVerticalScalingScheduleDetails

Details of day based vertical scaling schedule.

DeactivateIamUserSyncConfigurationDetails

Details for deactivating an IAM user sync configuration

DeactivateUpstConfigurationDetails

Details for deleting UPST config from cluster

DefaultError

Error Information.

DisableCertificateDetails

The request body info about disable certificate service list.

DomainBasedOdhPatchingConfig

This patching config will patch all nodes in one AD/FD at a time.

DomainBasedPatchingConfigs

This patching config will patch all nodes in one AD/FD at a time.

DomainTypeCapacityReport

Detailed information of the capacity under a domain.

DomainTypeCapacityReportModelConverter

DowntimeBasedOdhPatchingConfig

Patching configurations which allows downtime. This patching config will patch all the nodes in parallel.

DowntimeBasedPatchingConfigs

Patching configurations which allows downtime. This patching config will patch and reboot all the nodes in parallel.

EnableCertificateDetails

The request body info about configure certificate service list.

ExecuteBootstrapScriptDetails

The information about the bootstrap script to be executed.

ForceRefreshResourcePrincipalDetails

Force Refresh Resource Principal Session Token Details.

HorizontalScalingScheduleDetails

Details of a horizontal scaling schedule.

HorizontalScalingScheduleDetailsModelConverter

HostCertDetails

Details about the host and corresponding certificate.

HostSpecificCertificateDetails

Host specific certificate details

IamUserSyncConfiguration

Information about the IAM user sync configuration.

IamUserSyncConfigurationDetails

Details for activating/updating an IAM user sync configuration

IdentityConfiguration

Details about the identity configuration

IdentityConfigurationSummary

Summary of the identity config

InstallOsPatchDetails

Os patch details for installing a os patches to a cluster.

InstallPatchDetails

The reqeust body while installing a patch to a cluster.

InstallSoftwareUpdatesDetails

Details for installing a software update to a cluster.

KerberosDetails

Details about the Kerberos principals.

LevelTypeDetails

Details of the type of level used to trigger the creation of a new node backup configuration or node replacement configuration.

LevelTypeDetailsModelConverter

MetricBasedHorizontalScaleInConfig

Configration for a metric based horizontal scale-in policy.

MetricBasedHorizontalScaleOutConfig

Configration for a metric based horizontal scale-out policy.

MetricBasedHorizontalScalingPolicyDetails

Details of a metric based horizontal autoscaling policy.
In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.

MetricBasedVerticalScaleDownConfig

Configration for a metric based vertical scale-down policy.

MetricBasedVerticalScaleUpConfig

Configration for a metric based vertical scale-up policy.

MetricBasedVerticalScalingPolicyDetails

Details of a metric based vertical autoscaling policy.
In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.

MetricThresholdRule

An autoscale action is triggered when a performance metric exceeds a threshold.

MultiAdCapacityReport

Capacity report for a multi-AD region.

NetworkConfig

Additional configuration of the user's network.

Node

Details about a node.

NodeBackup

The information about the Node's backup.

NodeBackupConfiguration

The information about the NodeBackupConfiguration.

NodeBackupConfigurationSummary

The information about the NodeBackupConfiguration.

NodeBackupSummary

The information about the nodeBackupSummary.

NodeLevelDetails

Details of node level used to trigger the creation of a new node backup configuration and node replacement configuration.

NodeReplaceConfiguration

The information about the NodeReplaceConfiguration.

NodeReplaceConfigurationSummary

The information about the NodeReplaceConfigurationSummary.

NodeTypeLevelDetails

Details of node type level used to trigger the creation of a new node backup configuration and node replacement configuration.

NodeTypeShapeConfig

Shape configuration at node type level. Start cluster will start all nodes as is if no config is specified.

OdhPatchingConfig

Detailed configurations for defining the behavior when installing ODH patches. If not provided, nodes will be patched with down time.

OdhPatchingConfigModelConverter

OsPatchDetails

Details of an os patch.

OsPatchPackageSummary

Summary of a package contained in a os patch.

OsPatchSummary

Summary of an available os patch to a cluster.

PatchHistorySummary

Patch history of this cluster.

PatchSummary

The patch that is currently available for the cluster.

PatchingConfigs

Detailed configurations for defining the behavior when installing os patches. If not provided, nodes will be patched and rebooted AD/FD by AD/FD for regular patches or will be patched with down time if the patch is an emergent patch.

PatchingConfigsModelConverter

RefreshConfidentialApplicationDetails

Details for refreshing confidential application

RefreshUpstTokenExchangeKeytabDetails

Details for refreshing User Principal Session (UPST) token exchange keytab

RemoveAutoScalingConfigurationDetails

The information about the removed autoscale configuration.

RemoveCloudSqlDetails

The information about the Cloud SQL installation that was removed.

RemoveKafkaDetails

The information about the Kafka installation to be removed. All configured Kafka nodes are considered for removal.

RemoveNodeDetails

The information about node to be removed.

RemoveNodeReplaceConfigurationDetails

The information about the NodeReplaceConfiguration that being removed.

RemoveResourcePrincipalConfigurationDetails

Details of removing a resource principal configuration for the cluster.

RenewCertificateDetails

The request body info about renew certificate service list.

ReplaceNodeDetails

The information about the node to be replaced.

ResourcePrincipalConfiguration

Resource Principal Session Token Details.

ResourcePrincipalConfigurationSummary

Resource Principal Session Token Details.

RestartNodeDetails

The information about restarted node.

ScheduleBasedHorizontalScalingPolicyDetails

Details of a schedule based horizontal autoscaling policy.
In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.

ScheduleBasedVerticalScalingPolicyDetails

Details of a schedule based vertical autoscaling policy.
In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.

ShapeConfigDetails

The shape configuration requested for the node.

SingleAdCapacityReport

Capacity report for a single-AD region.

SoftwareUpdate

Details about the given software update.

SoftwareUpdateCollection

Results of a software update search. Contains both software update summaries and a summary of the search.

SoftwareUpdateModelConverter

SoftwareUpdateSummary

The software update that is currently available for the cluster.

StartBdsInstanceDetails

The request body for starting a BDS cluster.

StartClusterShapeConfigs

The shape configuration to be used to start the cluster. If the value is not set, the start cluster operation will try to start the cluster as is.

StopBdsInstanceDetails

The request body for stopping a BDS cluster.

TestBdsMetastoreConfigurationDetails

The reqeust body when testing a BDS metastore configuration

TestBdsObjectStorageConnectionDetails

Test access to specified Object Storage bucket using the API key.

TimeAndHorizontalScalingConfig

Time of day and horizontal scaling configuration.

TimeAndVerticalScalingConfig

Time of day and vertical scaling configuration.

UpdateAutoScalePolicyDetails

Update details of an autoscaling policy.

UpdateAutoScalePolicyDetailsModelConverter

UpdateAutoScalingConfigurationDetails

The information about the autoscale configuration.

UpdateBdsInstanceDetails

The information about to-be-updated Big Data Service cluster.

UpdateBdsMetastoreConfigurationDetails

The request body when updating BDS metastore configuration.

UpdateIdentityConfigurationDetails

Details for updating identity config on the cluster

UpdateMetricBasedHorizontalScalingPolicyDetails

Update details of a metric based horizontal autoscaling policy.
In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.

UpdateMetricBasedVerticalScalingPolicyDetails

Update details of a metric based vertical autoscaling policy.
In a metric-based autoscaling policy, an autoscaling action is triggered when a performance metric exceeds a threshold.

UpdateNodeBackupConfigurationDetails

The information about the NodeBackupConfiguration that is being updated.

UpdateNodeReplaceConfigurationDetails

The information about the NodeReplaceConfiguration

UpdateResourcePrincipalConfigurationDetails

Details of updating the resource principal configuration for the cluster.

UpdateScheduleBasedHorizontalScalingPolicyDetails

Update details of a schedule based horizontal autoscaling policy.
In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.

UpdateScheduleBasedVerticalScalingPolicyDetails

Update details of a schedule based vertical autoscaling policy.
In a schedule-based autoscaling policy, an autoscaling action is triggered at the scheduled execution time.

UpstConfiguration

Information about the UPST configuration.

UpstConfigurationDetails

Details for activating/updating UPST config on the cluster

VerticalScalingScheduleDetails

Details of a vertical scaling schedule.

VerticalScalingScheduleDetailsModelConverter

VolumeAttachmentDetail

A detail of the attached block volume.

WorkRequest

Description of the work request status.

WorkRequestError

An error encountered while executing a work request.

WorkRequestLogEntry

A log message from the execution of a work request.

WorkRequestResource

A resource created or operated on by a work request.