Skip to main content

types

AnytimeMaintenanceWindow​

AuthProvider​

Type​

  • TYPE_UNSPECIFIED

  • NATIVE

  • SAML

type : Type​
name : string​
order : int64​
enabled : bool​
hidden : bool​

selector ui settings

description : string​
hint : string​
icon : string​

One of settings​

  • saml : SamlSettings​

AuthProviders​

providers : AuthProvider​

Backup​

id : string​

Required. ID of the backup.

folderId : string​

ID of the folder that the backup belongs to.

sourceClusterId : string​

ID of the associated Elasticsearch cluster.

startedAt : google.protobuf.Timestamp​

The time when the backup operation was started.

createdAt : google.protobuf.Timestamp​

The time when the backup was created (i.e. when the backup operation completed).

indices : string​

Indices names. (max 100)

elasticsearchVersion : string​

Elasticsearch version used to create the snapshot

sizeBytes : int64​

Total size of all indices in backup. in bytes

indicesTotal : int64​

Total count of indices in backup

Cluster​

An Elasticsearch cluster resource. For more information, see the Concepts section of the documentation.

Environment​

  • ENVIRONMENT_UNSPECIFIED

  • PRODUCTION

    Stable environment with a conservative update policy when only hotfixes are applied during regular maintenance.

  • PRESTABLE

    Environment with a more aggressive update policy when new versions are rolled out irrespective of backward compatibility.

Health​

  • HEALTH_UNKNOWN

    State of the cluster is unknown ([Host.health][1] of all hosts in the cluster is UNKNOWN).

  • ALIVE

    Cluster is alive and well ([Host.health][2] of all hosts in the cluster is ALIVE).

  • DEAD

    Cluster is inoperable ([Host.health][3] of all hosts in the cluster is DEAD).

  • DEGRADED

    Cluster is in degraded state ([Host.health][4] of at least one of the hosts in the cluster is not ALIVE).

Status​

  • STATUS_UNKNOWN

    Cluster state is unknown.

  • CREATING

    Cluster is being created.

  • RUNNING

    Cluster is running normally.

  • ERROR

    Cluster encountered a problem and cannot operate.

  • UPDATING

    Cluster is being updated.

  • STOPPING

    Cluster is stopping.

  • STOPPED

    Cluster stopped.

  • STARTING

    Cluster is starting.

id : string​

ID of the Elasticsearch cluster. This ID is assigned at creation time.

folderId : string​

ID of the folder that the Elasticsearch cluster belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

name : string​

Name of the Elasticsearch cluster. The name must be unique within the folder. 1-63 characters long.

description : string​

Description of the Elasticsearch cluster. 0-256 characters long.

labels : string​

Custom labels for the Elasticsearch cluster as key:value pairs. A maximum of 64 labels per resource is allowed.

environment : Environment​

Deployment environment of the Elasticsearch cluster.

monitoring : Monitoring​

Description of monitoring systems relevant to the Elasticsearch cluster.

config : ClusterConfig​

Configuration of the Elasticsearch cluster.

networkId : string​

ID of the network that the cluster belongs to.

health : Health​

Aggregated cluster health.

status : Status​

Current state of the cluster.

securityGroupIds : string​

User security groups

serviceAccountId : string​

ID of the service account used for access to Object Storage.

deletionProtection : bool​

Deletion Protection inhibits deletion of the cluster

maintenanceWindow : MaintenanceWindow​

Window of maintenance operations.

plannedOperation : MaintenanceOperation​

Maintenance operation planned at nearest maintenance_window.

ClusterConfig​

version : string​

Elasticsearch version.

elasticsearch : Elasticsearch​

Configuration and resource allocation for Elasticsearch nodes.

edition : string​

ElasticSearch edition.

Elasticsearch​

DataNode​

One of config​

  • elasticsearchConfigSet_7 : config.ElasticsearchConfigSet7​

    Elasticsearch 7.x data node configuration.

resources : Resources​

Resources allocated to Elasticsearch data nodes.

MasterNode​

resources : Resources​

Resources allocated to Elasticsearch master nodes.

dataNode : DataNode​

Configuration and resource allocation for Elasticsearch data nodes.

masterNode : MasterNode​

Configuration and resource allocation for Elasticsearch master nodes.

plugins : string​

Cluster wide plugins

Extension​

name : string​

Name of the extension.

id : string​

Unique ID of the extension.

clusterId : string​

ID of the Elasticsearch cluster the extension belongs to.

version : int64​

Version of the extension.

active : bool​

The flag shows whether the extension is active.

ExtensionSpec​

name : string​

Name of the extension.

uri : string​

URI of the zip archive to create the new extension from. Currently only supports links that are stored in Object Storage.

disabled : bool​

The flag shows whether to create the extension in disabled state.

Host​

Cluster host metadata.

Type​

  • TYPE_UNSPECIFIED

    Host type is unspecified. Default value.

  • DATA_NODE

    The host is an Elasticsearch data node.

  • MASTER_NODE

    The host is an Elasticsearch master node.

Health​

  • UNKNOWN

    Health of the host is unknown.

  • ALIVE

    The host is performing all its functions normally.

  • DEAD

    The host is inoperable and cannot perform any of its essential functions.

  • DEGRADED

    The host is degraded and can perform only some of its essential functions.

name : string​

Name of the host.

clusterId : string​

ID of the Elasticsearch cluster.

zoneId : string​

ID of the availability zone where the host resides.

type : Type​

Host type.

resources : Resources​
health : Health​

Aggregated host health data. If the field has default value, it is not returned in the response.

services : Service​

Services provided by the host.

subnetId : string​

ID of the subnet the host resides in.

assignPublicIp : bool​

The flag that defines whether a public IP address is assigned to the host.

If the value is true, then this host is available on the Internet via it's public IP address.

MaintenanceOperation​

info : string​
delayedUntil : google.protobuf.Timestamp​

MaintenanceWindow​

One of policy​

  • anytime : AnytimeMaintenanceWindow​
  • weeklyMaintenanceWindow : WeeklyMaintenanceWindow​

Monitoring​

Metadata of monitoring system.

name : string​

Name of the monitoring system.

description : string​

Description of the monitoring system.

Link to the monitoring system charts for the Elasticsearch cluster.

ResourcePreset​

A ResourcePreset resource for describing hardware configuration presets.

id : string​

ID of the resource preset.

zoneIds : string​

IDs of availability zones where the resource preset is available.

cores : int64​

Number of CPU cores for an Elasticsearch node created with the preset.

memory : int64​

RAM volume for an Elasticsearch node created with the preset, in bytes.

Resources​

Computational resources.

resourcePresetId : string​

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.

diskSize : int64​

Volume of the storage available to a host, in bytes.

diskTypeId : string​

Type of the storage environment for the host. All available types are listed in the documentation.

SamlSettings​

idpEntityId : string​
idpMetadataFile : bytes​
spEntityId : string​
kibanaUrl : string​
attributePrincipal : string​
attributeGroups : string​
attributeName : string​
attributeEmail : string​
attributeDn : string​

Service​

Cluster service metadata.

Type​

  • TYPE_UNSPECIFIED

  • ELASTICSEARCH

    The Elasticsearch service.

Health​

  • UNKNOWN

    Health of the service is unknown.

  • ALIVE

    The service is working normally.

  • DEAD

    The service is dead or unresponsive.

type : Type​

Type of the service provided by the host.

health : Health​

Service health data. If the field has default value, it is not returned in the response.

User​

An Elasticsearch user.

name : string​

Name of the Elasticsearch user.

clusterId : string​

ID of the Elasticsearch cluster the user belongs to.

UserSpec​

name : string​

Name of the Elasticsearch user.

password : string​

Password of the Elasticsearch user.

WeeklyMaintenanceWindow​

WeekDay​

  • WEEK_DAY_UNSPECIFIED

  • MON

  • TUE

  • WED

  • THU

  • FRI

  • SAT

  • SUN

day : WeekDay​
hour : int64​

Hour of the day in UTC.