Documentation
¶
Index ¶
- Constants
- type APIBaseURLData
- type APIKeyResponse
- type APIKeysResponse
- type AccountTrustRelationship
- type ActiveDirectoryGroupSearch
- type ActiveDirectorySecurityRealmLoadBalance
- type ActiveDirectorySecurityRealmRoleMappingRule
- type ActiveDirectorySecurityRealmRoleMappingRules
- type ActiveDirectorySettings
- type ActiveDirectoryUserSearch
- type AdminconsoleInfo
- type AdminconsolesOverview
- type AllocatedInstancePlansInfo
- type AllocatedInstanceStatus
- type AllocatorBuildInfo
- type AllocatorCapacity
- type AllocatorCapacityMemory
- type AllocatorHealthStatus
- type AllocatorInfo
- type AllocatorMoveRequest
- type AllocatorOverview
- type AllocatorSettings
- type AllocatorZoneInfo
- type AllocatorsSummary
- type AllocatorsZoneSummary
- type Apm
- type ApmConfiguration
- type ApmCrudResponse
- type ApmInfo
- type ApmPayload
- type ApmPlan
- type ApmPlanControlConfiguration
- type ApmPlanInfo
- type ApmPlansInfo
- type ApmResourceInfo
- type ApmSettings
- type ApmSubInfo
- type ApmSystemSettings
- type ApmTopologyElement
- type ApmsInfo
- type AppSearch
- type AppSearchConfiguration
- type AppSearchInfo
- type AppSearchNodeTypes
- type AppSearchPayload
- type AppSearchPlan
- type AppSearchPlanControlConfiguration
- type AppSearchPlanInfo
- type AppSearchPlansInfo
- type AppSearchResourceInfo
- type AppSearchSettings
- type AppSearchSubInfo
- type AppSearchSystemSettings
- type AppSearchTopologyElement
- type AuthenticationInfo
- type AutodetectStrategyConfig
- type AvailableAuthenticationMethods
- type BasicFailedReply
- type BasicFailedReplyElement
- type Blessing
- type Blessings
- type BlessingsWithMeta
- type BoolQuery
- type CapacityConstraintsResource
- type ChangeSourceInfo
- type ClusterCommandResponse
- type ClusterCredentials
- type ClusterCrudResponse
- type ClusterCurationSettings
- type ClusterCurationSpec
- type ClusterInfo
- type ClusterInstanceConfigurationInfo
- type ClusterInstanceDiskInfo
- type ClusterInstanceInfo
- type ClusterInstanceMemoryInfo
- type ClusterLicenseInfo
- type ClusterMetadataCPUResourcesSettings
- type ClusterMetadataInfo
- type ClusterMetadataPortInfo
- type ClusterMetadataResourcesSettings
- type ClusterMetadataSettings
- type ClusterPlanMigrationResponse
- type ClusterPlanStepInfo
- type ClusterPlanStepLogMessageInfo
- type ClusterSnapshotRepositoryDefault
- type ClusterSnapshotRepositoryInfo
- type ClusterSnapshotRepositoryReference
- type ClusterSnapshotRepositoryStatic
- type ClusterSnapshotRequest
- type ClusterSnapshotResponse
- type ClusterSnapshotRetention
- type ClusterSnapshotSettings
- type ClusterSystemAlert
- type ClusterTopologyInfo
- type ClusterUpgradeInfo
- type ClustersInfo
- type Comment
- type CommentCreateRequest
- type CommentUpdateRequest
- type CommentWithMeta
- type CommentsWithMetas
- type CompatibleNodeTypesResource
- type CompatibleVersionResource
- type ConfigStoreOption
- type ConfigStoreOptionData
- type ConfigStoreOptionList
- type ConstructorHealthStatus
- type ConstructorInfo
- type ConstructorOverview
- type ContainerConfigHostConfig
- type ContainerSetSummary
- type ContainerSetsSummary
- type ContainersEntry
- type ContainersEntryOptions
- type ContainersEntryOptionsACL
- type ContainersEntryOptionsAuth
- type ContainersEntryOptionsContainerConfig
- type ContainersEntryOptionsOverrides
- type CoordinatorSummary
- type CoordinatorsSummary
- type CreateAPIKeyRequest
- type CreateApmInCreateElasticsearchRequest
- type CreateApmRequest
- type CreateAppSearchRequest
- type CreateElasticsearchClusterRequest
- type CreateEnterpriseSearchRequest
- type CreateExtensionRequest
- type CreateKibanaInCreateElasticsearchRequest
- type CreateKibanaRequest
- type Creates
- type CrossClusterSearchClusters
- type CrossClusterSearchInfo
- type CrossClusterSearchSettings
- type DeleteAPIKeysRequest
- type DeleteUsersAPIKeysRequest
- type DeploymentCreateMetadata
- type DeploymentCreateRequest
- type DeploymentCreateResources
- type DeploymentCreateResponse
- type DeploymentCreateSettings
- type DeploymentDeleteResponse
- type DeploymentDiagnostics
- type DeploymentGetResponse
- type DeploymentMetadata
- type DeploymentResource
- type DeploymentResourceCommandResponse
- type DeploymentResourceCrudResponse
- type DeploymentResourceUpgradeResponse
- type DeploymentResources
- type DeploymentRestoreResponse
- type DeploymentSearchResponse
- type DeploymentSettings
- type DeploymentShutdownResponse
- type DeploymentTemplateDefinitionRequest
- type DeploymentTemplateInfo
- type DeploymentTemplateInfoV2
- type DeploymentTemplateReference
- type DeploymentTemplateRequestBody
- type DeploymentUpdateMetadata
- type DeploymentUpdateRequest
- type DeploymentUpdateResources
- type DeploymentUpdateResponse
- type DeploymentsListResponse
- type DeploymentsListingData
- type DeploymentsSearchResponse
- type DeprecatedElasticsearchClusterSettings
- type DiscreteSizes
- type Elasticsearch
- type ElasticsearchClusterBlockingIssueElement
- type ElasticsearchClusterBlockingIssues
- type ElasticsearchClusterInfo
- type ElasticsearchClusterInstanceSettingsOverrides
- type ElasticsearchClusterPlan
- type ElasticsearchClusterPlanInfo
- type ElasticsearchClusterPlansInfo
- type ElasticsearchClusterRole
- type ElasticsearchClusterSecurityInfo
- type ElasticsearchClusterSettings
- type ElasticsearchClusterTopologyElement
- type ElasticsearchClusterUser
- type ElasticsearchClustersInfo
- type ElasticsearchConfiguration
- type ElasticsearchCuration
- type ElasticsearchDependant
- type ElasticsearchElasticUserPasswordResetResponse
- type ElasticsearchInfo
- type ElasticsearchMasterElement
- type ElasticsearchMasterInfo
- type ElasticsearchMonitoringInfo
- type ElasticsearchNodeType
- type ElasticsearchPayload
- type ElasticsearchPlanControlConfiguration
- type ElasticsearchReplicaElement
- type ElasticsearchResourceInfo
- type ElasticsearchScriptTypeSettings
- type ElasticsearchScriptingUserSettings
- type ElasticsearchShardElement
- type ElasticsearchShardsInfo
- type ElasticsearchSystemSettings
- type ElasticsearchUserBundle
- type ElasticsearchUserPlugin
- type ElevatePermissionsRequest
- type ElevatedPermissions
- type EmptyResponse
- type EnableIlmRequest
- type EnrollmentTokenRequest
- type EnterpriseSearch
- type EnterpriseSearchConfiguration
- type EnterpriseSearchInfo
- type EnterpriseSearchNodeTypes
- type EnterpriseSearchPayload
- type EnterpriseSearchPlan
- type EnterpriseSearchPlanControlConfiguration
- type EnterpriseSearchPlanInfo
- type EnterpriseSearchPlansInfo
- type EnterpriseSearchResourceInfo
- type EnterpriseSearchSettings
- type EnterpriseSearchSubInfo
- type EnterpriseSearchSystemSettings
- type EnterpriseSearchTopologyElement
- type ExistsQuery
- type Extension
- type Extensions
- type ExternalHyperlink
- type FilterAssociation
- type GrowShrinkStrategyConfig
- type Hyperlink
- type IDResponse
- type IPFilterRule
- type IPFilterRuleset
- type IPFilterRulesets
- type IPFilteringSettings
- type IndexPattern
- type IndexSynchronizationResults
- type InstanceConfiguration
- type InstanceConfigurationInfo
- type InstanceMoveRequest
- type InstanceTypeResource
- type KeystoreContents
- type KeystoreSecret
- type Kibana
- type KibanaClusterInfo
- type KibanaClusterPlan
- type KibanaClusterPlanInfo
- type KibanaClusterPlansInfo
- type KibanaClusterSettings
- type KibanaClusterTopologyElement
- type KibanaClustersInfo
- type KibanaConfiguration
- type KibanaPayload
- type KibanaPlanControlConfiguration
- type KibanaResourceInfo
- type KibanaSubClusterInfo
- type KibanaSystemSettings
- type LdapGroupSearch
- type LdapSecurityRealmLoadBalance
- type LdapSecurityRealmRoleMappingRule
- type LdapSecurityRealmRoleMappingRules
- type LdapSettings
- type LdapUserSearch
- type LegacySecuritySettings
- type LicenseInfo
- type LicenseObject
- type ListEnrollmentTokenElement
- type ListEnrollmentTokenReply
- type LoggingSettings
- type LoginRequest
- type LoginState
- type ManagedMonitoringSettings
- type MatchAllQuery
- type MatchNoneQuery
- type MatchQuery
- type Metadata
- type MetadataItem
- type MetadataItemValue
- type MetadataItems
- type ModelVersionIndexSynchronizationResults
- type MoveApmClusterConfiguration
- type MoveApmClusterDetails
- type MoveAppSearchConfiguration
- type MoveAppSearchDetails
- type MoveClustersCommandResponse
- type MoveClustersDetails
- type MoveClustersRequest
- type MoveElasticsearchClusterConfiguration
- type MoveElasticsearchClusterDetails
- type MoveEnterpriseSearchConfiguration
- type MoveEnterpriseSearchDetails
- type MoveKibanaClusterConfiguration
- type MoveKibanaClusterDetails
- type NestedQuery
- type NodeTypeResource
- type Note
- type Notes
- type Orphaned
- type OrphanedElasticsearch
- type PendingState
- type PendingStates
- type PendingStatesWithMeta
- type PlanStrategy
- type PlatformInfo
- type PlatformResourcesSummary
- type PlatformServiceImageInfo
- type PlatformServiceInfo
- type PortBinding
- type PrefixQuery
- type ProxiesAllocationsInfo
- type ProxiesFilter
- type ProxiesFilteredGroup
- type ProxiesFilteredGroupHealth
- type ProxiesHTTPSettings
- type ProxiesHealth
- type ProxiesSSOSettings
- type ProxiesSettings
- type ProxiesSummary
- type ProxyAllocationCounts
- type ProxyAllocationInfo
- type ProxyInfo
- type ProxyOverview
- type ProxySummary
- type PublicCertChain
- type PublicCertChainCollection
- type QueryContainer
- type QueryStringQuery
- type RangeQuery
- type ReAuthenticationRequest
- type ReAuthenticationResponse
- type ReadOnlyRequest
- type ReadOnlyResponse
- type RegionInfo
- type RemoteClusterInfo
- type RemoteClusterRef
- type RemoteResourceRef
- type RemoteResources
- type ReplyWarning
- type RepositoryConfig
- type RepositoryConfigs
- type RequestEnrollmentTokenReply
- type RestartPolicy
- type RestoreSnapshotAPIConfiguration
- type RestoreSnapshotConfiguration
- type RestoreSnapshotRepoConfiguration
- type Role
- type RoleAggregate
- type RoleAggregateCreateData
- type RoleAggregates
- type RoleWithMeta
- type RollingGrowShrinkStrategyConfig
- type RollingStrategyConfig
- type RuleSetResponse
- type RulesetAssociations
- type RunnerBuildInfo
- type RunnerContainerInfo
- type RunnerInfo
- type RunnerOverview
- type RunnerRoleInfo
- type RunnerRolesInfo
- type RunnersSummary
- type SamlAttributeSettings
- type SamlIdpSettings
- type SamlSecurityRealmRoleMappingRule
- type SamlSecurityRealmRoleMappingRules
- type SamlSettings
- type SamlSpSettings
- type SearchRequest
- type SecurityDeployment
- type SecurityDeploymentCreateRequest
- type SecurityDeploymentTopology
- type SecurityDeploymentUpdateRequest
- type SecurityRealmInfo
- type SecurityRealmInfoList
- type SecurityRealmsReorderRequest
- type SnapshotRepositoryConfiguration
- type SnapshotStatusInfo
- type SsoAuthenticationMethodInfo
- type StackVersionApmConfig
- type StackVersionAppSearchConfig
- type StackVersionArchiveProcessingError
- type StackVersionArchiveProcessingResult
- type StackVersionConfig
- type StackVersionConfigPost
- type StackVersionConfigs
- type StackVersionElasticsearchConfig
- type StackVersionEnterpriseSearchConfig
- type StackVersionInstanceCapacityConstraint
- type StackVersionKibanaConfig
- type StackVersionMetadata
- type StackVersionNodeType
- type StackVersionTemplateFileHash
- type StackVersionTemplateInfo
- type TLSPublicCertChain
- type TargetElasticsearchCluster
- type TelemetryConfig
- type TelemetryConfigRequest
- type TermQuery
- type TiebreakerTopologyElement
- type TokenResponse
- type TopologySize
- type TrafficFilterRule
- type TrafficFilterRulesetInfo
- type TrafficFilterRulesetRequest
- type TrafficFilterRulesetResponse
- type TrafficFilterRulesets
- type TrafficFilterSettings
- type TransientApmPlanConfiguration
- type TransientAppSearchPlanConfiguration
- type TransientElasticsearchPlanConfiguration
- type TransientEnterpriseSearchPlanConfiguration
- type TransientKibanaPlanConfiguration
- type TrustSettings
- type UnreachableRegionInfo
- type UpdateExtensionRequest
- type Updates
- type UsageStats
- type User
- type UserAPIKey
- type UserList
- type UserMetadata
- type UserSecurity
- type UserSecurityRealm
- type ZookeeperNodeInfo
- type ZookeeperSummary
Constants ¶
const ( // ActiveDirectoryGroupSearchScopeSubTree captures enum value "sub_tree" ActiveDirectoryGroupSearchScopeSubTree string = "sub_tree" // ActiveDirectoryGroupSearchScopeOneLevel captures enum value "one_level" ActiveDirectoryGroupSearchScopeOneLevel string = "one_level" // ActiveDirectoryGroupSearchScopeBase captures enum value "base" ActiveDirectoryGroupSearchScopeBase string = "base" )
const ( // ActiveDirectorySecurityRealmLoadBalanceTypeFailover captures enum value "failover" ActiveDirectorySecurityRealmLoadBalanceTypeFailover string = "failover" // ActiveDirectorySecurityRealmLoadBalanceTypeDNSFailover captures enum value "dns_failover" ActiveDirectorySecurityRealmLoadBalanceTypeDNSFailover string = "dns_failover" // ActiveDirectorySecurityRealmLoadBalanceTypeRoundRobin captures enum value "round_robin" ActiveDirectorySecurityRealmLoadBalanceTypeRoundRobin string = "round_robin" // ActiveDirectorySecurityRealmLoadBalanceTypeDNSRoundRobin captures enum value "dns_round_robin" ActiveDirectorySecurityRealmLoadBalanceTypeDNSRoundRobin string = "dns_round_robin" )
const ( // ActiveDirectorySecurityRealmRoleMappingRuleTypeUserDn captures enum value "user_dn" ActiveDirectorySecurityRealmRoleMappingRuleTypeUserDn string = "user_dn" // ActiveDirectorySecurityRealmRoleMappingRuleTypeGroupDn captures enum value "group_dn" ActiveDirectorySecurityRealmRoleMappingRuleTypeGroupDn string = "group_dn" )
const ( // ActiveDirectorySettingsCertificateURLTruststoreTypeJks captures enum value "jks" ActiveDirectorySettingsCertificateURLTruststoreTypeJks string = "jks" // ActiveDirectorySettingsCertificateURLTruststoreTypePKCS12 captures enum value "PKCS12" ActiveDirectorySettingsCertificateURLTruststoreTypePKCS12 string = "PKCS12" )
const ( // ActiveDirectoryUserSearchScopeSubTree captures enum value "sub_tree" ActiveDirectoryUserSearchScopeSubTree string = "sub_tree" // ActiveDirectoryUserSearchScopeOneLevel captures enum value "one_level" ActiveDirectoryUserSearchScopeOneLevel string = "one_level" // ActiveDirectoryUserSearchScopeBase captures enum value "base" ActiveDirectoryUserSearchScopeBase string = "base" )
const ( // ApmInfoStatusInitializing captures enum value "initializing" ApmInfoStatusInitializing string = "initializing" // ApmInfoStatusStopping captures enum value "stopping" ApmInfoStatusStopping string = "stopping" // ApmInfoStatusStopped captures enum value "stopped" ApmInfoStatusStopped string = "stopped" // ApmInfoStatusRebooting captures enum value "rebooting" ApmInfoStatusRebooting string = "rebooting" // ApmInfoStatusRestarting captures enum value "restarting" ApmInfoStatusRestarting string = "restarting" // ApmInfoStatusReconfiguring captures enum value "reconfiguring" ApmInfoStatusReconfiguring string = "reconfiguring" // ApmInfoStatusStarted captures enum value "started" ApmInfoStatusStarted string = "started" )
const ( // AppSearchInfoStatusInitializing captures enum value "initializing" AppSearchInfoStatusInitializing string = "initializing" // AppSearchInfoStatusStopping captures enum value "stopping" AppSearchInfoStatusStopping string = "stopping" // AppSearchInfoStatusStopped captures enum value "stopped" AppSearchInfoStatusStopped string = "stopped" // AppSearchInfoStatusRebooting captures enum value "rebooting" AppSearchInfoStatusRebooting string = "rebooting" // AppSearchInfoStatusRestarting captures enum value "restarting" AppSearchInfoStatusRestarting string = "restarting" // AppSearchInfoStatusReconfiguring captures enum value "reconfiguring" AppSearchInfoStatusReconfiguring string = "reconfiguring" // AppSearchInfoStatusStarted captures enum value "started" AppSearchInfoStatusStarted string = "started" )
const ( // AuthenticationInfoTotpDeviceSourceNative captures enum value "native" AuthenticationInfoTotpDeviceSourceNative string = "native" // AuthenticationInfoTotpDeviceSourceOkta captures enum value "okta" AuthenticationInfoTotpDeviceSourceOkta string = "okta" )
const ( // ClusterInstanceConfigurationInfoResourceMemory captures enum value "memory" ClusterInstanceConfigurationInfoResourceMemory string = "memory" // ClusterInstanceConfigurationInfoResourceStorage captures enum value "storage" ClusterInstanceConfigurationInfoResourceStorage string = "storage" )
const ( // ClusterPlanStepInfoStageStarting captures enum value "starting" ClusterPlanStepInfoStageStarting string = "starting" // ClusterPlanStepInfoStageCompleted captures enum value "completed" ClusterPlanStepInfoStageCompleted string = "completed" // ClusterPlanStepInfoStageInProgress captures enum value "in_progress" ClusterPlanStepInfoStageInProgress string = "in_progress" )
const ( // ClusterPlanStepInfoStatusSuccess captures enum value "success" ClusterPlanStepInfoStatusSuccess string = "success" // ClusterPlanStepInfoStatusWarning captures enum value "warning" ClusterPlanStepInfoStatusWarning string = "warning" // ClusterPlanStepInfoStatusError captures enum value "error" ClusterPlanStepInfoStatusError string = "error" // ClusterPlanStepInfoStatusPending captures enum value "pending" ClusterPlanStepInfoStatusPending string = "pending" )
const ( // ClusterPlanStepLogMessageInfoStageStarting captures enum value "starting" ClusterPlanStepLogMessageInfoStageStarting string = "starting" // ClusterPlanStepLogMessageInfoStageCompleted captures enum value "completed" ClusterPlanStepLogMessageInfoStageCompleted string = "completed" // ClusterPlanStepLogMessageInfoStageInProgress captures enum value "in_progress" ClusterPlanStepLogMessageInfoStageInProgress string = "in_progress" )
const ( // ClusterSystemAlertAlertTypeAutomaticRestart captures enum value "automatic_restart" ClusterSystemAlertAlertTypeAutomaticRestart string = "automatic_restart" // ClusterSystemAlertAlertTypeHeapDump captures enum value "heap_dump" ClusterSystemAlertAlertTypeHeapDump string = "heap_dump" // ClusterSystemAlertAlertTypeUnknownEvent captures enum value "unknown_event" ClusterSystemAlertAlertTypeUnknownEvent string = "unknown_event" )
const ( // CreateExtensionRequestExtensionTypePlugin captures enum value "plugin" CreateExtensionRequestExtensionTypePlugin string = "plugin" // CreateExtensionRequestExtensionTypeBundle captures enum value "bundle" CreateExtensionRequestExtensionTypeBundle string = "bundle" )
const ( // DiscreteSizesResourceMemory captures enum value "memory" DiscreteSizesResourceMemory string = "memory" // DiscreteSizesResourceStorage captures enum value "storage" DiscreteSizesResourceStorage string = "storage" )
const ( // ElasticsearchClusterInfoStatusInitializing captures enum value "initializing" ElasticsearchClusterInfoStatusInitializing string = "initializing" // ElasticsearchClusterInfoStatusStopping captures enum value "stopping" ElasticsearchClusterInfoStatusStopping string = "stopping" // ElasticsearchClusterInfoStatusStopped captures enum value "stopped" ElasticsearchClusterInfoStatusStopped string = "stopped" // ElasticsearchClusterInfoStatusRebooting captures enum value "rebooting" ElasticsearchClusterInfoStatusRebooting string = "rebooting" // ElasticsearchClusterInfoStatusRestarting captures enum value "restarting" ElasticsearchClusterInfoStatusRestarting string = "restarting" // ElasticsearchClusterInfoStatusReconfiguring captures enum value "reconfiguring" ElasticsearchClusterInfoStatusReconfiguring string = "reconfiguring" // ElasticsearchClusterInfoStatusStarted captures enum value "started" ElasticsearchClusterInfoStatusStarted string = "started" )
const ( // EnterpriseSearchInfoStatusInitializing captures enum value "initializing" EnterpriseSearchInfoStatusInitializing string = "initializing" // EnterpriseSearchInfoStatusStopping captures enum value "stopping" EnterpriseSearchInfoStatusStopping string = "stopping" // EnterpriseSearchInfoStatusStopped captures enum value "stopped" EnterpriseSearchInfoStatusStopped string = "stopped" // EnterpriseSearchInfoStatusRebooting captures enum value "rebooting" EnterpriseSearchInfoStatusRebooting string = "rebooting" // EnterpriseSearchInfoStatusRestarting captures enum value "restarting" EnterpriseSearchInfoStatusRestarting string = "restarting" // EnterpriseSearchInfoStatusReconfiguring captures enum value "reconfiguring" EnterpriseSearchInfoStatusReconfiguring string = "reconfiguring" // EnterpriseSearchInfoStatusStarted captures enum value "started" EnterpriseSearchInfoStatusStarted string = "started" )
const ( // ExtensionExtensionTypePlugin captures enum value "plugin" ExtensionExtensionTypePlugin string = "plugin" // ExtensionExtensionTypeBundle captures enum value "bundle" ExtensionExtensionTypeBundle string = "bundle" )
const ( // KibanaClusterInfoStatusInitializing captures enum value "initializing" KibanaClusterInfoStatusInitializing string = "initializing" // KibanaClusterInfoStatusStopping captures enum value "stopping" KibanaClusterInfoStatusStopping string = "stopping" // KibanaClusterInfoStatusStopped captures enum value "stopped" KibanaClusterInfoStatusStopped string = "stopped" // KibanaClusterInfoStatusRebooting captures enum value "rebooting" KibanaClusterInfoStatusRebooting string = "rebooting" // KibanaClusterInfoStatusRestarting captures enum value "restarting" KibanaClusterInfoStatusRestarting string = "restarting" // KibanaClusterInfoStatusReconfiguring captures enum value "reconfiguring" KibanaClusterInfoStatusReconfiguring string = "reconfiguring" // KibanaClusterInfoStatusStarted captures enum value "started" KibanaClusterInfoStatusStarted string = "started" )
const ( // LdapGroupSearchScopeSubTree captures enum value "sub_tree" LdapGroupSearchScopeSubTree string = "sub_tree" // LdapGroupSearchScopeOneLevel captures enum value "one_level" LdapGroupSearchScopeOneLevel string = "one_level" // LdapGroupSearchScopeBase captures enum value "base" LdapGroupSearchScopeBase string = "base" )
const ( // LdapSecurityRealmLoadBalanceTypeFailover captures enum value "failover" LdapSecurityRealmLoadBalanceTypeFailover string = "failover" // LdapSecurityRealmLoadBalanceTypeDNSFailover captures enum value "dns_failover" LdapSecurityRealmLoadBalanceTypeDNSFailover string = "dns_failover" // LdapSecurityRealmLoadBalanceTypeRoundRobin captures enum value "round_robin" LdapSecurityRealmLoadBalanceTypeRoundRobin string = "round_robin" // LdapSecurityRealmLoadBalanceTypeDNSRoundRobin captures enum value "dns_round_robin" LdapSecurityRealmLoadBalanceTypeDNSRoundRobin string = "dns_round_robin" )
const ( // LdapSecurityRealmRoleMappingRuleTypeUserDn captures enum value "user_dn" LdapSecurityRealmRoleMappingRuleTypeUserDn string = "user_dn" // LdapSecurityRealmRoleMappingRuleTypeGroupDn captures enum value "group_dn" LdapSecurityRealmRoleMappingRuleTypeGroupDn string = "group_dn" )
const ( // LdapSettingsBindTypeUserSearch captures enum value "user_search" LdapSettingsBindTypeUserSearch string = "user_search" // LdapSettingsBindTypeUserTemplates captures enum value "user_templates" LdapSettingsBindTypeUserTemplates string = "user_templates" )
const ( // LdapSettingsCertificateURLTruststoreTypeJks captures enum value "jks" LdapSettingsCertificateURLTruststoreTypeJks string = "jks" // LdapSettingsCertificateURLTruststoreTypePKCS12 captures enum value "PKCS12" LdapSettingsCertificateURLTruststoreTypePKCS12 string = "PKCS12" )
const ( // LdapUserSearchScopeSubTree captures enum value "sub_tree" LdapUserSearchScopeSubTree string = "sub_tree" // LdapUserSearchScopeOneLevel captures enum value "one_level" LdapUserSearchScopeOneLevel string = "one_level" // LdapUserSearchScopeBase captures enum value "base" LdapUserSearchScopeBase string = "base" )
const ( // NestedQueryScoreModeAvg captures enum value "avg" NestedQueryScoreModeAvg string = "avg" // NestedQueryScoreModeSum captures enum value "sum" NestedQueryScoreModeSum string = "sum" // NestedQueryScoreModeMin captures enum value "min" NestedQueryScoreModeMin string = "min" // NestedQueryScoreModeMax captures enum value "max" NestedQueryScoreModeMax string = "max" // NestedQueryScoreModeNone captures enum value "none" NestedQueryScoreModeNone string = "none" )
const ( // RestoreSnapshotConfigurationStrategyPartial captures enum value "partial" RestoreSnapshotConfigurationStrategyPartial string = "partial" // RestoreSnapshotConfigurationStrategyFull captures enum value "full" RestoreSnapshotConfigurationStrategyFull string = "full" // RestoreSnapshotConfigurationStrategyRecovery captures enum value "recovery" RestoreSnapshotConfigurationStrategyRecovery string = "recovery" )
const ( // SamlSecurityRealmRoleMappingRuleTypeUsername captures enum value "username" SamlSecurityRealmRoleMappingRuleTypeUsername string = "username" // SamlSecurityRealmRoleMappingRuleTypeGroups captures enum value "groups" SamlSecurityRealmRoleMappingRuleTypeGroups string = "groups" // SamlSecurityRealmRoleMappingRuleTypeDn captures enum value "dn" SamlSecurityRealmRoleMappingRuleTypeDn string = "dn" )
const ( // SamlSettingsSslCertificateURLTruststoreTypeJks captures enum value "jks" SamlSettingsSslCertificateURLTruststoreTypeJks string = "jks" // SamlSettingsSslCertificateURLTruststoreTypePKCS12 captures enum value "PKCS12" SamlSettingsSslCertificateURLTruststoreTypePKCS12 string = "PKCS12" )
const ( // SecurityDeploymentStatusInitializing captures enum value "initializing" SecurityDeploymentStatusInitializing string = "initializing" // SecurityDeploymentStatusStopping captures enum value "stopping" SecurityDeploymentStatusStopping string = "stopping" // SecurityDeploymentStatusStopped captures enum value "stopped" SecurityDeploymentStatusStopped string = "stopped" // SecurityDeploymentStatusRebooting captures enum value "rebooting" SecurityDeploymentStatusRebooting string = "rebooting" // SecurityDeploymentStatusRestarting captures enum value "restarting" SecurityDeploymentStatusRestarting string = "restarting" // SecurityDeploymentStatusReconfiguring captures enum value "reconfiguring" SecurityDeploymentStatusReconfiguring string = "reconfiguring" // SecurityDeploymentStatusStarted captures enum value "started" SecurityDeploymentStatusStarted string = "started" )
const ( // SecurityRealmInfoTypeNative captures enum value "native" SecurityRealmInfoTypeNative string = "native" // SecurityRealmInfoTypeLdap captures enum value "ldap" SecurityRealmInfoTypeLdap string = "ldap" // SecurityRealmInfoTypeSaml captures enum value "saml" SecurityRealmInfoTypeSaml string = "saml" // SecurityRealmInfoTypeActiveDirectory captures enum value "active_directory" SecurityRealmInfoTypeActiveDirectory string = "active_directory" )
const ( // SsoAuthenticationMethodInfoSsoTypeSaml captures enum value "saml" SsoAuthenticationMethodInfoSsoTypeSaml string = "saml" // SsoAuthenticationMethodInfoSsoTypeOpenid captures enum value "openid" SsoAuthenticationMethodInfoSsoTypeOpenid string = "openid" )
const ( // TopologySizeResourceMemory captures enum value "memory" TopologySizeResourceMemory string = "memory" // TopologySizeResourceStorage captures enum value "storage" TopologySizeResourceStorage string = "storage" )
const ( // UpdateExtensionRequestExtensionTypePlugin captures enum value "plugin" UpdateExtensionRequestExtensionTypePlugin string = "plugin" // UpdateExtensionRequestExtensionTypeBundle captures enum value "bundle" UpdateExtensionRequestExtensionTypeBundle string = "bundle" )
const ( // UserSecurityRealmTypeNative captures enum value "native" UserSecurityRealmTypeNative string = "native" // UserSecurityRealmTypeLdap captures enum value "ldap" UserSecurityRealmTypeLdap string = "ldap" // UserSecurityRealmTypeSaml captures enum value "saml" UserSecurityRealmTypeSaml string = "saml" // UserSecurityRealmTypeActiveDirectory captures enum value "active_directory" UserSecurityRealmTypeActiveDirectory string = "active_directory" )
const ( // ZookeeperNodeInfoStateConnected captures enum value "connected" ZookeeperNodeInfoStateConnected string = "connected" // ZookeeperNodeInfoStateSuspended captures enum value "suspended" ZookeeperNodeInfoStateSuspended string = "suspended" // ZookeeperNodeInfoStateReconnected captures enum value "reconnected" ZookeeperNodeInfoStateReconnected string = "reconnected" // ZookeeperNodeInfoStateLost captures enum value "lost" ZookeeperNodeInfoStateLost string = "lost" // ZookeeperNodeInfoStateReadOnly captures enum value "read_only" ZookeeperNodeInfoStateReadOnly string = "read_only" )
const ( // ApmPlanControlConfigurationClusterRebootForced captures enum value "forced" ApmPlanControlConfigurationClusterRebootForced string = "forced" )
const ( // AppSearchPlanControlConfigurationClusterRebootForced captures enum value "forced" AppSearchPlanControlConfigurationClusterRebootForced string = "forced" )
const ( // ElasticsearchPlanControlConfigurationClusterRebootForced captures enum value "forced" ElasticsearchPlanControlConfigurationClusterRebootForced string = "forced" )
const ( // EnterpriseSearchPlanControlConfigurationClusterRebootForced captures enum value "forced" EnterpriseSearchPlanControlConfigurationClusterRebootForced string = "forced" )
const ( // KibanaPlanControlConfigurationClusterRebootForced captures enum value "forced" KibanaPlanControlConfigurationClusterRebootForced string = "forced" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIBaseURLData ¶
type APIBaseURLData struct {
// The configured base Url
// Required: true
Value *string `json:"value"`
}
APIBaseURLData Information about the API base Url swagger:model ApiBaseUrlData
func (*APIBaseURLData) MarshalBinary ¶
func (m *APIBaseURLData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIBaseURLData) UnmarshalBinary ¶
func (m *APIBaseURLData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIKeyResponse ¶
type APIKeyResponse struct {
// The date/time for when the API key is created.
// Required: true
// Format: date-time
CreationDate *strfmt.DateTime `json:"creation_date"`
// The API key description. TIP: Useful when you have multiple API keys.
// Required: true
Description *string `json:"description"`
// The API key ID.
// Required: true
ID *string `json:"id"`
// The API key. TIP: Since the API key is returned only once, save it in a safe place.
Key string `json:"key,omitempty"`
// The user ID.
UserID string `json:"user_id,omitempty"`
}
APIKeyResponse The response model for an API key. swagger:model ApiKeyResponse
func (*APIKeyResponse) MarshalBinary ¶
func (m *APIKeyResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIKeyResponse) UnmarshalBinary ¶
func (m *APIKeyResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIKeysResponse ¶
type APIKeysResponse struct {
// The list of API keys.
// Required: true
Keys []*APIKeyResponse `json:"keys"`
}
APIKeysResponse The response model for the API keys. swagger:model ApiKeysResponse
func (*APIKeysResponse) MarshalBinary ¶
func (m *APIKeysResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIKeysResponse) UnmarshalBinary ¶
func (m *APIKeysResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AccountTrustRelationship ¶
type AccountTrustRelationship struct {
// the ID of the Account
// Required: true
AccountID *string `json:"account_id"`
// If true, all the clusters of this account will be trusted and the `trust_whitelist` is ignored.
// Required: true
TrustAll *bool `json:"trust_all"`
// The list of clusters to trust. Only used when `trust_all` is false.
TrustWhitelist []string `json:"trust_whitelist"`
}
AccountTrustRelationship The trust relationship with the clusters of one account. swagger:model AccountTrustRelationship
func (*AccountTrustRelationship) MarshalBinary ¶
func (m *AccountTrustRelationship) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AccountTrustRelationship) UnmarshalBinary ¶
func (m *AccountTrustRelationship) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ActiveDirectoryGroupSearch ¶
type ActiveDirectoryGroupSearch struct {
// Specifies a container DN to search for groups in which the user has membership
BaseDn string `json:"base_dn,omitempty"`
// Specifies whether the group search should be sub_tree, one_level or base. one_level only searches objects directly contained within the base_dn. The default sub_tree searches all objects contained under base_dn. base specifies that the base_dn is a group object, and that it is the only group considered.
// Enum: [sub_tree one_level base]
Scope string `json:"scope,omitempty"`
}
ActiveDirectoryGroupSearch Elasticsearch Security Active Directory realm group search configuration swagger:model ActiveDirectoryGroupSearch
func (*ActiveDirectoryGroupSearch) MarshalBinary ¶
func (m *ActiveDirectoryGroupSearch) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ActiveDirectoryGroupSearch) UnmarshalBinary ¶
func (m *ActiveDirectoryGroupSearch) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ActiveDirectorySecurityRealmLoadBalance ¶
type ActiveDirectorySecurityRealmLoadBalance struct {
// When using dns_failover or dns_round_robin as the load balancing type, this setting controls the amount of time to cache DNS lookups. Defaults to 1h.
CacheTTL string `json:"cache_ttl,omitempty"`
// The behavior to use when there are multiple Active Directory URLs defined
// Enum: [failover dns_failover round_robin dns_round_robin]
Type string `json:"type,omitempty"`
}
ActiveDirectorySecurityRealmLoadBalance Elasticsearch Security Active Directory load balancing configuration swagger:model ActiveDirectorySecurityRealmLoadBalance
func (*ActiveDirectorySecurityRealmLoadBalance) MarshalBinary ¶
func (m *ActiveDirectorySecurityRealmLoadBalance) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ActiveDirectorySecurityRealmLoadBalance) UnmarshalBinary ¶
func (m *ActiveDirectorySecurityRealmLoadBalance) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ActiveDirectorySecurityRealmRoleMappingRule ¶
type ActiveDirectorySecurityRealmRoleMappingRule struct {
// The roles that are applied when the mapping rule is successfully evaluated
// Required: true
Roles []string `json:"roles"`
// The type of role mapping rule
// Required: true
// Enum: [user_dn group_dn]
Type *string `json:"type"`
// The value to match when evaluating this rule
// Required: true
Value *string `json:"value"`
}
ActiveDirectorySecurityRealmRoleMappingRule Elasticsearch Security Active Directory role mapping rule swagger:model ActiveDirectorySecurityRealmRoleMappingRule
func (*ActiveDirectorySecurityRealmRoleMappingRule) MarshalBinary ¶
func (m *ActiveDirectorySecurityRealmRoleMappingRule) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ActiveDirectorySecurityRealmRoleMappingRule) UnmarshalBinary ¶
func (m *ActiveDirectorySecurityRealmRoleMappingRule) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ActiveDirectorySecurityRealmRoleMappingRules ¶
type ActiveDirectorySecurityRealmRoleMappingRules struct {
// The default roles applied to all users
// Required: true
DefaultRoles []string `json:"default_roles"`
// The role mapping rules to evaluate
// Required: true
Rules []*ActiveDirectorySecurityRealmRoleMappingRule `json:"rules"`
}
ActiveDirectorySecurityRealmRoleMappingRules Elasticsearch Security Active Directory role mapping rule set swagger:model ActiveDirectorySecurityRealmRoleMappingRules
func (*ActiveDirectorySecurityRealmRoleMappingRules) MarshalBinary ¶
func (m *ActiveDirectorySecurityRealmRoleMappingRules) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ActiveDirectorySecurityRealmRoleMappingRules) UnmarshalBinary ¶
func (m *ActiveDirectorySecurityRealmRoleMappingRules) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ActiveDirectorySettings ¶
type ActiveDirectorySettings struct {
// When true, bindDb credentials are ignored
// Required: true
BindAnonymously *bool `json:"bind_anonymously"`
// The distinguished name of the user that is used to bind to the Active Directory and perform searches.
BindDn string `json:"bind_dn,omitempty"`
// The user password that is used to bind to the Active Directory server.
BindPassword string `json:"bind_password,omitempty"`
// The SSL trusted CA certificate bundle URL. The bundle should be a zip file containing a single keystore file 'keystore.ks' in the directory '/active_directory/:id/truststore', where :id is the value of the [id] field.
CertificateURL string `json:"certificate_url,omitempty"`
// The password to the certificate bundle URL truststore
CertificateURLTruststorePassword string `json:"certificate_url_truststore_password,omitempty"`
// The format of the keystore file. Should be jks to use the Java Keystore format or PKCS12 to use PKCS#12 files. The default is jks.
// Enum: [jks PKCS12]
CertificateURLTruststoreType string `json:"certificate_url_truststore_type,omitempty"`
// Specifies the domain name of the Active Directory (the forest root domain name).
// Required: true
DomainName *string `json:"domain_name"`
// When true, enables the security realm
Enabled *bool `json:"enabled,omitempty"`
// The Active Directory group search configuration
GroupSearch *ActiveDirectoryGroupSearch `json:"group_search,omitempty"`
// The identifier for the security realm
// Required: true
ID *string `json:"id"`
// The Active Directory load balancing behavior
LoadBalance *ActiveDirectorySecurityRealmLoadBalance `json:"load_balance,omitempty"`
// The friendly name of the security realm
// Required: true
Name *string `json:"name"`
// The order that the security realm is evaluated
Order int32 `json:"order,omitempty"`
// Advanced configuration options in YAML format. Any settings defined here will override any configuration set via the API. Note that all keys should omit the 'xpack.security.authc.realms.active_directory.{realm_id}' prefix. For example, when the realm ID is set to 'ad1', the advanced configuration 'xpack.security.authc.realms.active_directory.ad1.ssl.verification_mode: full' should be added as 'ssl.verification_mode: full'.
OverrideYaml string `json:"override_yaml,omitempty"`
// The role mapping rules associated with the security realm
RoleMappings *ActiveDirectorySecurityRealmRoleMappingRules `json:"role_mappings,omitempty"`
// The Active Directory URLs used to authenticate against, in the format ldap[s]://server:port. Note that ldap and ldaps protocols cannot be mixed together.
// Required: true
Urls []string `json:"urls"`
// The Active Directory user search configuration.
UserSearch *ActiveDirectoryUserSearch `json:"user_search,omitempty"`
}
ActiveDirectorySettings Elasticsearch Security Active Directory realm configuration swagger:model ActiveDirectorySettings
func (*ActiveDirectorySettings) MarshalBinary ¶
func (m *ActiveDirectorySettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ActiveDirectorySettings) UnmarshalBinary ¶
func (m *ActiveDirectorySettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ActiveDirectoryUserSearch ¶
type ActiveDirectoryUserSearch struct {
// Specifies a container DN to search for users
BaseDn string `json:"base_dn,omitempty"`
// Specifies the filter to search the directory and match an entry with the username provided by the user. Defaults to (uid={0}). {0} is substituted with the username provided when searching.
Filter string `json:"filter,omitempty"`
// The scope of the user search. Valid values are sub_tree, one_level, or base. one_level only searches objects directly contained in the base_dn. sub_tree searches all objects contained in base_dn. base specifies that the base_dn is the user object, and that it is the only user considered. Defaults to sub_tree.
// Enum: [sub_tree one_level base]
Scope string `json:"scope,omitempty"`
}
ActiveDirectoryUserSearch Elasticsearch Security Active Directory realm user search configuration swagger:model ActiveDirectoryUserSearch
func (*ActiveDirectoryUserSearch) MarshalBinary ¶
func (m *ActiveDirectoryUserSearch) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ActiveDirectoryUserSearch) UnmarshalBinary ¶
func (m *ActiveDirectoryUserSearch) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AdminconsoleInfo ¶
type AdminconsoleInfo struct {
// Identifier for this adminconsole
// Required: true
AdminconsoleID *string `json:"adminconsole_id"`
}
AdminconsoleInfo Information for the adminconsole. swagger:model AdminconsoleInfo
func (*AdminconsoleInfo) MarshalBinary ¶
func (m *AdminconsoleInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AdminconsoleInfo) UnmarshalBinary ¶
func (m *AdminconsoleInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AdminconsolesOverview ¶
type AdminconsolesOverview struct {
// List of adminconsoles
// Required: true
Adminconsoles []*AdminconsoleInfo `json:"adminconsoles"`
}
AdminconsolesOverview Information about all of the adminconsoles. swagger:model AdminconsolesOverview
func (*AdminconsolesOverview) MarshalBinary ¶
func (m *AdminconsolesOverview) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AdminconsolesOverview) UnmarshalBinary ¶
func (m *AdminconsolesOverview) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AllocatedInstancePlansInfo ¶
type AllocatedInstancePlansInfo struct {
// Whether or not there is a pending plan.
// Required: true
Pending *bool `json:"pending"`
// The version of the current plan, falling back to that of the pending plan if it exists.
Version string `json:"version,omitempty"`
// The number of zones in the current plan, falling back to that of the pending plan if it exists.
ZoneCount int32 `json:"zone_count,omitempty"`
}
AllocatedInstancePlansInfo The plan information for the Elasticsearch cluster associated with the Kibana instance or APM Server. swagger:model AllocatedInstancePlansInfo
func (*AllocatedInstancePlansInfo) MarshalBinary ¶
func (m *AllocatedInstancePlansInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllocatedInstancePlansInfo) UnmarshalBinary ¶
func (m *AllocatedInstancePlansInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AllocatedInstanceStatus ¶
type AllocatedInstanceStatus struct {
// Indicates whether the cluster the instance belongs to is healthy
ClusterHealthy *bool `json:"cluster_healthy,omitempty"`
// Identifier for the cluster this instance belongs
// Required: true
ClusterID *string `json:"cluster_id"`
// Name of cluster this instance belongs, if available
ClusterName string `json:"cluster_name,omitempty"`
// Type of instance that is running. E.g. elasticsearch, kibana
// Required: true
ClusterType *string `json:"cluster_type"`
// The id of the deployment this cluster belongs to.
DeploymentID string `json:"deployment_id,omitempty"`
// Indicates whether the instance is healthy
Healthy *bool `json:"healthy,omitempty"`
// The instance configuration id of this instance
InstanceConfigurationID string `json:"instance_configuration_id,omitempty"`
// Instance ID of the instance
// Required: true
InstanceName *string `json:"instance_name"`
// Indicates whether the instance is vacating away from this allocator. Note that this is currently not populated when returned from the search endpoint.
Moving *bool `json:"moving,omitempty"`
// Memory assigned to this instance
// Required: true
NodeMemory *int32 `json:"node_memory"`
// The plans associated with the current instance. Note that this is currently not populated when returned from the search endpoint.
PlansInfo *AllocatedInstancePlansInfo `json:"plans_info,omitempty"`
}
AllocatedInstanceStatus The status of the allocated Kibana instance or APM Server. swagger:model AllocatedInstanceStatus
func (*AllocatedInstanceStatus) MarshalBinary ¶
func (m *AllocatedInstanceStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllocatedInstanceStatus) UnmarshalBinary ¶
func (m *AllocatedInstanceStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AllocatorBuildInfo ¶
type AllocatorBuildInfo struct {
// Git commit hash
CommitHash string `json:"commit_hash,omitempty"`
// Version of the artifact
Version string `json:"version,omitempty"`
}
AllocatorBuildInfo Information about the build that is running on the allocator. swagger:model AllocatorBuildInfo
func (*AllocatorBuildInfo) MarshalBinary ¶
func (m *AllocatorBuildInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllocatorBuildInfo) UnmarshalBinary ¶
func (m *AllocatorBuildInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AllocatorCapacity ¶
type AllocatorCapacity struct {
// memory
// Required: true
Memory *AllocatorCapacityMemory `json:"memory"`
}
AllocatorCapacity The total and used capacity of the allocator. swagger:model AllocatorCapacity
func (*AllocatorCapacity) MarshalBinary ¶
func (m *AllocatorCapacity) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllocatorCapacity) UnmarshalBinary ¶
func (m *AllocatorCapacity) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AllocatorCapacityMemory ¶
type AllocatorCapacityMemory struct {
// Total memory in MB capacity installed on this allocator
// Required: true
Total *int32 `json:"total"`
// Used memory in MB used by instances assigned to this allocator
// Required: true
Used *int32 `json:"used"`
}
AllocatorCapacityMemory The available and used memory of the allocator. swagger:model AllocatorCapacityMemory
func (*AllocatorCapacityMemory) MarshalBinary ¶
func (m *AllocatorCapacityMemory) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllocatorCapacityMemory) UnmarshalBinary ¶
func (m *AllocatorCapacityMemory) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AllocatorHealthStatus ¶
type AllocatorHealthStatus struct {
// Whether the allocator is connected
// Required: true
Connected *bool `json:"connected"`
// Whether the allocator is healthy, meaning it is either connected or has no instances
// Required: true
Healthy *bool `json:"healthy"`
// Whether the allocator is in maintenance mode (meaning that new workload won't be assigned to it)
// Required: true
MaintenanceMode *bool `json:"maintenance_mode"`
// Timestamp when allocator last entered or exited maintenance mode
// Format: date-time
MaintenanceModeTimestamp strfmt.DateTime `json:"maintenance_mode_timestamp,omitempty"`
}
AllocatorHealthStatus The health status of the allocator. swagger:model AllocatorHealthStatus
func (*AllocatorHealthStatus) MarshalBinary ¶
func (m *AllocatorHealthStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllocatorHealthStatus) UnmarshalBinary ¶
func (m *AllocatorHealthStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AllocatorInfo ¶
type AllocatorInfo struct {
// Identifier for this allocator
// Required: true
AllocatorID *string `json:"allocator_id"`
// Build Info of the artifact
BuildInfo *AllocatorBuildInfo `json:"build_info,omitempty"`
// capacity
// Required: true
Capacity *AllocatorCapacity `json:"capacity"`
// List of features associated with this allocator. Note this is only present for backwards compatibility purposes and is scheduled for removal in the next major version release.
// Required: true
Features []string `json:"features"`
// Host IP of this allocator
// Required: true
HostIP *string `json:"host_ip"`
// instances
// Required: true
Instances []*AllocatedInstanceStatus `json:"instances"`
// Arbitrary metadata associated with this allocator
// Required: true
Metadata []*MetadataItem `json:"metadata"`
// Public hostname of this allocator
// Required: true
PublicHostname *string `json:"public_hostname"`
// The region that this allocator belongs to. Only populated in SaaS or federated ECE.
Region string `json:"region,omitempty"`
// settings
// Required: true
Settings *AllocatorSettings `json:"settings"`
// status
// Required: true
Status *AllocatorHealthStatus `json:"status"`
// Identifier of the zone
// Required: true
ZoneID *string `json:"zone_id"`
}
AllocatorInfo The overview information for the allocator. swagger:model AllocatorInfo
func (*AllocatorInfo) MarshalBinary ¶
func (m *AllocatorInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllocatorInfo) UnmarshalBinary ¶
func (m *AllocatorInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AllocatorMoveRequest ¶
type AllocatorMoveRequest struct {
// Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
AllocatorDown *bool `json:"allocator_down,omitempty"`
// The allocator id off which all instances in the cluster should be moved
// Required: true
From *string `json:"from"`
// An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
To []string `json:"to"`
}
AllocatorMoveRequest As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators. swagger:model AllocatorMoveRequest
func (*AllocatorMoveRequest) MarshalBinary ¶
func (m *AllocatorMoveRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllocatorMoveRequest) UnmarshalBinary ¶
func (m *AllocatorMoveRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AllocatorOverview ¶
type AllocatorOverview struct {
// zones
// Required: true
Zones []*AllocatorZoneInfo `json:"zones"`
}
AllocatorOverview The overview information for the installed allocators. swagger:model AllocatorOverview
func (*AllocatorOverview) MarshalBinary ¶
func (m *AllocatorOverview) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllocatorOverview) UnmarshalBinary ¶
func (m *AllocatorOverview) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AllocatorSettings ¶
type AllocatorSettings struct {
// A memory capacity (in MB) that overrides the capacity defined during installation
Capacity int32 `json:"capacity,omitempty"`
}
AllocatorSettings The settings for the allocator. swagger:model AllocatorSettings
func (*AllocatorSettings) MarshalBinary ¶
func (m *AllocatorSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllocatorSettings) UnmarshalBinary ¶
func (m *AllocatorSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AllocatorZoneInfo ¶
type AllocatorZoneInfo struct {
// allocators
// Required: true
Allocators []*AllocatorInfo `json:"allocators"`
// Identifier of the zone
// Required: true
ZoneID *string `json:"zone_id"`
}
AllocatorZoneInfo The allocators for the specified zone. swagger:model AllocatorZoneInfo
func (*AllocatorZoneInfo) MarshalBinary ¶
func (m *AllocatorZoneInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllocatorZoneInfo) UnmarshalBinary ¶
func (m *AllocatorZoneInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AllocatorsSummary ¶
type AllocatorsSummary struct {
// Whether all allocators are healthy
// Required: true
Healthy *bool `json:"healthy"`
// Summarized information on allocators in each zone
// Required: true
ZoneSummaries []*AllocatorsZoneSummary `json:"zone_summaries"`
}
AllocatorsSummary Summarized information about allocators. swagger:model AllocatorsSummary
func (*AllocatorsSummary) MarshalBinary ¶
func (m *AllocatorsSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllocatorsSummary) UnmarshalBinary ¶
func (m *AllocatorsSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AllocatorsZoneSummary ¶
type AllocatorsZoneSummary struct {
// Number of connected allocators
// Required: true
ConnectedAllocators *int32 `json:"connected_allocators"`
// Capacity of connected allocators in megabytes
// Required: true
ConnectedCapacity *int32 `json:"connected_capacity"`
// Number of disconnected allocators
// Required: true
DisconnectedAllocators *int32 `json:"disconnected_allocators"`
// Number of connected allocators in maintenance
// Required: true
InMaintenanceAllocators *int32 `json:"in_maintenance_allocators"`
// Number of instances across all allocators in the region
// Required: true
Instances *int32 `json:"instances"`
// Maximum capacity available in one allocator in megabytes
// Required: true
MaxAvailableCapacity *int32 `json:"max_available_capacity"`
// Total number of allocators
// Required: true
TotalAllocators *int32 `json:"total_allocators"`
// Identifier of the zone
// Required: true
ZoneID *string `json:"zone_id"`
}
AllocatorsZoneSummary Summary of the allocators for the specified zone. swagger:model AllocatorsZoneSummary
func (*AllocatorsZoneSummary) MarshalBinary ¶
func (m *AllocatorsZoneSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AllocatorsZoneSummary) UnmarshalBinary ¶
func (m *AllocatorsZoneSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Apm ¶
type Apm struct {
// The backend plan as JSON
// Required: true
BackendPlan interface{} `json:"backend_plan"`
// The human readable name (defaults to the generated cluster id if not specified)
// Required: true
DisplayName *string `json:"display_name"`
// The user-specified id of the Elasticsearch Cluster that this will link to
// Required: true
ElasticsearchClusterRefID *string `json:"elasticsearch_cluster_ref_id"`
// A locally-unique user-specified id
// Required: true
RefID *string `json:"ref_id"`
}
Apm Holds diagnostics for an APM resource swagger:model Apm
func (*Apm) MarshalBinary ¶
MarshalBinary interface implementation
func (*Apm) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ApmConfiguration ¶
type ApmConfiguration struct {
// A docker URI that allows overriding of the default docker image specified for this version
DockerImage string `json:"docker_image,omitempty"`
// system settings
SystemSettings *ApmSystemSettings `json:"system_settings,omitempty"`
// An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
UserSettingsJSON interface{} `json:"user_settings_json,omitempty"`
// An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
UserSettingsOverrideJSON interface{} `json:"user_settings_override_json,omitempty"`
// An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
UserSettingsOverrideYaml string `json:"user_settings_override_yaml,omitempty"`
// An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
UserSettingsYaml string `json:"user_settings_yaml,omitempty"`
// The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)
Version string `json:"version,omitempty"`
}
ApmConfiguration The configuration options for the APM Server. swagger:model ApmConfiguration
func (*ApmConfiguration) MarshalBinary ¶
func (m *ApmConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ApmConfiguration) UnmarshalBinary ¶
func (m *ApmConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ApmCrudResponse ¶
type ApmCrudResponse struct {
// For an operation creating or updating an APM server, the Id of that server
ApmID string `json:"apm_id,omitempty"`
// If the endpoint is called with URL param 'validate_only=true', then this contains advanced debug info (the internal plan representation)
Diagnostics interface{} `json:"diagnostics,omitempty"`
// The secret token for accessing the server
// Required: true
SecretToken *string `json:"secret_token"`
}
ApmCrudResponse The response to an APM CRUD (create/update-plan) request. swagger:model ApmCrudResponse
func (*ApmCrudResponse) MarshalBinary ¶
func (m *ApmCrudResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ApmCrudResponse) UnmarshalBinary ¶
func (m *ApmCrudResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ApmInfo ¶
type ApmInfo struct {
// The id of the deployment that this APM Server belongs to.
DeploymentID string `json:"deployment_id,omitempty"`
// elasticsearch cluster
// Required: true
ElasticsearchCluster *TargetElasticsearchCluster `json:"elasticsearch_cluster"`
// External resources related to the APM
// Required: true
// Unique: true
ExternalLinks []*ExternalHyperlink `json:"external_links"`
// Whether the APM is healthy or not (one or more of the info subsections will have healthy: false)
// Required: true
Healthy *bool `json:"healthy"`
// The id of the APM
// Required: true
ID *string `json:"id"`
// A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Links map[string]Hyperlink `json:"links,omitempty"`
// metadata
Metadata *ClusterMetadataInfo `json:"metadata,omitempty"`
// The name of the APM
// Required: true
Name *string `json:"name"`
// plan info
// Required: true
PlanInfo *ApmPlansInfo `json:"plan_info"`
// The region that this APM belongs to. Only populated in SaaS or federated ECE.
Region string `json:"region,omitempty"`
// The cluster metadata settings for the APM
Settings *ApmSettings `json:"settings,omitempty"`
// APM status
// Required: true
// Enum: [initializing stopping stopped rebooting restarting reconfiguring started]
Status *string `json:"status"`
// topology
// Required: true
Topology *ClusterTopologyInfo `json:"topology"`
}
ApmInfo The overview information for the APM Server. swagger:model ApmInfo
func (*ApmInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*ApmInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ApmPayload ¶
type ApmPayload struct {
// The human readable name for the APM cluster (default: takes the name of its Elasticsearch cluster)
DisplayName string `json:"display_name,omitempty"`
// Alias to the Elasticsearch Cluster to attach APM to
// Required: true
ElasticsearchClusterRefID *string `json:"elasticsearch_cluster_ref_id"`
// plan
// Required: true
Plan *ApmPlan `json:"plan"`
// A locally-unique user-specified id for APM
// Required: true
RefID *string `json:"ref_id"`
// The region where this resource exists
// Required: true
Region *string `json:"region"`
// The settings for building this APM cluster
Settings *ApmSettings `json:"settings,omitempty"`
}
ApmPayload An APM creation request paired with the alias of the Elasticsearch cluster it should be paired with swagger:model ApmPayload
func (*ApmPayload) MarshalBinary ¶
func (m *ApmPayload) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ApmPayload) UnmarshalBinary ¶
func (m *ApmPayload) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ApmPlan ¶
type ApmPlan struct {
// apm
// Required: true
Apm *ApmConfiguration `json:"apm"`
// cluster topology
ClusterTopology []*ApmTopologyElement `json:"cluster_topology"`
// transient
Transient *TransientApmPlanConfiguration `json:"transient,omitempty"`
}
ApmPlan The plan for the APM Server. swagger:model ApmPlan
func (*ApmPlan) MarshalBinary ¶
MarshalBinary interface implementation
func (*ApmPlan) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ApmPlanControlConfiguration ¶
type ApmPlanControlConfiguration struct {
// This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
CalmWaitTime int64 `json:"calm_wait_time,omitempty"`
// Set to 'forced' to force a reboot as part of the upgrade plan
// Enum: [forced]
ClusterReboot string `json:"cluster_reboot,omitempty"`
// If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
ExtendedMaintenance *bool `json:"extended_maintenance,omitempty"`
// move allocators
MoveAllocators []*AllocatorMoveRequest `json:"move_allocators"`
// move instances
MoveInstances []*InstanceMoveRequest `json:"move_instances"`
// List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
PreferredAllocators []string `json:"preferred_allocators"`
// If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
ReallocateInstances *bool `json:"reallocate_instances,omitempty"`
// The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
Timeout int64 `json:"timeout,omitempty"`
}
ApmPlanControlConfiguration The plan control configuration options for the APM Server. swagger:model ApmPlanControlConfiguration
func (*ApmPlanControlConfiguration) MarshalBinary ¶
func (m *ApmPlanControlConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ApmPlanControlConfiguration) UnmarshalBinary ¶
func (m *ApmPlanControlConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ApmPlanInfo ¶
type ApmPlanInfo struct {
// If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
// Format: date-time
AttemptEndTime strfmt.DateTime `json:"attempt_end_time,omitempty"`
// When this plan attempt (ie to apply the plan to the APM) started (ISO format in UTC)
// Format: date-time
AttemptStartTime strfmt.DateTime `json:"attempt_start_time,omitempty"`
// Either the plan ended successfully, or is not yet completed (and no errors have occurred)
// Required: true
Healthy *bool `json:"healthy"`
// plan
Plan *ApmPlan `json:"plan,omitempty"`
// A UUID for each plan attempt
PlanAttemptID string `json:"plan_attempt_id,omitempty"`
// plan attempt log
// Required: true
PlanAttemptLog []*ClusterPlanStepInfo `json:"plan_attempt_log"`
// A human readable name for each plan attempt, only populated when retrieving plan histories
PlanAttemptName string `json:"plan_attempt_name,omitempty"`
// If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
// Format: date-time
PlanEndTime strfmt.DateTime `json:"plan_end_time,omitempty"`
// Information describing the source that facilitated the plans current state
Source *ChangeSourceInfo `json:"source,omitempty"`
}
ApmPlanInfo Information about the APM Server plan. swagger:model ApmPlanInfo
func (*ApmPlanInfo) MarshalBinary ¶
func (m *ApmPlanInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ApmPlanInfo) UnmarshalBinary ¶
func (m *ApmPlanInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ApmPlansInfo ¶
type ApmPlansInfo struct {
// current
Current *ApmPlanInfo `json:"current,omitempty"`
// Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
// Required: true
Healthy *bool `json:"healthy"`
// history
// Required: true
History []*ApmPlanInfo `json:"history"`
// pending
Pending *ApmPlanInfo `json:"pending,omitempty"`
}
ApmPlansInfo Information about current, pending, and past APM Server plans. swagger:model ApmPlansInfo
func (*ApmPlansInfo) MarshalBinary ¶
func (m *ApmPlansInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ApmPlansInfo) UnmarshalBinary ¶
func (m *ApmPlansInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ApmResourceInfo ¶
type ApmResourceInfo struct {
// The Elasticsearch cluster that this resource depends on.
// Required: true
ElasticsearchClusterRefID *string `json:"elasticsearch_cluster_ref_id"`
// The randomly-generated id of a Resource
// Required: true
ID *string `json:"id"`
// Info for the resource.
// Required: true
Info *ApmInfo `json:"info"`
// The locally-unique user-specified id of a Resource
// Required: true
RefID *string `json:"ref_id"`
// The region where this resource exists
// Required: true
Region *string `json:"region"`
}
ApmResourceInfo Describes an APM resource belonging to a Deployment swagger:model ApmResourceInfo
func (*ApmResourceInfo) MarshalBinary ¶
func (m *ApmResourceInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ApmResourceInfo) UnmarshalBinary ¶
func (m *ApmResourceInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ApmSettings ¶
type ApmSettings struct {
// metadata
Metadata *ClusterMetadataSettings `json:"metadata,omitempty"`
}
ApmSettings The settings for the APM Server. swagger:model ApmSettings
func (*ApmSettings) MarshalBinary ¶
func (m *ApmSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ApmSettings) UnmarshalBinary ¶
func (m *ApmSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ApmSubInfo ¶
type ApmSubInfo struct {
// The APM cluster Id
// Required: true
ApmID *string `json:"apm_id"`
// Whether the associated APM cluster is currently available
// Required: true
Enabled *bool `json:"enabled"`
// A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Links map[string]Hyperlink `json:"links,omitempty"`
}
ApmSubInfo Information about the APM Servers associated with the Elasticsearch cluster. swagger:model ApmSubInfo
func (*ApmSubInfo) MarshalBinary ¶
func (m *ApmSubInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ApmSubInfo) UnmarshalBinary ¶
func (m *ApmSubInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ApmSystemSettings ¶
type ApmSystemSettings struct {
// Optionally enable debug mode for APM servers - defaults false
DebugEnabled *bool `json:"debug_enabled,omitempty"`
// Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified)
ElasticsearchPassword string `json:"elasticsearch_password,omitempty"`
// Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
ElasticsearchURL string `json:"elasticsearch_url,omitempty"`
// Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified)
ElasticsearchUsername string `json:"elasticsearch_username,omitempty"`
// Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
KibanaURL string `json:"kibana_url,omitempty"`
// Optionally override the secret token within APM - defaults to the previously existing secretToken
SecretToken string `json:"secret_token,omitempty"`
}
ApmSystemSettings A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use `ApmSystemSettings` with `user_settings_override_` and `user_settings_`. swagger:model ApmSystemSettings
func (*ApmSystemSettings) MarshalBinary ¶
func (m *ApmSystemSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ApmSystemSettings) UnmarshalBinary ¶
func (m *ApmSystemSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ApmTopologyElement ¶
type ApmTopologyElement struct {
// apm
Apm *ApmConfiguration `json:"apm,omitempty"`
// Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
InstanceConfigurationID string `json:"instance_configuration_id,omitempty"`
// size
Size *TopologySize `json:"size,omitempty"`
// number of zones in which nodes will be placed
ZoneCount int32 `json:"zone_count,omitempty"`
}
ApmTopologyElement Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes. swagger:model ApmTopologyElement
func (*ApmTopologyElement) MarshalBinary ¶
func (m *ApmTopologyElement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ApmTopologyElement) UnmarshalBinary ¶
func (m *ApmTopologyElement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ApmsInfo ¶
type ApmsInfo struct {
// apms
// Required: true
Apms []*ApmInfo `json:"apms"`
// If a query is supplied, then the total number of clusters that matched
MatchCount int32 `json:"match_count,omitempty"`
// The number of clusters actually returned
// Required: true
ReturnCount *int32 `json:"return_count"`
}
ApmsInfo A container for information about a set of APM Servers. swagger:model ApmsInfo
func (*ApmsInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*ApmsInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AppSearch ¶
type AppSearch struct {
// The backend plan as JSON
// Required: true
BackendPlan interface{} `json:"backend_plan"`
// The human readable name (defaults to the generated cluster id if not specified)
// Required: true
DisplayName *string `json:"display_name"`
// The user-specified id of the Elasticsearch Cluster that this will link to
// Required: true
ElasticsearchClusterRefID *string `json:"elasticsearch_cluster_ref_id"`
// A locally-unique user-specified id
// Required: true
RefID *string `json:"ref_id"`
}
AppSearch Holds diagnostics for an AppSearch resource swagger:model AppSearch
func (*AppSearch) MarshalBinary ¶
MarshalBinary interface implementation
func (*AppSearch) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AppSearchConfiguration ¶
type AppSearchConfiguration struct {
// A docker URI that allows overriding of the default docker image specified for this version
DockerImage string `json:"docker_image,omitempty"`
// system settings
SystemSettings *AppSearchSystemSettings `json:"system_settings,omitempty"`
// An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
UserSettingsJSON interface{} `json:"user_settings_json,omitempty"`
// An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
UserSettingsOverrideJSON interface{} `json:"user_settings_override_json,omitempty"`
// An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
UserSettingsOverrideYaml string `json:"user_settings_override_yaml,omitempty"`
// An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
UserSettingsYaml string `json:"user_settings_yaml,omitempty"`
// The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
Version string `json:"version,omitempty"`
}
AppSearchConfiguration app search configuration swagger:model AppSearchConfiguration
func (*AppSearchConfiguration) MarshalBinary ¶
func (m *AppSearchConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppSearchConfiguration) UnmarshalBinary ¶
func (m *AppSearchConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AppSearchInfo ¶
type AppSearchInfo struct {
// The id of the deployment that this App Search belongs to.
DeploymentID string `json:"deployment_id,omitempty"`
// elasticsearch cluster
// Required: true
ElasticsearchCluster *TargetElasticsearchCluster `json:"elasticsearch_cluster"`
// External resources related to the App Search
// Required: true
// Unique: true
ExternalLinks []*ExternalHyperlink `json:"external_links"`
// Whether the App Search is healthy or not (one or more of the info subsections will have healthy: false)
// Required: true
Healthy *bool `json:"healthy"`
// The id of the App Search
// Required: true
ID *string `json:"id"`
// A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Links map[string]Hyperlink `json:"links,omitempty"`
// metadata
Metadata *ClusterMetadataInfo `json:"metadata,omitempty"`
// The name of the App Search
// Required: true
Name *string `json:"name"`
// plan info
// Required: true
PlanInfo *AppSearchPlansInfo `json:"plan_info"`
// The region that this App Search belongs to. Only populated in SaaS or federated ECE.
Region string `json:"region,omitempty"`
// The cluster metadata settings for the App Search
Settings *AppSearchSettings `json:"settings,omitempty"`
// App Search status
// Required: true
// Enum: [initializing stopping stopped rebooting restarting reconfiguring started]
Status *string `json:"status"`
// topology
// Required: true
Topology *ClusterTopologyInfo `json:"topology"`
}
AppSearchInfo The overview information for the App Search Server. swagger:model AppSearchInfo
func (*AppSearchInfo) MarshalBinary ¶
func (m *AppSearchInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppSearchInfo) UnmarshalBinary ¶
func (m *AppSearchInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AppSearchNodeTypes ¶
type AppSearchNodeTypes struct {
// Defines whether this instance should run as Application/API server
// Required: true
Appserver *bool `json:"appserver"`
// Defines whether this instance should run as background worker
// Required: true
Worker *bool `json:"worker"`
}
AppSearchNodeTypes Node types to enable for an AppSearch instance swagger:model AppSearchNodeTypes
func (*AppSearchNodeTypes) MarshalBinary ¶
func (m *AppSearchNodeTypes) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppSearchNodeTypes) UnmarshalBinary ¶
func (m *AppSearchNodeTypes) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AppSearchPayload ¶
type AppSearchPayload struct {
// The human readable name for the AppSearch cluster (default: takes the name of its Elasticsearch cluster)
DisplayName string `json:"display_name,omitempty"`
// Alias to the Elasticsearch Cluster to attach AppSearch to
// Required: true
ElasticsearchClusterRefID *string `json:"elasticsearch_cluster_ref_id"`
// plan
// Required: true
Plan *AppSearchPlan `json:"plan"`
// A locally-unique user-specified id for AppSearch
// Required: true
RefID *string `json:"ref_id"`
// The region where this resource exists
// Required: true
Region *string `json:"region"`
// The settings for building this AppSearch cluster
Settings *AppSearchSettings `json:"settings,omitempty"`
}
AppSearchPayload An AppSearch creation request paired with the alias of the Elasticsearch cluster it should be paired with swagger:model AppSearchPayload
func (*AppSearchPayload) MarshalBinary ¶
func (m *AppSearchPayload) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppSearchPayload) UnmarshalBinary ¶
func (m *AppSearchPayload) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AppSearchPlan ¶
type AppSearchPlan struct {
// appsearch
// Required: true
Appsearch *AppSearchConfiguration `json:"appsearch"`
// cluster topology
ClusterTopology []*AppSearchTopologyElement `json:"cluster_topology"`
// transient
Transient *TransientAppSearchPlanConfiguration `json:"transient,omitempty"`
}
AppSearchPlan app search plan swagger:model AppSearchPlan
func (*AppSearchPlan) MarshalBinary ¶
func (m *AppSearchPlan) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppSearchPlan) UnmarshalBinary ¶
func (m *AppSearchPlan) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AppSearchPlanControlConfiguration ¶
type AppSearchPlanControlConfiguration struct {
// This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
CalmWaitTime int64 `json:"calm_wait_time,omitempty"`
// Set to 'forced' to force a reboot as part of the upgrade plan
// Enum: [forced]
ClusterReboot string `json:"cluster_reboot,omitempty"`
// If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
ExtendedMaintenance *bool `json:"extended_maintenance,omitempty"`
// move allocators
MoveAllocators []*AllocatorMoveRequest `json:"move_allocators"`
// move instances
MoveInstances []*InstanceMoveRequest `json:"move_instances"`
// List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
PreferredAllocators []string `json:"preferred_allocators"`
// If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
ReallocateInstances *bool `json:"reallocate_instances,omitempty"`
// The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
Timeout int64 `json:"timeout,omitempty"`
}
AppSearchPlanControlConfiguration app search plan control configuration swagger:model AppSearchPlanControlConfiguration
func (*AppSearchPlanControlConfiguration) MarshalBinary ¶
func (m *AppSearchPlanControlConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppSearchPlanControlConfiguration) UnmarshalBinary ¶
func (m *AppSearchPlanControlConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AppSearchPlanInfo ¶
type AppSearchPlanInfo struct {
// If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
// Format: date-time
AttemptEndTime strfmt.DateTime `json:"attempt_end_time,omitempty"`
// When this plan attempt (ie to apply the plan to the App Search) started (ISO format in UTC)
// Format: date-time
AttemptStartTime strfmt.DateTime `json:"attempt_start_time,omitempty"`
// Either the plan ended successfully, or is not yet completed (and no errors have occurred)
// Required: true
Healthy *bool `json:"healthy"`
// plan
Plan *AppSearchPlan `json:"plan,omitempty"`
// A UUID for each plan attempt
PlanAttemptID string `json:"plan_attempt_id,omitempty"`
// plan attempt log
// Required: true
PlanAttemptLog []*ClusterPlanStepInfo `json:"plan_attempt_log"`
// A human readable name for each plan attempt, only populated when retrieving plan histories
PlanAttemptName string `json:"plan_attempt_name,omitempty"`
// If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
// Format: date-time
PlanEndTime strfmt.DateTime `json:"plan_end_time,omitempty"`
// Information describing the source that facilitated the plans current state
Source *ChangeSourceInfo `json:"source,omitempty"`
}
AppSearchPlanInfo Information about the App Search Server plan. swagger:model AppSearchPlanInfo
func (*AppSearchPlanInfo) MarshalBinary ¶
func (m *AppSearchPlanInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppSearchPlanInfo) UnmarshalBinary ¶
func (m *AppSearchPlanInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AppSearchPlansInfo ¶
type AppSearchPlansInfo struct {
// current
Current *AppSearchPlanInfo `json:"current,omitempty"`
// Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
// Required: true
Healthy *bool `json:"healthy"`
// history
// Required: true
History []*AppSearchPlanInfo `json:"history"`
// pending
Pending *AppSearchPlanInfo `json:"pending,omitempty"`
}
AppSearchPlansInfo Information about current, pending, and past App Search Server plans. swagger:model AppSearchPlansInfo
func (*AppSearchPlansInfo) MarshalBinary ¶
func (m *AppSearchPlansInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppSearchPlansInfo) UnmarshalBinary ¶
func (m *AppSearchPlansInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AppSearchResourceInfo ¶
type AppSearchResourceInfo struct {
// The Elasticsearch cluster that this resource depends on.
// Required: true
ElasticsearchClusterRefID *string `json:"elasticsearch_cluster_ref_id"`
// The randomly-generated id of a Resource
// Required: true
ID *string `json:"id"`
// Info for the resource.
// Required: true
Info *AppSearchInfo `json:"info"`
// The locally-unique user-specified id of a Resource
// Required: true
RefID *string `json:"ref_id"`
// The region where this resource exists
// Required: true
Region *string `json:"region"`
}
AppSearchResourceInfo Describes an App Search resource belonging to a Deployment swagger:model AppSearchResourceInfo
func (*AppSearchResourceInfo) MarshalBinary ¶
func (m *AppSearchResourceInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppSearchResourceInfo) UnmarshalBinary ¶
func (m *AppSearchResourceInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AppSearchSettings ¶
type AppSearchSettings struct {
// metadata
Metadata *ClusterMetadataSettings `json:"metadata,omitempty"`
}
AppSearchSettings The settings for the App Search. swagger:model AppSearchSettings
func (*AppSearchSettings) MarshalBinary ¶
func (m *AppSearchSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppSearchSettings) UnmarshalBinary ¶
func (m *AppSearchSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AppSearchSubInfo ¶
type AppSearchSubInfo struct {
// The App Search Id
// Required: true
AppSearchID *string `json:"app_search_id"`
// Whether the associated App Search is currently available
// Required: true
Enabled *bool `json:"enabled"`
// A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Links map[string]Hyperlink `json:"links,omitempty"`
}
AppSearchSubInfo Information about the APM Servers associated with the Elasticsearch cluster. swagger:model AppSearchSubInfo
func (*AppSearchSubInfo) MarshalBinary ¶
func (m *AppSearchSubInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppSearchSubInfo) UnmarshalBinary ¶
func (m *AppSearchSubInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AppSearchSystemSettings ¶
type AppSearchSystemSettings struct {
// Optionally override the account within AppSearch - defaults to a system account that always exists (if specified, the username must also be specified)
ElasticsearchPassword string `json:"elasticsearch_password,omitempty"`
// Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
ElasticsearchURL string `json:"elasticsearch_url,omitempty"`
// Optionally override the account within AppSearch - defaults to a system account that always exists (if specified, the password must also be specified)
ElasticsearchUsername string `json:"elasticsearch_username,omitempty"`
// Optionally override the secret session key within AppSearch - defaults to the previously existing secretSession
SecretSessionKey string `json:"secret_session_key,omitempty"`
}
AppSearchSystemSettings This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings) swagger:model AppSearchSystemSettings
func (*AppSearchSystemSettings) MarshalBinary ¶
func (m *AppSearchSystemSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppSearchSystemSettings) UnmarshalBinary ¶
func (m *AppSearchSystemSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AppSearchTopologyElement ¶
type AppSearchTopologyElement struct {
// appsearch
Appsearch *AppSearchConfiguration `json:"appsearch,omitempty"`
// Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
InstanceConfigurationID string `json:"instance_configuration_id,omitempty"`
// Defines the AppSearch node type
NodeType *AppSearchNodeTypes `json:"node_type,omitempty"`
// size
Size *TopologySize `json:"size,omitempty"`
// number of zones in which nodes will be placed
ZoneCount int32 `json:"zone_count,omitempty"`
}
AppSearchTopologyElement Defines the topology of the AppSearch nodes (eg number/capacity of nodes, and where they can be allocated) swagger:model AppSearchTopologyElement
func (*AppSearchTopologyElement) MarshalBinary ¶
func (m *AppSearchTopologyElement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AppSearchTopologyElement) UnmarshalBinary ¶
func (m *AppSearchTopologyElement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuthenticationInfo ¶
type AuthenticationInfo struct {
// The UTC time when elevated permissions will expire, if the user has elevated permissions
// Format: date-time
ElevatedPermissionsExpireAt strfmt.DateTime `json:"elevated_permissions_expire_at,omitempty"`
// True if the user has elevated permissions
// Required: true
HasElevatedPermissions *bool `json:"has_elevated_permissions"`
// True if the user has an available TOTP device
// Required: true
HasTotpDevice *bool `json:"has_totp_device"`
// The API to be used when refreshing the current user's JWT
// Required: true
RefreshTokenURL *string `json:"refresh_token_url"`
// The TOTP device source
// Required: true
// Enum: [native okta]
TotpDeviceSource *string `json:"totp_device_source"`
// URL for configuring an MFA TOTP device. Does not apply when totp_device_source is 'native'.
TotpDeviceSourceEnableMfaHref string `json:"totp_device_source_enable_mfa_href,omitempty"`
}
AuthenticationInfo A user's authentication info swagger:model AuthenticationInfo
func (*AuthenticationInfo) MarshalBinary ¶
func (m *AuthenticationInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthenticationInfo) UnmarshalBinary ¶
func (m *AuthenticationInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AutodetectStrategyConfig ¶
type AutodetectStrategyConfig interface{}
AutodetectStrategyConfig A strategy that lets constructor choose the most optimal way to execute the plan. swagger:model AutodetectStrategyConfig
type AvailableAuthenticationMethods ¶
type AvailableAuthenticationMethods struct {
// Indicates that OpenID single sign-on authentication is available.
// Required: true
Openid *bool `json:"openid"`
// Indicates that username and password authentication is available.
// Required: true
Password *bool `json:"password"`
// Indicates that SAML single sign-on authentication is available.
// Required: true
Saml *bool `json:"saml"`
// Lists details for the available single sign-on methods.
// Required: true
SsoMethods []*SsoAuthenticationMethodInfo `json:"sso_methods"`
}
AvailableAuthenticationMethods Specifies the authentication methods that are enabled on the Elasticsearch cluster. NOTE: When all fields are `false`, only the Platform admin and Platform viewer are available. swagger:model AvailableAuthenticationMethods
func (*AvailableAuthenticationMethods) MarshalBinary ¶
func (m *AvailableAuthenticationMethods) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AvailableAuthenticationMethods) UnmarshalBinary ¶
func (m *AvailableAuthenticationMethods) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BasicFailedReply ¶
type BasicFailedReply struct {
// A list of errors that occurred in the failing request
// Required: true
Errors []*BasicFailedReplyElement `json:"errors"`
}
BasicFailedReply basic failed reply swagger:model BasicFailedReply
func (*BasicFailedReply) MarshalBinary ¶
func (m *BasicFailedReply) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BasicFailedReply) UnmarshalBinary ¶
func (m *BasicFailedReply) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BasicFailedReplyElement ¶
type BasicFailedReplyElement struct {
// A structured code representing the error type that occurred
// Required: true
Code *string `json:"code"`
// If the error can be tied to a specific field or fields in the user request, this lists those fields
Fields []string `json:"fields"`
// A human readable message describing the error that occurred
// Required: true
Message *string `json:"message"`
}
BasicFailedReplyElement basic failed reply element swagger:model BasicFailedReplyElement
func (*BasicFailedReplyElement) MarshalBinary ¶
func (m *BasicFailedReplyElement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BasicFailedReplyElement) UnmarshalBinary ¶
func (m *BasicFailedReplyElement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Blessing ¶
type Blessing struct {
// Whether something is blessed or not
// Required: true
Value *bool `json:"value"`
}
Blessing Whether something is blessed or not swagger:model Blessing
func (*Blessing) MarshalBinary ¶
MarshalBinary interface implementation
func (*Blessing) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Blessings ¶
type Blessings struct {
// A mapping of Runner Ids to whether or not they are blessed to run the associated role
// Required: true
RunnerIdsToBlessing map[string]Blessing `json:"runner_ids_to_blessing"`
}
Blessings Describes whether certain runners are blessed to run a Role. swagger:model Blessings
func (*Blessings) MarshalBinary ¶
MarshalBinary interface implementation
func (*Blessings) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type BlessingsWithMeta ¶
type BlessingsWithMeta struct {
// The metadata
// Required: true
Meta *Metadata `json:"meta"`
// The blessings
// Required: true
Value *Blessings `json:"value"`
}
BlessingsWithMeta Persisted Blessings along with metadata swagger:model BlessingsWithMeta
func (*BlessingsWithMeta) MarshalBinary ¶
func (m *BlessingsWithMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BlessingsWithMeta) UnmarshalBinary ¶
func (m *BlessingsWithMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BoolQuery ¶
type BoolQuery struct {
// filter
Filter []*QueryContainer `json:"filter,omitempty"`
// The minimum number of optional should clauses to match.
MinimumShouldMatch int32 `json:"minimum_should_match,omitempty"`
// must
Must []*QueryContainer `json:"must,omitempty"`
// must not
MustNot []*QueryContainer `json:"must_not,omitempty"`
// should
Should []*QueryContainer `json:"should,omitempty"`
}
BoolQuery A query for documents that match boolean combinations of other queries. swagger:model BoolQuery
func (*BoolQuery) MarshalBinary ¶
MarshalBinary interface implementation
func (*BoolQuery) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type CapacityConstraintsResource ¶
type CapacityConstraintsResource struct {
// Max capacity
// Required: true
Max *int64 `json:"max"`
// Min capacity
// Required: true
Min *int64 `json:"min"`
}
CapacityConstraintsResource Specifies the maximum and minimum capacity constraints. swagger:model CapacityConstraintsResource
func (*CapacityConstraintsResource) MarshalBinary ¶
func (m *CapacityConstraintsResource) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CapacityConstraintsResource) UnmarshalBinary ¶
func (m *CapacityConstraintsResource) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ChangeSourceInfo ¶
type ChangeSourceInfo struct {
// The type of plan change that was initiated
// Required: true
Action *string `json:"action"`
// The admin user that requested the change
AdminID string `json:"admin_id,omitempty"`
// The time the change was initiated
// Required: true
// Format: date-time
Date *strfmt.DateTime `json:"date"`
// The service where the change originated from
// Required: true
Facilitator *string `json:"facilitator"`
// The host addresses of the user that originated the change
RemoteAddresses []string `json:"remote_addresses"`
// The user that requested the change
UserID string `json:"user_id,omitempty"`
}
ChangeSourceInfo A container for information about the source of a change. swagger:model ChangeSourceInfo
func (*ChangeSourceInfo) MarshalBinary ¶
func (m *ChangeSourceInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ChangeSourceInfo) UnmarshalBinary ¶
func (m *ChangeSourceInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterCommandResponse ¶
type ClusterCommandResponse struct {
// If validating the command only, then the calculated Apm plan that would be applied.
CalculatedApmPlan *TransientApmPlanConfiguration `json:"calculated_apm_plan,omitempty"`
// If validating the command only, then the calculated App search plan that would be applied.
CalculatedAppSearchPlan *TransientAppSearchPlanConfiguration `json:"calculated_app_search_plan,omitempty"`
// If validating the command only, then the calculated Elasticsearch plan that would be applied.
CalculatedElasticsearchPlan *TransientElasticsearchPlanConfiguration `json:"calculated_elasticsearch_plan,omitempty"`
// If validating the command only, then the calculated Elastic Enterprise Search plan that would be applied.
CalculatedEnterpriseSearchPlan *TransientEnterpriseSearchPlanConfiguration `json:"calculated_enterprise_search_plan,omitempty"`
// If validating the command only, then the calculated Kibana plan that would be applied.
CalculatedKibanaPlan *TransientKibanaPlanConfiguration `json:"calculated_kibana_plan,omitempty"`
}
ClusterCommandResponse The response to an Elasticsearch cluster or Kibana instance command. swagger:model ClusterCommandResponse
func (*ClusterCommandResponse) MarshalBinary ¶
func (m *ClusterCommandResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterCommandResponse) UnmarshalBinary ¶
func (m *ClusterCommandResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterCredentials ¶
type ClusterCredentials struct {
// The password of the newly created cluster
// Required: true
Password *string `json:"password"`
// The username of the newly created cluster
// Required: true
Username *string `json:"username"`
}
ClusterCredentials The username and password for the new Elasticsearch cluster, which is returned from the Elasticsearch cluster `create` command. swagger:model ClusterCredentials
func (*ClusterCredentials) MarshalBinary ¶
func (m *ClusterCredentials) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterCredentials) UnmarshalBinary ¶
func (m *ClusterCredentials) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterCrudResponse ¶
type ClusterCrudResponse struct {
// If the endpoint is called with URL param 'validate_only=true', then this contains advanced debug info (the internal plan representation) for the APM that was created along with the submitted ES plan.
Apm *ApmCrudResponse `json:"apm,omitempty"`
// For an operation creating or updating an APM, the Id of that cluster
ApmID string `json:"apm_id,omitempty"`
// An encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana
CloudID string `json:"cloud_id,omitempty"`
// credentials
Credentials *ClusterCredentials `json:"credentials,omitempty"`
// If the endpoint is called with URL param 'validate_only=true', then this contains advanced debug info (the internal plan representation)
Diagnostics interface{} `json:"diagnostics,omitempty"`
// For an operation creating or updating an Elasticsearch cluster, the Id of that cluster
ElasticsearchClusterID string `json:"elasticsearch_cluster_id,omitempty"`
// If the endpoint is called with URL param 'validate_only=true', then this contains advanced debug info (the internal plan representation) for the Kibana that was created along with the submitted ES plan.
Kibana *ClusterCrudResponse `json:"kibana,omitempty"`
// For an operation creating or updating a Kibana cluster, the Id of that cluster
KibanaClusterID string `json:"kibana_cluster_id,omitempty"`
}
ClusterCrudResponse The response to an Elasticsearch cluster or Kibana instance CRUD (create/update-plan) request. swagger:model ClusterCrudResponse
func (*ClusterCrudResponse) MarshalBinary ¶
func (m *ClusterCrudResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterCrudResponse) UnmarshalBinary ¶
func (m *ClusterCrudResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterCurationSettings ¶
type ClusterCurationSettings struct {
// Specifications for curation
// Required: true
Specs []*ClusterCurationSpec `json:"specs"`
}
ClusterCurationSettings The index curation settings for an Elasticsearch cluster. swagger:model ClusterCurationSettings
func (*ClusterCurationSettings) MarshalBinary ¶
func (m *ClusterCurationSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterCurationSettings) UnmarshalBinary ¶
func (m *ClusterCurationSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterCurationSpec ¶
type ClusterCurationSpec struct {
// Index matching pattern
// Required: true
IndexPattern *string `json:"index_pattern"`
// Number of seconds after index creation to trigger this spec
// Required: true
TriggerIntervalSeconds *int32 `json:"trigger_interval_seconds"`
}
ClusterCurationSpec Specifies the conditions to trigger an Elasticsearch cluster curation. swagger:model ClusterCurationSpec
func (*ClusterCurationSpec) MarshalBinary ¶
func (m *ClusterCurationSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterCurationSpec) UnmarshalBinary ¶
func (m *ClusterCurationSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterInfo ¶
type ClusterInfo struct {
// The top level info object for APM
Apm *ApmInfo `json:"apm,omitempty"`
// The top level info object for App Search
AppSearch *AppSearchInfo `json:"app_search,omitempty"`
// The top-level object information for an Elasticsearch cluster.
Elasticsearch *ElasticsearchClusterInfo `json:"elasticsearch,omitempty"`
// The top level info object for Enterprise Search
EnterpriseSearch *EnterpriseSearchInfo `json:"enterprise_search,omitempty"`
// The top level info object for a Kibana cluster
Kibana *KibanaClusterInfo `json:"kibana,omitempty"`
}
ClusterInfo A container for information about an Elasticsearch cluster, Kibana instance, or APM Server. swagger:model ClusterInfo
func (*ClusterInfo) MarshalBinary ¶
func (m *ClusterInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterInfo) UnmarshalBinary ¶
func (m *ClusterInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterInstanceConfigurationInfo ¶
type ClusterInstanceConfigurationInfo struct {
// The id of the configuration used to create the instance
// Required: true
ID *string `json:"id"`
// The name of the configuration used to create the instance
// Required: true
Name *string `json:"name"`
// The resource type of the instance configuration
// Required: true
// Enum: [memory storage]
Resource *string `json:"resource"`
}
ClusterInstanceConfigurationInfo Information about a configuration that creates a Kibana instance or APM Server. swagger:model ClusterInstanceConfigurationInfo
func (*ClusterInstanceConfigurationInfo) MarshalBinary ¶
func (m *ClusterInstanceConfigurationInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterInstanceConfigurationInfo) UnmarshalBinary ¶
func (m *ClusterInstanceConfigurationInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterInstanceDiskInfo ¶
type ClusterInstanceDiskInfo struct {
// If known, the amount of total disk space available to the container in MB
DiskSpaceAvailable int64 `json:"disk_space_available,omitempty"`
// The amount of disk space being used by the service in MB
// Required: true
DiskSpaceUsed *int64 `json:"disk_space_used"`
// The storage multiplier originally defined to calculate disk space.
// Required: true
StorageMultiplier *float64 `json:"storage_multiplier"`
}
ClusterInstanceDiskInfo Information about the use and storage capacity of a Kibana instance or APM Server. swagger:model ClusterInstanceDiskInfo
func (*ClusterInstanceDiskInfo) MarshalBinary ¶
func (m *ClusterInstanceDiskInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterInstanceDiskInfo) UnmarshalBinary ¶
func (m *ClusterInstanceDiskInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterInstanceInfo ¶
type ClusterInstanceInfo struct {
// The id of the allocator on which this instance is running (if the container is started or starting)
AllocatorID string `json:"allocator_id,omitempty"`
// Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container)
// Required: true
ContainerStarted *bool `json:"container_started"`
// disk
Disk *ClusterInstanceDiskInfo `json:"disk,omitempty"`
// Whether the instance is healthy (ie started and running)
// Required: true
Healthy *bool `json:"healthy"`
// instance configuration
InstanceConfiguration *ClusterInstanceConfigurationInfo `json:"instance_configuration,omitempty"`
// Whether the instance is healthy (ie started and running)
// Required: true
InstanceName *string `json:"instance_name"`
// Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it)
// Required: true
MaintenanceMode *bool `json:"maintenance_mode"`
// memory
Memory *ClusterInstanceMemoryInfo `json:"memory,omitempty"`
// The service-specific (eg Elasticsearch) id of the node, if available
ServiceID string `json:"service_id,omitempty"`
// List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest,ml
ServiceRoles []string `json:"service_roles"`
// Whether the service launched inside the container -ie Elasticsearch- is actually running
// Required: true
ServiceRunning *bool `json:"service_running"`
// The version of the service that the instance is running (eg Elasticsearch or Kibana), if available
ServiceVersion string `json:"service_version,omitempty"`
// The zone in which this instance is being allocated
Zone string `json:"zone,omitempty"`
}
ClusterInstanceInfo Information about each Kibana instance and APM Server in the Elasticsearch cluster. swagger:model ClusterInstanceInfo
func (*ClusterInstanceInfo) MarshalBinary ¶
func (m *ClusterInstanceInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterInstanceInfo) UnmarshalBinary ¶
func (m *ClusterInstanceInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterInstanceMemoryInfo ¶
type ClusterInstanceMemoryInfo struct {
// The memory capacity in MB of the instance
// Required: true
InstanceCapacity *int32 `json:"instance_capacity"`
// The planned memory capacity in MB of the instance (only shown when an override is present)
InstanceCapacityPlanned int32 `json:"instance_capacity_planned,omitempty"`
// The % memory pressure of the service if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)
MemoryPressure int32 `json:"memory_pressure,omitempty"`
// The % native memory pressure of the service if available
NativeMemoryPressure int32 `json:"native_memory_pressure,omitempty"`
}
ClusterInstanceMemoryInfo Information about the memory capacity and use of the Kibana instance or APM Server. swagger:model ClusterInstanceMemoryInfo
func (*ClusterInstanceMemoryInfo) MarshalBinary ¶
func (m *ClusterInstanceMemoryInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterInstanceMemoryInfo) UnmarshalBinary ¶
func (m *ClusterInstanceMemoryInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterLicenseInfo ¶
type ClusterLicenseInfo struct {
// Object containing the cluster license data
// Required: true
License interface{} `json:"license"`
}
ClusterLicenseInfo Information about the Elasticsearch cluster license. swagger:model ClusterLicenseInfo
func (*ClusterLicenseInfo) MarshalBinary ¶
func (m *ClusterLicenseInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterLicenseInfo) UnmarshalBinary ¶
func (m *ClusterLicenseInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterMetadataCPUResourcesSettings ¶
type ClusterMetadataCPUResourcesSettings struct {
// Indicates if the the CPU boost flag for a cluster is enabled or not
Boost *bool `json:"boost,omitempty"`
// Indicates if the the CPU hard limit flag for a cluster is enabled or not
HardLimit *bool `json:"hard_limit,omitempty"`
}
ClusterMetadataCPUResourcesSettings Specifies the CPU resource settings for the Elasticsearch cluster. swagger:model ClusterMetadataCpuResourcesSettings
func (*ClusterMetadataCPUResourcesSettings) MarshalBinary ¶
func (m *ClusterMetadataCPUResourcesSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterMetadataCPUResourcesSettings) UnmarshalBinary ¶
func (m *ClusterMetadataCPUResourcesSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterMetadataInfo ¶
type ClusterMetadataInfo struct {
// The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana (only present if both exist)
CloudID string `json:"cloud_id,omitempty"`
// The DNS name of the cluster endpoint, if available
Endpoint string `json:"endpoint,omitempty"`
// The most recent time the cluster metadata was changed (ISO format in UTC)
// Required: true
// Format: date-time
LastModified *strfmt.DateTime `json:"last_modified"`
// The ports that allow communication with the cluster using various protocols.
Ports *ClusterMetadataPortInfo `json:"ports,omitempty"`
// An unstructured JSON representation of the public and internal state (can be filtered out via URL parameter). The contents and structure of the `raw` field can change at any time.
Raw interface{} `json:"raw,omitempty"`
// The resource version number of the cluster metadata
// Required: true
Version *int32 `json:"version"`
}
ClusterMetadataInfo Information about the public and internal state, and the configuration settings of an Elasticsearch cluster. swagger:model ClusterMetadataInfo
func (*ClusterMetadataInfo) MarshalBinary ¶
func (m *ClusterMetadataInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterMetadataInfo) UnmarshalBinary ¶
func (m *ClusterMetadataInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterMetadataPortInfo ¶
type ClusterMetadataPortInfo struct {
// Port where the cluster listens for HTTP traffic
// Required: true
HTTP *int32 `json:"http"`
// Port where the cluster listens for HTTPS traffic
// Required: true
HTTPS *int32 `json:"https"`
// Port where the cluster listens for transport traffic using TLS
// Required: true
TransportPassthrough *int32 `json:"transport_passthrough"`
}
ClusterMetadataPortInfo Information about the ports that allow communication between the Elasticsearch cluster and various protocols. swagger:model ClusterMetadataPortInfo
func (*ClusterMetadataPortInfo) MarshalBinary ¶
func (m *ClusterMetadataPortInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterMetadataPortInfo) UnmarshalBinary ¶
func (m *ClusterMetadataPortInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterMetadataResourcesSettings ¶
type ClusterMetadataResourcesSettings struct {
// cpu
CPU *ClusterMetadataCPUResourcesSettings `json:"cpu,omitempty"`
}
ClusterMetadataResourcesSettings The top-level configuration settings for the Elasticsearch cluster resources. swagger:model ClusterMetadataResourcesSettings
func (*ClusterMetadataResourcesSettings) MarshalBinary ¶
func (m *ClusterMetadataResourcesSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterMetadataResourcesSettings) UnmarshalBinary ¶
func (m *ClusterMetadataResourcesSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterMetadataSettings ¶
type ClusterMetadataSettings struct {
// Contact email for the cluster
ContactEmail string `json:"contact_email,omitempty"`
// Whether or not this cluster is hidden from the normal clusters list
// Read Only: true
Hidden *bool `json:"hidden,omitempty"`
// The display name of the cluster
Name string `json:"name,omitempty"`
// The user id (referencing whatever user database is in use) of the cluster owner
OwnerID string `json:"owner_id,omitempty"`
// resources
Resources *ClusterMetadataResourcesSettings `json:"resources,omitempty"`
// Subscription level of the cluster
SubscriptionLevel string `json:"subscription_level,omitempty"`
// Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)
SystemOwned *bool `json:"system_owned,omitempty"`
}
ClusterMetadataSettings The top-level configuration settings for the Elasticsearch cluster. swagger:model ClusterMetadataSettings
func (*ClusterMetadataSettings) MarshalBinary ¶
func (m *ClusterMetadataSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterMetadataSettings) UnmarshalBinary ¶
func (m *ClusterMetadataSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterPlanMigrationResponse ¶
type ClusterPlanMigrationResponse struct {
// The ID of the Elasticsearch cluster
// Required: true
ElasticsearchClusterID *string `json:"elasticsearch_cluster_id"`
// The cluster plan after applying the migration
Plan *ElasticsearchClusterPlan `json:"plan,omitempty"`
}
ClusterPlanMigrationResponse The response from migrating an Elasticsearch cluster plan to a new template. swagger:model ClusterPlanMigrationResponse
func (*ClusterPlanMigrationResponse) MarshalBinary ¶
func (m *ClusterPlanMigrationResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterPlanMigrationResponse) UnmarshalBinary ¶
func (m *ClusterPlanMigrationResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterPlanStepInfo ¶
type ClusterPlanStepInfo struct {
// When the step completed (ISO format in UTC)
// Format: date-time
Completed strfmt.DateTime `json:"completed,omitempty"`
// The duration of the step in MS
DurationInMillis int64 `json:"duration_in_millis,omitempty"`
// Human readable summaries of the step, including messages for each stage of the step
// Required: true
InfoLog []*ClusterPlanStepLogMessageInfo `json:"info_log"`
// Current stage that the step is in
// Required: true
// Enum: [starting completed in_progress]
Stage *string `json:"stage"`
// When the step started (ISO format in UTC)
// Required: true
// Format: date-time
Started *strfmt.DateTime `json:"started"`
// The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
// Required: true
// Enum: [success warning error pending]
Status *string `json:"status"`
// ID of current step
// Required: true
StepID *string `json:"step_id"`
}
ClusterPlanStepInfo Information about a step in a plan. swagger:model ClusterPlanStepInfo
func (*ClusterPlanStepInfo) MarshalBinary ¶
func (m *ClusterPlanStepInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterPlanStepInfo) UnmarshalBinary ¶
func (m *ClusterPlanStepInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterPlanStepLogMessageInfo ¶
type ClusterPlanStepLogMessageInfo struct {
// Time in milliseconds since previous log message
DeltaInMillis int64 `json:"delta_in_millis,omitempty"`
// Human readable log message
// Required: true
Message *string `json:"message"`
// Stage that info log message takes place in
// Required: true
// Enum: [starting completed in_progress]
Stage *string `json:"stage"`
// Timestamp marking on info log of step
// Required: true
// Format: date-time
Timestamp *strfmt.DateTime `json:"timestamp"`
}
ClusterPlanStepLogMessageInfo The log message from a specified stage of an executed step in a plan. swagger:model ClusterPlanStepLogMessageInfo
func (*ClusterPlanStepLogMessageInfo) MarshalBinary ¶
func (m *ClusterPlanStepLogMessageInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterPlanStepLogMessageInfo) UnmarshalBinary ¶
func (m *ClusterPlanStepLogMessageInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterSnapshotRepositoryDefault ¶
type ClusterSnapshotRepositoryDefault interface{}
ClusterSnapshotRepositoryDefault The default object for the Elasticsearch cluster snapshot repository. swagger:model ClusterSnapshotRepositoryDefault
type ClusterSnapshotRepositoryInfo ¶
type ClusterSnapshotRepositoryInfo struct {
// Cluster snapshot default repository settings
Default ClusterSnapshotRepositoryDefault `json:"default,omitempty"`
// Cluster snapshot reference repository settings, containing the repository name in ECE fashion
Reference *ClusterSnapshotRepositoryReference `json:"reference,omitempty"`
// Cluster snapshot static repository settings, containing repository type and settings
Static *ClusterSnapshotRepositoryStatic `json:"static,omitempty"`
}
ClusterSnapshotRepositoryInfo Information about the Elasticsearch cluster snapshot repository. swagger:model ClusterSnapshotRepositoryInfo
func (*ClusterSnapshotRepositoryInfo) MarshalBinary ¶
func (m *ClusterSnapshotRepositoryInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterSnapshotRepositoryInfo) UnmarshalBinary ¶
func (m *ClusterSnapshotRepositoryInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterSnapshotRepositoryReference ¶
type ClusterSnapshotRepositoryReference struct {
// ECE snapshot repository name, from the '/platform/configuration/snapshots/repositories' endpoint
RepositoryName string `json:"repository_name,omitempty"`
}
ClusterSnapshotRepositoryReference The reference object for the Elasticsearch cluster snapshot repository. swagger:model ClusterSnapshotRepositoryReference
func (*ClusterSnapshotRepositoryReference) MarshalBinary ¶
func (m *ClusterSnapshotRepositoryReference) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterSnapshotRepositoryReference) UnmarshalBinary ¶
func (m *ClusterSnapshotRepositoryReference) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterSnapshotRepositoryStatic ¶
type ClusterSnapshotRepositoryStatic struct {
// Type of snapshot repository, ie: S3
RepositoryType string `json:"repository_type,omitempty"`
// Settings associated with snapshot repository
Settings interface{} `json:"settings,omitempty"`
}
ClusterSnapshotRepositoryStatic The static object for the Elasticsearch cluster snapshot repository. swagger:model ClusterSnapshotRepositoryStatic
func (*ClusterSnapshotRepositoryStatic) MarshalBinary ¶
func (m *ClusterSnapshotRepositoryStatic) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterSnapshotRepositoryStatic) UnmarshalBinary ¶
func (m *ClusterSnapshotRepositoryStatic) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterSnapshotRequest ¶
type ClusterSnapshotRequest struct {
// The optional name for the snapshot
Name string `json:"name,omitempty"`
// The optional snapshot repository password. When the snapshot repository password is unspecified, the default repository password is used.
Password string `json:"password,omitempty"`
// The optional snapshot repository. When the repository is unspecified, the default repository is used.
RepositoryName string `json:"repository_name,omitempty"`
// The optional snapshot repository username. When the snapshot repository username is unspecified, the default repository username is used.
Username string `json:"username,omitempty"`
}
ClusterSnapshotRequest The settings for a snapshot create request. swagger:model ClusterSnapshotRequest
func (*ClusterSnapshotRequest) MarshalBinary ¶
func (m *ClusterSnapshotRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterSnapshotRequest) UnmarshalBinary ¶
func (m *ClusterSnapshotRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterSnapshotResponse ¶
type ClusterSnapshotResponse struct {
// The name of the newly created snapshot
// Required: true
Name *string `json:"name"`
}
ClusterSnapshotResponse The response value after a snapshot is created. swagger:model ClusterSnapshotResponse
func (*ClusterSnapshotResponse) MarshalBinary ¶
func (m *ClusterSnapshotResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterSnapshotResponse) UnmarshalBinary ¶
func (m *ClusterSnapshotResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterSnapshotRetention ¶
type ClusterSnapshotRetention struct {
// Total retention period for all snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute)
MaxAge string `json:"max_age,omitempty"`
// Number of snapshots to retain
Snapshots int32 `json:"snapshots,omitempty"`
}
ClusterSnapshotRetention Information about the Elasticsearch cluster snapshot retention. swagger:model ClusterSnapshotRetention
func (*ClusterSnapshotRetention) MarshalBinary ¶
func (m *ClusterSnapshotRetention) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterSnapshotRetention) UnmarshalBinary ¶
func (m *ClusterSnapshotRetention) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterSnapshotSettings ¶
type ClusterSnapshotSettings struct {
// Cron expression indicating when should snapshots be taken. This can be enabled only if SLM is enabled for the deployment and 'interval' is not present
CronExpression string `json:"cron_expression,omitempty"`
// Indicates if Snapshotting is enabled
Enabled *bool `json:"enabled,omitempty"`
// Interval between snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 30 minutes
Interval string `json:"interval,omitempty"`
// Interval between snapshot progress checks, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 1 minute
PendingInterval string `json:"pending_interval,omitempty"`
// Snapshot repository configuration
Repository *ClusterSnapshotRepositoryInfo `json:"repository,omitempty"`
// Deprecated: ECE snapshot repository name, please use [repository] instead
RepositoryName string `json:"repository_name,omitempty"`
// Cluster snapshot retention information
Retention *ClusterSnapshotRetention `json:"retention,omitempty"`
// When set to true, the deployment will have SLM enabled. Default value is true.
// Read Only: true
Slm *bool `json:"slm,omitempty"`
// List of temporary snapshot suspensions
Suspended []string `json:"suspended"`
// The time to wait between snapshot phases (snapshot, purge), with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 10 minutes
WaitTimeAfterSnapshotting string `json:"wait_time_after_snapshotting,omitempty"`
}
ClusterSnapshotSettings The snapshot configuration settings for an Elasticsearch cluster. swagger:model ClusterSnapshotSettings
func (*ClusterSnapshotSettings) MarshalBinary ¶
func (m *ClusterSnapshotSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterSnapshotSettings) UnmarshalBinary ¶
func (m *ClusterSnapshotSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterSystemAlert ¶
type ClusterSystemAlert struct {
// Type of system alert
// Required: true
// Enum: [automatic_restart heap_dump unknown_event]
AlertType *string `json:"alert_type"`
// The exit_code related to the event. Only applicable for alert_type: slain
ExitCode int32 `json:"exit_code,omitempty"`
// Instance that caused the system alert
// Required: true
InstanceName *string `json:"instance_name"`
// Timestamp marking the system alert
// Required: true
// Format: date-time
Timestamp *strfmt.DateTime `json:"timestamp"`
// The URL related to the event. Only applicable for alert_type: heap_dump
URL string `json:"url,omitempty"`
}
ClusterSystemAlert Information about a system alert on an Elasticsearch cluster. swagger:model ClusterSystemAlert
func (*ClusterSystemAlert) MarshalBinary ¶
func (m *ClusterSystemAlert) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterSystemAlert) UnmarshalBinary ¶
func (m *ClusterSystemAlert) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterTopologyInfo ¶
type ClusterTopologyInfo struct {
// Whether the cluster topology is healthy (ie all instances are started and the services they run - ie elasticsearch - are available
// Required: true
Healthy *bool `json:"healthy"`
// instances
// Required: true
Instances []*ClusterInstanceInfo `json:"instances"`
}
ClusterTopologyInfo The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The `ClusterTopologyInfo` also includes the instances and containers, and where they are located. swagger:model ClusterTopologyInfo
func (*ClusterTopologyInfo) MarshalBinary ¶
func (m *ClusterTopologyInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterTopologyInfo) UnmarshalBinary ¶
func (m *ClusterTopologyInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterUpgradeInfo ¶
type ClusterUpgradeInfo struct {
// Cluster id
// Required: true
ClusterID *string `json:"cluster_id"`
// Version that the cluster will be running from now on
// Required: true
ClusterVersion *string `json:"cluster_version"`
}
ClusterUpgradeInfo Information about an Elasticsearch cluster upgrade. swagger:model ClusterUpgradeInfo
func (*ClusterUpgradeInfo) MarshalBinary ¶
func (m *ClusterUpgradeInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterUpgradeInfo) UnmarshalBinary ¶
func (m *ClusterUpgradeInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClustersInfo ¶
type ClustersInfo struct {
// clusters
// Required: true
Clusters []*ClusterInfo `json:"clusters"`
// If a query is supplied, then the total number of clusters that matched
MatchCount int32 `json:"match_count,omitempty"`
// The number of clusters actually returned
// Required: true
ReturnCount *int32 `json:"return_count"`
}
ClustersInfo Information about a set of Elasticsearch clusters, multiple Kibana instance, or multiple APM Servers. swagger:model ClustersInfo
func (*ClustersInfo) MarshalBinary ¶
func (m *ClustersInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClustersInfo) UnmarshalBinary ¶
func (m *ClustersInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Comment ¶
type Comment struct {
// The id of this Comment
// Required: true
ID *string `json:"id"`
// The message content of this Comment
// Required: true
Message *string `json:"message"`
// The user id of the user who wrote this Comment
// Required: true
UserID *string `json:"user_id"`
}
Comment A persisted Comment swagger:model Comment
func (*Comment) MarshalBinary ¶
MarshalBinary interface implementation
func (*Comment) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type CommentCreateRequest ¶
type CommentCreateRequest struct {
// The message for the Comment.
// Required: true
Message *string `json:"message"`
}
CommentCreateRequest A request for creating a new Comment swagger:model CommentCreateRequest
func (*CommentCreateRequest) MarshalBinary ¶
func (m *CommentCreateRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CommentCreateRequest) UnmarshalBinary ¶
func (m *CommentCreateRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CommentUpdateRequest ¶
type CommentUpdateRequest struct {
// The message for the Comment.
// Required: true
Message *string `json:"message"`
}
CommentUpdateRequest A request for updating an existing Comment swagger:model CommentUpdateRequest
func (*CommentUpdateRequest) MarshalBinary ¶
func (m *CommentUpdateRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CommentUpdateRequest) UnmarshalBinary ¶
func (m *CommentUpdateRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CommentWithMeta ¶
type CommentWithMeta struct {
// The comment
// Required: true
Comment *Comment `json:"comment"`
// The metadata
// Required: true
Metadata *Metadata `json:"metadata"`
}
CommentWithMeta A persisted Comment along with its metadata swagger:model CommentWithMeta
func (*CommentWithMeta) MarshalBinary ¶
func (m *CommentWithMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CommentWithMeta) UnmarshalBinary ¶
func (m *CommentWithMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CommentsWithMetas ¶
type CommentsWithMetas struct {
// The list of comments
// Required: true
Values []*CommentWithMeta `json:"values"`
}
CommentsWithMetas A list of persisted Comments swagger:model CommentsWithMetas
func (*CommentsWithMetas) MarshalBinary ¶
func (m *CommentsWithMetas) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CommentsWithMetas) UnmarshalBinary ¶
func (m *CommentsWithMetas) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CompatibleNodeTypesResource ¶
type CompatibleNodeTypesResource struct {
// Capacity constraints for the node type
CapacityConstraints *CapacityConstraintsResource `json:"capacity_constraints,omitempty"`
// Compatible node types for the this node type
// Required: true
CompatibleNodeTypes []string `json:"compatible_node_types"`
// Type of this node
// Required: true
NodeType *string `json:"node_type"`
}
CompatibleNodeTypesResource Information about the compatible node types. swagger:model CompatibleNodeTypesResource
func (*CompatibleNodeTypesResource) MarshalBinary ¶
func (m *CompatibleNodeTypesResource) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CompatibleNodeTypesResource) UnmarshalBinary ¶
func (m *CompatibleNodeTypesResource) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CompatibleVersionResource ¶
type CompatibleVersionResource struct {
// Capacity constraints for the version
CapacityConstraints *CapacityConstraintsResource `json:"capacity_constraints,omitempty"`
// Supported node types for the version
// Required: true
NodeTypes []*CompatibleNodeTypesResource `json:"node_types"`
// Compatible version, the key for this resource
// Required: true
Version *string `json:"version"`
}
CompatibleVersionResource Information about the compatible version. swagger:model CompatibleVersionResource
func (*CompatibleVersionResource) MarshalBinary ¶
func (m *CompatibleVersionResource) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CompatibleVersionResource) UnmarshalBinary ¶
func (m *CompatibleVersionResource) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConfigStoreOption ¶
type ConfigStoreOption struct {
// Whether or not this Config Store Option has changed
// Required: true
Changed *bool `json:"changed"`
// Name of this Config Store Option
// Required: true
Name *string `json:"name"`
// Value of this Config Store Option
// Required: true
Value *string `json:"value"`
}
ConfigStoreOption Information about the Config Store options. swagger:model ConfigStoreOption
func (*ConfigStoreOption) MarshalBinary ¶
func (m *ConfigStoreOption) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConfigStoreOption) UnmarshalBinary ¶
func (m *ConfigStoreOption) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConfigStoreOptionData ¶
type ConfigStoreOptionData struct {
// Value of this Config Store Option
// Required: true
Value *string `json:"value"`
}
ConfigStoreOptionData The data for the Config Store options. swagger:model ConfigStoreOptionData
func (*ConfigStoreOptionData) MarshalBinary ¶
func (m *ConfigStoreOptionData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConfigStoreOptionData) UnmarshalBinary ¶
func (m *ConfigStoreOptionData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConfigStoreOptionList ¶
type ConfigStoreOptionList struct {
// List of Config Store Options
// Required: true
Values []*ConfigStoreOption `json:"values"`
}
ConfigStoreOptionList A list of Config Store values. swagger:model ConfigStoreOptionList
func (*ConfigStoreOptionList) MarshalBinary ¶
func (m *ConfigStoreOptionList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConfigStoreOptionList) UnmarshalBinary ¶
func (m *ConfigStoreOptionList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConstructorHealthStatus ¶
type ConstructorHealthStatus struct {
// Whether the constructor is connected
// Required: true
Connected *bool `json:"connected"`
// Whether the constructor is in maintenance mode
// Required: true
MaintenanceMode *bool `json:"maintenance_mode"`
}
ConstructorHealthStatus The health status of the constructor. swagger:model ConstructorHealthStatus
func (*ConstructorHealthStatus) MarshalBinary ¶
func (m *ConstructorHealthStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConstructorHealthStatus) UnmarshalBinary ¶
func (m *ConstructorHealthStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConstructorInfo ¶
type ConstructorInfo struct {
// Identifier for this constructor
// Required: true
ConstructorID *string `json:"constructor_id"`
// status
// Required: true
Status *ConstructorHealthStatus `json:"status"`
}
ConstructorInfo Information about the constructor. swagger:model ConstructorInfo
func (*ConstructorInfo) MarshalBinary ¶
func (m *ConstructorInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConstructorInfo) UnmarshalBinary ¶
func (m *ConstructorInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConstructorOverview ¶
type ConstructorOverview struct {
// constructors
// Required: true
Constructors []*ConstructorInfo `json:"constructors"`
}
ConstructorOverview The overview information for the installed constructors. swagger:model ConstructorOverview
func (*ConstructorOverview) MarshalBinary ¶
func (m *ConstructorOverview) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConstructorOverview) UnmarshalBinary ¶
func (m *ConstructorOverview) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerConfigHostConfig ¶
type ContainerConfigHostConfig struct {
// Volume bindings for the container.
// Required: true
Binds []string `json:"binds"`
// The length of a CPU period in microsecond
CPUPeriod int32 `json:"cpu_period,omitempty"`
// Ports that are exposed by the container.
// Required: true
ExtraHosts []string `json:"extra_hosts"`
// Sets the networking mode for the container.
NetworkMode string `json:"network_mode,omitempty"`
// Map of ports that should be exposed on the host.
// Required: true
PortBindings map[string][]PortBinding `json:"port_bindings"`
// List of environment variables on the form KEY=value
// Required: true
Privileged *bool `json:"privileged"`
// Docker behavior to apply when a container exits
RestartPolicy *RestartPolicy `json:"restart_policy,omitempty"`
}
ContainerConfigHostConfig Docker host config swagger:model ContainerConfigHostConfig
func (*ContainerConfigHostConfig) MarshalBinary ¶
func (m *ContainerConfigHostConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerConfigHostConfig) UnmarshalBinary ¶
func (m *ContainerConfigHostConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerSetSummary ¶
type ContainerSetSummary struct {
// The identifier for this container set
// Required: true
ContainerSetID *string `json:"container_set_id"`
// Number of containers created in this container set
// Required: true
ContainersCreatedCount *int32 `json:"containers_created_count"`
// Expected number of running containers in this container set
// Required: true
ContainersExpectedRunningCount *int32 `json:"containers_expected_running_count"`
// Number of containers running in this container set
// Required: true
ContainersRunningCount *int32 `json:"containers_running_count"`
// Number of containers started in this container set
// Required: true
ContainersStartedCount *int32 `json:"containers_started_count"`
// Whether the container set is healthy
// Required: true
Healthy *bool `json:"healthy"`
// True if the container set is hidden
// Required: true
Hidden *bool `json:"hidden"`
}
ContainerSetSummary Summarized information about a container set swagger:model ContainerSetSummary
func (*ContainerSetSummary) MarshalBinary ¶
func (m *ContainerSetSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerSetSummary) UnmarshalBinary ¶
func (m *ContainerSetSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerSetsSummary ¶
type ContainerSetsSummary struct {
// Whether all container sets are healthy
// Required: true
Healthy *bool `json:"healthy"`
// Number of healthy container sets
// Required: true
HealthyContainerSetsCount *int32 `json:"healthy_container_sets_count"`
// Summarized information about unhealthy container sets
// Required: true
UnhealthyContainerSets []*ContainerSetSummary `json:"unhealthy_container_sets"`
// Number of unhealthy container sets
// Required: true
UnhealthyContainerSetsCount *int32 `json:"unhealthy_container_sets_count"`
}
ContainerSetsSummary Summarized information about container sets swagger:model ContainerSetsSummary
func (*ContainerSetsSummary) MarshalBinary ¶
func (m *ContainerSetsSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerSetsSummary) UnmarshalBinary ¶
func (m *ContainerSetsSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainersEntry ¶
type ContainersEntry struct {
// The container set name (id)
// Required: true
ContainerSetName *string `json:"container_set_name"`
// The kind of container set, should be one of 'docker', 'elasticsearch', 'kibana', or 'apm'
// Required: true
Kind *string `json:"kind"`
// Name of the association
// Required: true
Name *string `json:"name"`
// The container options
// Required: true
Options *ContainersEntryOptions `json:"options"`
}
ContainersEntry Represents the association between a Role and a Container Set swagger:model ContainersEntry
func (*ContainersEntry) MarshalBinary ¶
func (m *ContainersEntry) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainersEntry) UnmarshalBinary ¶
func (m *ContainersEntry) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainersEntryOptions ¶
type ContainersEntryOptions struct {
// ZooKeeper ACLs associated with this allocation
// Required: true
Acls []*ContainersEntryOptionsACL `json:"acls"`
// ZooKeeper Auths associated with this allocation
// Required: true
Auths []*ContainersEntryOptionsAuth `json:"auths"`
// Secret shared between the containers that are part of this container set.
ContainerSetSecret string `json:"container_set_secret,omitempty"`
// Whether this allocation is active and should be created.
// Required: true
Enabled *bool `json:"enabled"`
// A named feature flag to check whether this container is enabled or not
EnabledByNamedFeatureFlag string `json:"enabled_by_named_feature_flag,omitempty"`
// Allocation-specific overrides for the allocated containers
Overrides *ContainersEntryOptionsOverrides `json:"overrides,omitempty"`
// Secret shared between the runners that have containers in this container set allocated.
RunnersSecret string `json:"runners_secret,omitempty"`
}
ContainersEntryOptions Options for a ContainersEntry belonging to a role swagger:model ContainersEntryOptions
func (*ContainersEntryOptions) MarshalBinary ¶
func (m *ContainersEntryOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainersEntryOptions) UnmarshalBinary ¶
func (m *ContainersEntryOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainersEntryOptionsACL ¶
type ContainersEntryOptionsACL struct {
// Identity within the provided scheme.
// Required: true
ID *string `json:"id"`
// Permissions
// Required: true
Perms *int32 `json:"perms"`
// Auth scheme, in Elastic Cloud this is usually "digest"
// Required: true
Scheme *string `json:"scheme"`
}
ContainersEntryOptionsACL ZooKeeper ACL information. swagger:model ContainersEntryOptionsACL
func (*ContainersEntryOptionsACL) MarshalBinary ¶
func (m *ContainersEntryOptionsACL) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainersEntryOptionsACL) UnmarshalBinary ¶
func (m *ContainersEntryOptionsACL) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainersEntryOptionsAuth ¶
type ContainersEntryOptionsAuth struct {
// Plain-text auth. For the "digest" scheme
// Required: true
Auth *string `json:"auth"`
// Scheme identifier, usually "digest"
// Required: true
Scheme *string `json:"scheme"`
}
ContainersEntryOptionsAuth ZooKeeper Authentication information. swagger:model ContainersEntryOptionsAuth
func (*ContainersEntryOptionsAuth) MarshalBinary ¶
func (m *ContainersEntryOptionsAuth) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainersEntryOptionsAuth) UnmarshalBinary ¶
func (m *ContainersEntryOptionsAuth) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainersEntryOptionsContainerConfig ¶
type ContainersEntryOptionsContainerConfig struct {
// List of environment variables on the form KEY=value
// Required: true
Env []string `json:"env"`
// Docker host config
HostConfig *ContainerConfigHostConfig `json:"host_config,omitempty"`
}
ContainersEntryOptionsContainerConfig Container config. Roughly corresponds to Docker container config swagger:model ContainersEntryOptionsContainerConfig
func (*ContainersEntryOptionsContainerConfig) MarshalBinary ¶
func (m *ContainersEntryOptionsContainerConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainersEntryOptionsContainerConfig) UnmarshalBinary ¶
func (m *ContainersEntryOptionsContainerConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainersEntryOptionsOverrides ¶
type ContainersEntryOptionsOverrides struct {
// Overrides for the container allocation.
ContainerConfig *ContainersEntryOptionsContainerConfig `json:"container_config,omitempty"`
}
ContainersEntryOptionsOverrides Overrides for the container allocation. swagger:model ContainersEntryOptionsOverrides
func (*ContainersEntryOptionsOverrides) MarshalBinary ¶
func (m *ContainersEntryOptionsOverrides) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainersEntryOptionsOverrides) UnmarshalBinary ¶
func (m *ContainersEntryOptionsOverrides) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CoordinatorSummary ¶
type CoordinatorSummary struct {
// Attributes of this coordinator
// Required: true
Attributes map[string]string `json:"attributes"`
// Client port of this coordinator
// Required: true
ClientPort *int32 `json:"client_port"`
// Election port of this coordinator
// Required: true
ElectionPort *int32 `json:"election_port"`
// Leader port of this coordinator
// Required: true
LeaderPort *int32 `json:"leader_port"`
// Name of this coordinator
// Required: true
Name *string `json:"name"`
// Public hostname of this coordinator
// Required: true
PublicHostname *string `json:"public_hostname"`
}
CoordinatorSummary Summarized information about a coordinator. swagger:model CoordinatorSummary
func (*CoordinatorSummary) MarshalBinary ¶
func (m *CoordinatorSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CoordinatorSummary) UnmarshalBinary ¶
func (m *CoordinatorSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CoordinatorsSummary ¶
type CoordinatorsSummary struct {
// Summarized information on each coordinator
// Required: true
Coordinators []*CoordinatorSummary `json:"coordinators"`
}
CoordinatorsSummary Summarized information about coordinators. swagger:model CoordinatorsSummary
func (*CoordinatorsSummary) MarshalBinary ¶
func (m *CoordinatorsSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CoordinatorsSummary) UnmarshalBinary ¶
func (m *CoordinatorsSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateAPIKeyRequest ¶
type CreateAPIKeyRequest struct {
// Deprecated. The security token from reauthenticate API
AuthenticationToken string `json:"authentication_token,omitempty"`
// API key description. Useful if there are multiple keys
// Required: true
Description *string `json:"description"`
}
CreateAPIKeyRequest The request payload that creates the API keys. swagger:model CreateApiKeyRequest
func (*CreateAPIKeyRequest) MarshalBinary ¶
func (m *CreateAPIKeyRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateAPIKeyRequest) UnmarshalBinary ¶
func (m *CreateAPIKeyRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateApmInCreateElasticsearchRequest ¶
type CreateApmInCreateElasticsearchRequest struct {
// The human readable name for the Apm cluster (default: takes the name of its Elasticsearch cluster)
Name string `json:"name,omitempty"`
// plan
// Required: true
Plan *ApmPlan `json:"plan"`
}
CreateApmInCreateElasticsearchRequest The request body for creating an APM Server, which is included in the Elasticsearch cluster create request. swagger:model CreateApmInCreateElasticsearchRequest
func (*CreateApmInCreateElasticsearchRequest) MarshalBinary ¶
func (m *CreateApmInCreateElasticsearchRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateApmInCreateElasticsearchRequest) UnmarshalBinary ¶
func (m *CreateApmInCreateElasticsearchRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateApmRequest ¶
type CreateApmRequest struct {
// The human readable name for the APM cluster (default: takes the name of its Elasticsearch cluster)
DisplayName string `json:"display_name,omitempty"`
// The Id of the Elasticsearch cluster to which this APM will be connected
// Required: true
ElasticsearchClusterID *string `json:"elasticsearch_cluster_id"`
// plan
// Required: true
Plan *ApmPlan `json:"plan"`
}
CreateApmRequest The request body for creating one or more APM Servers. swagger:model CreateApmRequest
func (*CreateApmRequest) MarshalBinary ¶
func (m *CreateApmRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateApmRequest) UnmarshalBinary ¶
func (m *CreateApmRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateAppSearchRequest ¶
type CreateAppSearchRequest struct {
// The human readable name for the App Search cluster (default: takes the name of its Elasticsearch cluster)
Name string `json:"name,omitempty"`
// plan
// Required: true
Plan *AppSearchPlan `json:"plan"`
}
CreateAppSearchRequest The request body for creating an App Search. swagger:model CreateAppSearchRequest
func (*CreateAppSearchRequest) MarshalBinary ¶
func (m *CreateAppSearchRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateAppSearchRequest) UnmarshalBinary ¶
func (m *CreateAppSearchRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateElasticsearchClusterRequest ¶
type CreateElasticsearchClusterRequest struct {
// apm
Apm *CreateApmInCreateElasticsearchRequest `json:"apm,omitempty"`
// The human readable name for the cluster (defaults to the generated cluster id if not specified)
ClusterName string `json:"cluster_name,omitempty"`
// kibana
Kibana *CreateKibanaInCreateElasticsearchRequest `json:"kibana,omitempty"`
// plan
// Required: true
Plan *ElasticsearchClusterPlan `json:"plan"`
// settings
Settings *DeprecatedElasticsearchClusterSettings `json:"settings,omitempty"`
}
CreateElasticsearchClusterRequest The request body for creating an Elasticsearch cluster using the clusters API. swagger:model CreateElasticsearchClusterRequest
func (*CreateElasticsearchClusterRequest) MarshalBinary ¶
func (m *CreateElasticsearchClusterRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateElasticsearchClusterRequest) UnmarshalBinary ¶
func (m *CreateElasticsearchClusterRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateEnterpriseSearchRequest ¶
type CreateEnterpriseSearchRequest struct {
// The human readable name for the Enterprise Search cluster (default: takes the name of its Elasticsearch cluster)
Name string `json:"name,omitempty"`
// plan
// Required: true
Plan *EnterpriseSearchPlan `json:"plan"`
}
CreateEnterpriseSearchRequest create enterprise search request swagger:model CreateEnterpriseSearchRequest
func (*CreateEnterpriseSearchRequest) MarshalBinary ¶
func (m *CreateEnterpriseSearchRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateEnterpriseSearchRequest) UnmarshalBinary ¶
func (m *CreateEnterpriseSearchRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateExtensionRequest ¶
type CreateExtensionRequest struct {
// The extension description.
Description string `json:"description,omitempty"`
// The URL to download the extension archive.
DownloadURL string `json:"download_url,omitempty"`
// The extension type.
// Required: true
// Enum: [plugin bundle]
ExtensionType *string `json:"extension_type"`
// The extension name. Only ASCII alphanumeric and [_.-] characters allowed
// Required: true
Name *string `json:"name"`
// The Elasticsearch version.
// Required: true
Version *string `json:"version"`
}
CreateExtensionRequest The body of a request to create a new extension swagger:model CreateExtensionRequest
func (*CreateExtensionRequest) MarshalBinary ¶
func (m *CreateExtensionRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateExtensionRequest) UnmarshalBinary ¶
func (m *CreateExtensionRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateKibanaInCreateElasticsearchRequest ¶
type CreateKibanaInCreateElasticsearchRequest struct {
// The human readable name for the Kibana cluster (default: takes the name of its Elasticsearch cluster)
ClusterName string `json:"cluster_name,omitempty"`
// plan
// Required: true
Plan *KibanaClusterPlan `json:"plan"`
}
CreateKibanaInCreateElasticsearchRequest The request body for creating a Kibana instance, which is included in the Elasticsearch cluster create request. swagger:model CreateKibanaInCreateElasticsearchRequest
func (*CreateKibanaInCreateElasticsearchRequest) MarshalBinary ¶
func (m *CreateKibanaInCreateElasticsearchRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateKibanaInCreateElasticsearchRequest) UnmarshalBinary ¶
func (m *CreateKibanaInCreateElasticsearchRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateKibanaRequest ¶
type CreateKibanaRequest struct {
// The human readable name for the Kibana cluster (default: takes the name of its Elasticsearch cluster)
ClusterName string `json:"cluster_name,omitempty"`
// The Id of the Elasticsearch cluster to which this Kibana will be connected
// Required: true
ElasticsearchClusterID *string `json:"elasticsearch_cluster_id"`
// plan
// Required: true
Plan *KibanaClusterPlan `json:"plan"`
}
CreateKibanaRequest The request body for creating one or more Kibana instances. swagger:model CreateKibanaRequest
func (*CreateKibanaRequest) MarshalBinary ¶
func (m *CreateKibanaRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateKibanaRequest) UnmarshalBinary ¶
func (m *CreateKibanaRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Creates ¶
type Creates struct {
// Diagnostics for APMs
Apm []*Apm `json:"apm"`
// Diagnostics for AppSearches
Appsearch []*AppSearch `json:"appsearch"`
// Diagnostics for Elasticsearch clusters
Elasticsearch []*Elasticsearch `json:"elasticsearch"`
// Diagnostics for Enterprise Search resources
EnterpriseSearch []*EnterpriseSearch `json:"enterprise_search"`
// Diagnostics for Kibanas
Kibana []*Kibana `json:"kibana"`
}
Creates Holds diagnostics for resources that will be created swagger:model Creates
func (*Creates) MarshalBinary ¶
MarshalBinary interface implementation
func (*Creates) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type CrossClusterSearchClusters ¶
type CrossClusterSearchClusters struct {
// Cross-cluster search clusers' IDs for the remote cluster
// Required: true
CcsClusters []string `json:"ccs_clusters"`
}
CrossClusterSearchClusters The cross-cluster search clusters for the remote clusters. swagger:model CrossClusterSearchClusters
func (*CrossClusterSearchClusters) MarshalBinary ¶
func (m *CrossClusterSearchClusters) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CrossClusterSearchClusters) UnmarshalBinary ¶
func (m *CrossClusterSearchClusters) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CrossClusterSearchInfo ¶
type CrossClusterSearchInfo struct {
// Flag signaling health issues when at least one remote has an incompatible version with this cluster
// Required: true
Healthy *bool `json:"healthy"`
// The list of remote clusters this cluster can access using cross-cluster search
// Required: true
RemoteClusters []*RemoteClusterInfo `json:"remote_clusters"`
}
CrossClusterSearchInfo The cross-cluster search settings and status for the Elasticsearch cluster. swagger:model CrossClusterSearchInfo
func (*CrossClusterSearchInfo) MarshalBinary ¶
func (m *CrossClusterSearchInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CrossClusterSearchInfo) UnmarshalBinary ¶
func (m *CrossClusterSearchInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CrossClusterSearchSettings ¶
type CrossClusterSearchSettings struct {
// Mapping of remote cluster references keyed by their respective aliases. Aliases must only contain letters, digits, dashes and underscores
// Required: true
RemoteClusters map[string]RemoteClusterRef `json:"remote_clusters"`
}
CrossClusterSearchSettings The configuration settings for the cross-cluster search. swagger:model CrossClusterSearchSettings
func (*CrossClusterSearchSettings) MarshalBinary ¶
func (m *CrossClusterSearchSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CrossClusterSearchSettings) UnmarshalBinary ¶
func (m *CrossClusterSearchSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeleteAPIKeysRequest ¶
type DeleteAPIKeysRequest struct {
// The list of API key IDs.
// Required: true
Keys []string `json:"keys"`
}
DeleteAPIKeysRequest The request payload that deletes the API keys. swagger:model DeleteApiKeysRequest
func (*DeleteAPIKeysRequest) MarshalBinary ¶
func (m *DeleteAPIKeysRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeleteAPIKeysRequest) UnmarshalBinary ¶
func (m *DeleteAPIKeysRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeleteUsersAPIKeysRequest ¶
type DeleteUsersAPIKeysRequest struct {
// The list of API key IDs.
// Required: true
UserAPIKeys []*UserAPIKey `json:"user_api_keys"`
}
DeleteUsersAPIKeysRequest The request payload that deletes the API keys. swagger:model DeleteUsersApiKeysRequest
func (*DeleteUsersAPIKeysRequest) MarshalBinary ¶
func (m *DeleteUsersAPIKeysRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeleteUsersAPIKeysRequest) UnmarshalBinary ¶
func (m *DeleteUsersAPIKeysRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentCreateMetadata ¶
type DeploymentCreateMetadata struct {
// Indicates if a deployment is system owned (restricts the set of operations that can be performed on it)
SystemOwned *bool `json:"system_owned,omitempty"`
}
DeploymentCreateMetadata Additional information about the new deployment object. swagger:model DeploymentCreateMetadata
func (*DeploymentCreateMetadata) MarshalBinary ¶
func (m *DeploymentCreateMetadata) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentCreateMetadata) UnmarshalBinary ¶
func (m *DeploymentCreateMetadata) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentCreateRequest ¶
type DeploymentCreateRequest struct {
// Additional information for this Deployment
Metadata *DeploymentCreateMetadata `json:"metadata,omitempty"`
// A name for the deployment; otherwise this will be the generated deployment id
Name string `json:"name,omitempty"`
// The Resources that will belong to this Deployment
// Required: true
Resources *DeploymentCreateResources `json:"resources"`
// Additional configuration for this Deployment
Settings *DeploymentCreateSettings `json:"settings,omitempty"`
}
DeploymentCreateRequest A request for creating a new Deployment consisting of multiple clusters swagger:model DeploymentCreateRequest
func (*DeploymentCreateRequest) MarshalBinary ¶
func (m *DeploymentCreateRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentCreateRequest) UnmarshalBinary ¶
func (m *DeploymentCreateRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentCreateResources ¶
type DeploymentCreateResources struct {
// A list of payloads for APM creation.
Apm []*ApmPayload `json:"apm"`
// A list of payloads for AppSearch creation.
Appsearch []*AppSearchPayload `json:"appsearch"`
// A list of payloads for Elasticsearch cluster creation.
Elasticsearch []*ElasticsearchPayload `json:"elasticsearch"`
// A list of payloads for Enterprise Search creation.
EnterpriseSearch []*EnterpriseSearchPayload `json:"enterprise_search"`
// A list of payloads for Kibana creation.
Kibana []*KibanaPayload `json:"kibana"`
}
DeploymentCreateResources Describes the resources that will belong to a Deployment swagger:model DeploymentCreateResources
func (*DeploymentCreateResources) MarshalBinary ¶
func (m *DeploymentCreateResources) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentCreateResources) UnmarshalBinary ¶
func (m *DeploymentCreateResources) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentCreateResponse ¶
type DeploymentCreateResponse struct {
// Whether or not the deployment was freshly created
// Required: true
Created *bool `json:"created"`
// Backend diagnostics. Sent if validation is requested.
Diagnostics *DeploymentDiagnostics `json:"diagnostics,omitempty"`
// The id of the deployment
// Required: true
ID *string `json:"id"`
// The name of the deployment
// Required: true
Name *string `json:"name"`
// List of created resources.
// Required: true
Resources []*DeploymentResource `json:"resources"`
}
DeploymentCreateResponse A response returned from the Deployment create endpoint swagger:model DeploymentCreateResponse
func (*DeploymentCreateResponse) MarshalBinary ¶
func (m *DeploymentCreateResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentCreateResponse) UnmarshalBinary ¶
func (m *DeploymentCreateResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentCreateSettings ¶
type DeploymentCreateSettings struct {
// DEPRECATED (Scheduled to be removed in the next major version): The set of rulesets applies to this deployment.
IPFilteringSettings *IPFilteringSettings `json:"ip_filtering_settings,omitempty"`
// The traffic filter rulesets to apply to this deployment.
TrafficFilterSettings *TrafficFilterSettings `json:"traffic_filter_settings,omitempty"`
}
DeploymentCreateSettings Additional configuration for the new deployment object. swagger:model DeploymentCreateSettings
func (*DeploymentCreateSettings) MarshalBinary ¶
func (m *DeploymentCreateSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentCreateSettings) UnmarshalBinary ¶
func (m *DeploymentCreateSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentDeleteResponse ¶
type DeploymentDeleteResponse struct {
// The id of the deployment
// Required: true
ID *string `json:"id"`
// The name of the deployment
// Required: true
Name *string `json:"name"`
// Details about orphaned resources
Orphaned *Orphaned `json:"orphaned,omitempty"`
}
DeploymentDeleteResponse A response returned from the Deployment delete endpoint swagger:model DeploymentDeleteResponse
func (*DeploymentDeleteResponse) MarshalBinary ¶
func (m *DeploymentDeleteResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentDeleteResponse) UnmarshalBinary ¶
func (m *DeploymentDeleteResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentDiagnostics ¶
type DeploymentDiagnostics struct {
// Diagnostics for resources to be created
Creates *Creates `json:"creates,omitempty"`
// Diagnostics for existing resources that may be updated
Updates *Updates `json:"updates,omitempty"`
}
DeploymentDiagnostics Describes the diagnostics for a given Deployment-modifying payload swagger:model DeploymentDiagnostics
func (*DeploymentDiagnostics) MarshalBinary ¶
func (m *DeploymentDiagnostics) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentDiagnostics) UnmarshalBinary ¶
func (m *DeploymentDiagnostics) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentGetResponse ¶
type DeploymentGetResponse struct {
// Whether the deployment is overall healthy or not (one or more of the resource info subsections will have healthy: false)
// Required: true
Healthy *bool `json:"healthy"`
// A randomly-generated id of this Deployment
// Required: true
ID *string `json:"id"`
// Additional information about this deployment
Metadata *DeploymentMetadata `json:"metadata,omitempty"`
// The name of this deployment
// Required: true
Name *string `json:"name"`
// The Resources that belong to this Deployment
// Required: true
Resources *DeploymentResources `json:"resources"`
// Additional configuration for this Deployment
Settings *DeploymentSettings `json:"settings,omitempty"`
}
DeploymentGetResponse Describes a given Deployment swagger:model DeploymentGetResponse
func (*DeploymentGetResponse) MarshalBinary ¶
func (m *DeploymentGetResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentGetResponse) UnmarshalBinary ¶
func (m *DeploymentGetResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentMetadata ¶
type DeploymentMetadata struct {
// Whether or not this deployment is hidden from the normal deployment list
// Read Only: true
Hidden *bool `json:"hidden,omitempty"`
// The most recent time the cluster metadata was changed (ISO format in UTC)
// Required: true
// Format: date-time
LastModified *strfmt.DateTime `json:"last_modified"`
// The most recent time the resource's plan was changed (ISO format in UTC)
// Format: date-time
LastResourcePlanModified strfmt.DateTime `json:"last_resource_plan_modified,omitempty"`
// The user id (referencing whatever user database is in use) of the deployment owner
OwnerID string `json:"owner_id,omitempty"`
// Subscription level of the cluster
// Read Only: true
SubscriptionLevel string `json:"subscription_level,omitempty"`
// Indicates if a deployment is system owned (restricts the set of operations that can be performed on it)
SystemOwned *bool `json:"system_owned,omitempty"`
}
DeploymentMetadata Additional information about the current deployment object. swagger:model DeploymentMetadata
func (*DeploymentMetadata) MarshalBinary ¶
func (m *DeploymentMetadata) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentMetadata) UnmarshalBinary ¶
func (m *DeploymentMetadata) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentResource ¶
type DeploymentResource struct {
// An encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana
CloudID string `json:"cloud_id,omitempty"`
// Credentials for logging into a created resource. Only provided on initial create and absent otherwise.
Credentials *ClusterCredentials `json:"credentials,omitempty"`
// The Elasticsearch cluster that this resource depends on.
ElasticsearchClusterRefID string `json:"elasticsearch_cluster_ref_id,omitempty"`
// A system-unique id for the created resource
// Required: true
ID *string `json:"id"`
// The kind of resource
// Required: true
Kind *string `json:"kind"`
// A locally-unique friendly alias for this Elasticsearch cluster
// Required: true
RefID *string `json:"ref_id"`
// Identifier of the region in which this resource runs.
// Required: true
Region *string `json:"region"`
// Secret token for using a created resource. Only provided on initial create and absent otherwise.
SecretToken string `json:"secret_token,omitempty"`
// List of warnings generated from validating resource updates
Warnings []*ReplyWarning `json:"warnings"`
}
DeploymentResource Data for a deployment resource swagger:model DeploymentResource
func (*DeploymentResource) MarshalBinary ¶
func (m *DeploymentResource) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentResource) UnmarshalBinary ¶
func (m *DeploymentResource) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentResourceCommandResponse ¶
type DeploymentResourceCommandResponse interface{}
DeploymentResourceCommandResponse Response returned when a command is successfully issued against a given Deployment resource swagger:model DeploymentResourceCommandResponse
type DeploymentResourceCrudResponse ¶
type DeploymentResourceCrudResponse struct {
// The id of the deployment
// Required: true
ID *string `json:"id"`
// The kind of the stateless resource
// Required: true
Kind *string `json:"kind"`
// The reference id of the resource
// Required: true
RefID *string `json:"ref_id"`
}
DeploymentResourceCrudResponse A response returned from the Deployment Resource endpoints swagger:model DeploymentResourceCrudResponse
func (*DeploymentResourceCrudResponse) MarshalBinary ¶
func (m *DeploymentResourceCrudResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentResourceCrudResponse) UnmarshalBinary ¶
func (m *DeploymentResourceCrudResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentResourceUpgradeResponse ¶
type DeploymentResourceUpgradeResponse struct {
// resource id
// Required: true
ResourceID *string `json:"resource_id"`
// stack version
// Required: true
StackVersion *string `json:"stack_version"`
}
DeploymentResourceUpgradeResponse deployment resource upgrade response swagger:model DeploymentResourceUpgradeResponse
func (*DeploymentResourceUpgradeResponse) MarshalBinary ¶
func (m *DeploymentResourceUpgradeResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentResourceUpgradeResponse) UnmarshalBinary ¶
func (m *DeploymentResourceUpgradeResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentResources ¶
type DeploymentResources struct {
// List of Apm resources in your Deployment
// Required: true
Apm []*ApmResourceInfo `json:"apm"`
// List of App Search resources in your Deployment
// Required: true
Appsearch []*AppSearchResourceInfo `json:"appsearch"`
// List of Elasticsearch resources in your Deployment
// Required: true
Elasticsearch []*ElasticsearchResourceInfo `json:"elasticsearch"`
// List of Enterprise Search resources in your Deployment
// Required: true
EnterpriseSearch []*EnterpriseSearchResourceInfo `json:"enterprise_search"`
// List of Kibana resources in your Deployment
// Required: true
Kibana []*KibanaResourceInfo `json:"kibana"`
}
DeploymentResources Describes a resource belonging to a Deployment swagger:model DeploymentResources
func (*DeploymentResources) MarshalBinary ¶
func (m *DeploymentResources) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentResources) UnmarshalBinary ¶
func (m *DeploymentResources) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentRestoreResponse ¶
type DeploymentRestoreResponse struct {
// The id of the deployment
// Required: true
ID *string `json:"id"`
}
DeploymentRestoreResponse A response returned from the Deployment restore endpoint swagger:model DeploymentRestoreResponse
func (*DeploymentRestoreResponse) MarshalBinary ¶
func (m *DeploymentRestoreResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentRestoreResponse) UnmarshalBinary ¶
func (m *DeploymentRestoreResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentSearchResponse ¶
type DeploymentSearchResponse struct {
// Whether the deployment is overall healthy or not (one or more of the resource info subsections will have healthy: false)
// Required: true
Healthy *bool `json:"healthy"`
// A randomly-generated id of this Deployment
// Required: true
ID *string `json:"id"`
// Additional information about this deployment
Metadata *DeploymentMetadata `json:"metadata,omitempty"`
// The name of this deployment
// Required: true
Name *string `json:"name"`
// The Resources that belong to this Deployment
// Required: true
Resources *DeploymentResources `json:"resources"`
// Additional configuration for this Deployment
Settings *DeploymentSettings `json:"settings,omitempty"`
}
DeploymentSearchResponse Describes a searched Deployment swagger:model DeploymentSearchResponse
func (*DeploymentSearchResponse) MarshalBinary ¶
func (m *DeploymentSearchResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentSearchResponse) UnmarshalBinary ¶
func (m *DeploymentSearchResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentSettings ¶
type DeploymentSettings struct {
// DEPRECATED The set of IP filtering rulesets applies to this deployment.
IPFilteringSettings *IPFilteringSettings `json:"ip_filtering_settings,omitempty"`
// The traffic filter rulesets for this deployment.
TrafficFilterSettings *TrafficFilterSettings `json:"traffic_filter_settings,omitempty"`
}
DeploymentSettings Additional configuration about the current deployment object. swagger:model DeploymentSettings
func (*DeploymentSettings) MarshalBinary ¶
func (m *DeploymentSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentSettings) UnmarshalBinary ¶
func (m *DeploymentSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentShutdownResponse ¶
type DeploymentShutdownResponse struct {
// The id of the deployment
// Required: true
ID *string `json:"id"`
// The name of the deployment
// Required: true
Name *string `json:"name"`
// Details about orphaned resources
Orphaned *Orphaned `json:"orphaned,omitempty"`
}
DeploymentShutdownResponse A response returned from the Deployment shutdown endpoint swagger:model DeploymentShutdownResponse
func (*DeploymentShutdownResponse) MarshalBinary ¶
func (m *DeploymentShutdownResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentShutdownResponse) UnmarshalBinary ¶
func (m *DeploymentShutdownResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentTemplateDefinitionRequest ¶
type DeploymentTemplateDefinitionRequest struct {
// apm
Apm *CreateApmInCreateElasticsearchRequest `json:"apm,omitempty"`
// appsearch
Appsearch *CreateAppSearchRequest `json:"appsearch,omitempty"`
// The human readable name for the cluster (defaults to the generated cluster id if not specified)
ClusterName string `json:"cluster_name,omitempty"`
// enterprise search
EnterpriseSearch *CreateEnterpriseSearchRequest `json:"enterprise_search,omitempty"`
// kibana
Kibana *CreateKibanaInCreateElasticsearchRequest `json:"kibana,omitempty"`
// plan
// Required: true
Plan *ElasticsearchClusterPlan `json:"plan"`
// settings
Settings *ElasticsearchClusterSettings `json:"settings,omitempty"`
}
DeploymentTemplateDefinitionRequest The request body for a deployment templatee. swagger:model DeploymentTemplateDefinitionRequest
func (*DeploymentTemplateDefinitionRequest) MarshalBinary ¶
func (m *DeploymentTemplateDefinitionRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentTemplateDefinitionRequest) UnmarshalBinary ¶
func (m *DeploymentTemplateDefinitionRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentTemplateInfo ¶
type DeploymentTemplateInfo struct {
// The body of the cluster template to use for creating a cluster.
ClusterTemplate *DeploymentTemplateDefinitionRequest `json:"cluster_template,omitempty"`
// The body of the deployment template to use for creating a deployment.
DeploymentTemplate *DeploymentCreateRequest `json:"deployment_template,omitempty"`
// An optional description for the template.
Description string `json:"description,omitempty"`
// Whether or not the deployment template is hidden by default.
Hidden *bool `json:"hidden,omitempty"`
// The unique identifier for the template.
ID string `json:"id,omitempty"`
// Optional list of instance configurations used in the cluster template.
InstanceConfigurations []*InstanceConfiguration `json:"instance_configurations,omitempty"`
// Optional arbitrary metadata to associate with this template.
Metadata []*MetadataItem `json:"metadata"`
// Minimum stack version required by this template, if any.
MinVersion string `json:"min_version,omitempty"`
// A human readable name for the template.
// Required: true
Name *string `json:"name"`
// Determines the order in which this template should be returned when listed. Templates are returned in ascending order. If not specified, then the template willbe appended to the end of the list.
Order *int32 `json:"order,omitempty"`
// Information describing the source that created or modified the template.
Source *ChangeSourceInfo `json:"source,omitempty"`
// Whether or not if this is system owned template.
SystemOwned *bool `json:"system_owned,omitempty"`
}
DeploymentTemplateInfo The top-level object for a deployment template. swagger:model DeploymentTemplateInfo
func (*DeploymentTemplateInfo) MarshalBinary ¶
func (m *DeploymentTemplateInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentTemplateInfo) UnmarshalBinary ¶
func (m *DeploymentTemplateInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentTemplateInfoV2 ¶
type DeploymentTemplateInfoV2 struct {
// The body of the deployment template to use for creating a deployment.
// Required: true
DeploymentTemplate *DeploymentCreateRequest `json:"deployment_template"`
// An optional description for the template.
Description string `json:"description,omitempty"`
// Whether or not the deployment template is hidden by default.
Hidden *bool `json:"hidden,omitempty"`
// The unique identifier for the template.
// Required: true
ID *string `json:"id"`
// List of instance configurations used in the cluster template.
// Required: true
InstanceConfigurations []*InstanceConfigurationInfo `json:"instance_configurations"`
// Optional arbitrary metadata to associate with this template.
Metadata []*MetadataItem `json:"metadata"`
// Minimum stack version required by this template, if any.
MinVersion string `json:"min_version,omitempty"`
// A human readable name for the template.
// Required: true
Name *string `json:"name"`
// Determines the order in which this template should be returned when listed. Templates are returned in ascending order. If not specified, then the template willbe appended to the end of the list.
Order int32 `json:"order,omitempty"`
// Information describing the source that created or modified the template.
Source *ChangeSourceInfo `json:"source,omitempty"`
// Whether or not if this is system owned template.
SystemOwned *bool `json:"system_owned,omitempty"`
}
DeploymentTemplateInfoV2 Deployment template detailed information swagger:model DeploymentTemplateInfoV2
func (*DeploymentTemplateInfoV2) MarshalBinary ¶
func (m *DeploymentTemplateInfoV2) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentTemplateInfoV2) UnmarshalBinary ¶
func (m *DeploymentTemplateInfoV2) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentTemplateReference ¶
type DeploymentTemplateReference struct {
// The unique identifier of the deployment template
// Required: true
ID *string `json:"id"`
// A version identifier to disambiguate multiple revisions of the same template
Version string `json:"version,omitempty"`
}
DeploymentTemplateReference Specifies the deployment template used to create the plan. swagger:model DeploymentTemplateReference
func (*DeploymentTemplateReference) MarshalBinary ¶
func (m *DeploymentTemplateReference) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentTemplateReference) UnmarshalBinary ¶
func (m *DeploymentTemplateReference) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentTemplateRequestBody ¶
type DeploymentTemplateRequestBody struct {
// The body of the deployment template to use for creating a deployment.
// Required: true
DeploymentTemplate *DeploymentCreateRequest `json:"deployment_template"`
// An optional description for the template.
Description string `json:"description,omitempty"`
// Whether or not the deployment template is hidden by default.
Hidden *bool `json:"hidden,omitempty"`
// Optional arbitrary metadata to associate with this template.
Metadata []*MetadataItem `json:"metadata"`
// Minimum stack version required by this template, if any.
MinVersion string `json:"min_version,omitempty"`
// A human readable name for the template.
// Required: true
Name *string `json:"name"`
// Determines the order in which this template should be returned when listed. Templates are returned in ascending order. If not specified, then the template willbe appended to the end of the list.
Order int32 `json:"order,omitempty"`
// Whether or not if this is system owned template.
SystemOwned *bool `json:"system_owned,omitempty"`
}
DeploymentTemplateRequestBody Request body to create or update a Deployment Template swagger:model DeploymentTemplateRequestBody
func (*DeploymentTemplateRequestBody) MarshalBinary ¶
func (m *DeploymentTemplateRequestBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentTemplateRequestBody) UnmarshalBinary ¶
func (m *DeploymentTemplateRequestBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentUpdateMetadata ¶
type DeploymentUpdateMetadata struct {
// Whether or not this deployment is hidden from the normal deployment list
Hidden *bool `json:"hidden,omitempty"`
// Indicates if a deployment is system owned (restricts the set of operations that can be performed on it)
SystemOwned *bool `json:"system_owned,omitempty"`
}
DeploymentUpdateMetadata Additional information about the current deployment object. swagger:model DeploymentUpdateMetadata
func (*DeploymentUpdateMetadata) MarshalBinary ¶
func (m *DeploymentUpdateMetadata) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentUpdateMetadata) UnmarshalBinary ¶
func (m *DeploymentUpdateMetadata) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentUpdateRequest ¶
type DeploymentUpdateRequest struct {
// New information about the current deployment object, otherwise stays the same
Metadata *DeploymentUpdateMetadata `json:"metadata,omitempty"`
// A new name for the deployment, otherwise stays the same.
Name string `json:"name,omitempty"`
// Whether or not to prune orphan resources that are no longer mentioned in this request. Note that resourcesare tracked by ref_id, and if a resource's ref_id is changed, any previous running resources created with that previousref_id are considered to be orphaned as well.
// Required: true
PruneOrphans *bool `json:"prune_orphans"`
// New information about the Resources that will have this Deployment, otherwise they stay the same
Resources *DeploymentUpdateResources `json:"resources,omitempty"`
}
DeploymentUpdateRequest A request for updating a Deployment consisting of multiple resources swagger:model DeploymentUpdateRequest
func (*DeploymentUpdateRequest) MarshalBinary ¶
func (m *DeploymentUpdateRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentUpdateRequest) UnmarshalBinary ¶
func (m *DeploymentUpdateRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentUpdateResources ¶
type DeploymentUpdateResources struct {
// A list of payloads for APM updates
Apm []*ApmPayload `json:"apm"`
// A list of payloads for AppSearch updates
Appsearch []*AppSearchPayload `json:"appsearch"`
// A list of payloads for Elasticsearch cluster updates
Elasticsearch []*ElasticsearchPayload `json:"elasticsearch"`
// A list of payloads for Enterprise Search updates
EnterpriseSearch []*EnterpriseSearchPayload `json:"enterprise_search"`
// A list of payloads for Kibana updates
Kibana []*KibanaPayload `json:"kibana"`
}
DeploymentUpdateResources Describes the resources that will have the Deployment swagger:model DeploymentUpdateResources
func (*DeploymentUpdateResources) MarshalBinary ¶
func (m *DeploymentUpdateResources) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentUpdateResources) UnmarshalBinary ¶
func (m *DeploymentUpdateResources) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentUpdateResponse ¶
type DeploymentUpdateResponse struct {
// Backend diagnostics. Sent if validation is requested.
Diagnostics *DeploymentDiagnostics `json:"diagnostics,omitempty"`
// The id of the deployment
// Required: true
ID *string `json:"id"`
// The name of the deployment
// Required: true
Name *string `json:"name"`
// List of resources that are part of the deployment after the update operation.
// Required: true
Resources []*DeploymentResource `json:"resources"`
// List of resources that have been shut down
ShutdownResources *Orphaned `json:"shutdown_resources,omitempty"`
}
DeploymentUpdateResponse A response returned from the Deployment update endpoint swagger:model DeploymentUpdateResponse
func (*DeploymentUpdateResponse) MarshalBinary ¶
func (m *DeploymentUpdateResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentUpdateResponse) UnmarshalBinary ¶
func (m *DeploymentUpdateResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentsListResponse ¶
type DeploymentsListResponse struct {
// The deployments
// Required: true
Deployments []*DeploymentsListingData `json:"deployments"`
}
DeploymentsListResponse Contains a list of deployments swagger:model DeploymentsListResponse
func (*DeploymentsListResponse) MarshalBinary ¶
func (m *DeploymentsListResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentsListResponse) UnmarshalBinary ¶
func (m *DeploymentsListResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentsListingData ¶
type DeploymentsListingData struct {
// The id of this deployment
// Required: true
ID *string `json:"id"`
// The name of this deployment
// Required: true
Name *string `json:"name"`
// List of resources in this deployment
// Required: true
Resources []*DeploymentResource `json:"resources"`
}
DeploymentsListingData deployments listing data swagger:model DeploymentsListingData
func (*DeploymentsListingData) MarshalBinary ¶
func (m *DeploymentsListingData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentsListingData) UnmarshalBinary ¶
func (m *DeploymentsListingData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeploymentsSearchResponse ¶
type DeploymentsSearchResponse struct {
// deployments
// Required: true
Deployments []*DeploymentSearchResponse `json:"deployments"`
// If a query is supplied, then the total number of deployments that matched
MatchCount int32 `json:"match_count,omitempty"`
// The number of deployments actually returned
// Required: true
ReturnCount *int32 `json:"return_count"`
}
DeploymentsSearchResponse Contains a list of Deployments as result of a search request. swagger:model DeploymentsSearchResponse
func (*DeploymentsSearchResponse) MarshalBinary ¶
func (m *DeploymentsSearchResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeploymentsSearchResponse) UnmarshalBinary ¶
func (m *DeploymentsSearchResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeprecatedElasticsearchClusterSettings ¶
type DeprecatedElasticsearchClusterSettings struct {
// ccs
Ccs *CrossClusterSearchSettings `json:"ccs,omitempty"`
// curation
Curation *ClusterCurationSettings `json:"curation,omitempty"`
// Threshold starting from which the number of instances in the cluster results in the introduction of dedicated masters. If the cluster is downscaled to a number of nodes below this one, dedicated masters will be removed. Limit is inclusive.
DedicatedMastersThreshold int32 `json:"dedicated_masters_threshold,omitempty"`
// DEPRECATED (Scheduled to be removed in the next major version): The set of rulesets to apply for all the resources in this cluster. When specified the same rulesets will be applied to Kibana and APM clusters as well
IPFiltering *IPFilteringSettings `json:"ip_filtering,omitempty"`
// metadata
Metadata *ClusterMetadataSettings `json:"metadata,omitempty"`
// monitoring
Monitoring *ManagedMonitoringSettings `json:"monitoring,omitempty"`
// snapshot
Snapshot *ClusterSnapshotSettings `json:"snapshot,omitempty"`
// The rulesets to apply to all resources in this cluster. When specified the same rulesets will be applied to Kibana and APM clusters as well
TrafficFilter *TrafficFilterSettings `json:"traffic_filter,omitempty"`
}
DeprecatedElasticsearchClusterSettings The settings for an Elasticsearch cluster. swagger:model DeprecatedElasticsearchClusterSettings
func (*DeprecatedElasticsearchClusterSettings) MarshalBinary ¶
func (m *DeprecatedElasticsearchClusterSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeprecatedElasticsearchClusterSettings) UnmarshalBinary ¶
func (m *DeprecatedElasticsearchClusterSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DiscreteSizes ¶
type DiscreteSizes struct {
// The default size
// Required: true
DefaultSize *int32 `json:"default_size"`
// The unit that each size represents
// Required: true
// Enum: [memory storage]
Resource *string `json:"resource"`
// List of supported sizes
// Required: true
Sizes []int32 `json:"sizes"`
}
DiscreteSizes Instance sizes that are supported by the Elasticsearch instance, Kibana instance, or APM Server configuration. swagger:model DiscreteSizes
func (*DiscreteSizes) MarshalBinary ¶
func (m *DiscreteSizes) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DiscreteSizes) UnmarshalBinary ¶
func (m *DiscreteSizes) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Elasticsearch ¶
type Elasticsearch struct {
// The backend plan as JSON
// Required: true
BackendPlan interface{} `json:"backend_plan"`
// The human readable name for the cluster (defaults to the generated cluster id if not specified)
// Required: true
DisplayName *string `json:"display_name"`
// A locally-unique user-specified id
// Required: true
RefID *string `json:"ref_id"`
}
Elasticsearch Holds diagnostics for an Elasticsearch cluster swagger:model Elasticsearch
func (*Elasticsearch) MarshalBinary ¶
func (m *Elasticsearch) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Elasticsearch) UnmarshalBinary ¶
func (m *Elasticsearch) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchClusterBlockingIssueElement ¶
type ElasticsearchClusterBlockingIssueElement struct {
// Description of the issue
// Required: true
Description *string `json:"description"`
// A list of instances that are affected by the issue
// Required: true
Instances []string `json:"instances"`
}
ElasticsearchClusterBlockingIssueElement Information about an issue and the Elasticsearch instance it affects. swagger:model ElasticsearchClusterBlockingIssueElement
func (*ElasticsearchClusterBlockingIssueElement) MarshalBinary ¶
func (m *ElasticsearchClusterBlockingIssueElement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchClusterBlockingIssueElement) UnmarshalBinary ¶
func (m *ElasticsearchClusterBlockingIssueElement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchClusterBlockingIssues ¶
type ElasticsearchClusterBlockingIssues struct {
// A list of issues that affect availability of entire cluster
// Required: true
ClusterLevel []*ElasticsearchClusterBlockingIssueElement `json:"cluster_level"`
// Whether the cluster has issues (false) or not (true)
// Required: true
Healthy *bool `json:"healthy"`
// A list of issues that affect availability of the cluster's indices
// Required: true
IndexLevel []*ElasticsearchClusterBlockingIssueElement `json:"index_level"`
}
ElasticsearchClusterBlockingIssues Issues that prevent the Elasticsearch cluster or index from correctly operating. swagger:model ElasticsearchClusterBlockingIssues
func (*ElasticsearchClusterBlockingIssues) MarshalBinary ¶
func (m *ElasticsearchClusterBlockingIssues) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchClusterBlockingIssues) UnmarshalBinary ¶
func (m *ElasticsearchClusterBlockingIssues) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchClusterInfo ¶
type ElasticsearchClusterInfo struct {
// associated apm clusters
// Required: true
AssociatedApmClusters []*ApmSubInfo `json:"associated_apm_clusters"`
// associated appsearch clusters
// Required: true
AssociatedAppsearchClusters []*AppSearchSubInfo `json:"associated_appsearch_clusters"`
// associated enterprise search clusters
// Required: true
AssociatedEnterpriseSearchClusters []*EnterpriseSearchSubInfo `json:"associated_enterprise_search_clusters"`
// associated kibana clusters
// Required: true
AssociatedKibanaClusters []*KibanaSubClusterInfo `json:"associated_kibana_clusters"`
// Cross-cluster search settings and status for this cluster.
Ccs *CrossClusterSearchInfo `json:"ccs,omitempty"`
// The id of the cluster
// Required: true
ClusterID *string `json:"cluster_id"`
// The name of the cluster
// Required: true
ClusterName *string `json:"cluster_name"`
// The id of the deployment that this Elasticsearch belongs to.
DeploymentID string `json:"deployment_id,omitempty"`
// elasticsearch
// Required: true
Elasticsearch *ElasticsearchInfo `json:"elasticsearch"`
// elasticsearch monitoring info
ElasticsearchMonitoringInfo *ElasticsearchMonitoringInfo `json:"elasticsearch_monitoring_info,omitempty"`
// External resources related to the cluster
// Required: true
// Unique: true
ExternalLinks []*ExternalHyperlink `json:"external_links"`
// Whether the cluster is healthy or not (one or more of the info subsections will have healthy: false)
// Required: true
Healthy *bool `json:"healthy"`
// A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Links map[string]Hyperlink `json:"links,omitempty"`
// Whether or not this cluster is locked. Only populated in SaaS.
Locked *bool `json:"locked,omitempty"`
// metadata
// Required: true
Metadata *ClusterMetadataInfo `json:"metadata"`
// plan info
// Required: true
PlanInfo *ElasticsearchClusterPlansInfo `json:"plan_info"`
// The region that this cluster belongs to. Only populated in SaaS or federated ECE.
Region string `json:"region,omitempty"`
// security
Security *ElasticsearchClusterSecurityInfo `json:"security,omitempty"`
// settings
Settings *ElasticsearchClusterSettings `json:"settings,omitempty"`
// snapshots
// Required: true
Snapshots *SnapshotStatusInfo `json:"snapshots"`
// Cluster status
// Required: true
// Enum: [initializing stopping stopped rebooting restarting reconfiguring started]
Status *string `json:"status"`
// List of cluster system alerts
SystemAlerts []*ClusterSystemAlert `json:"system_alerts"`
// topology
// Required: true
Topology *ClusterTopologyInfo `json:"topology"`
}
ElasticsearchClusterInfo The information for an Elasticsearch cluster. swagger:model ElasticsearchClusterInfo
func (*ElasticsearchClusterInfo) MarshalBinary ¶
func (m *ElasticsearchClusterInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchClusterInfo) UnmarshalBinary ¶
func (m *ElasticsearchClusterInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchClusterInstanceSettingsOverrides ¶
type ElasticsearchClusterInstanceSettingsOverrides struct {
// Sets the memory capacity for the instance's container. Requires a restart to take effect.
InstanceCapacity int32 `json:"instance_capacity,omitempty"`
// Overrides the disk quota multiplier for the instance.
StorageMultiplier float64 `json:"storage_multiplier,omitempty"`
}
ElasticsearchClusterInstanceSettingsOverrides The override settings for an Elasticsearch instance. swagger:model ElasticsearchClusterInstanceSettingsOverrides
func (*ElasticsearchClusterInstanceSettingsOverrides) MarshalBinary ¶
func (m *ElasticsearchClusterInstanceSettingsOverrides) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchClusterInstanceSettingsOverrides) UnmarshalBinary ¶
func (m *ElasticsearchClusterInstanceSettingsOverrides) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchClusterPlan ¶
type ElasticsearchClusterPlan struct {
// cluster topology
// Required: true
ClusterTopology []*ElasticsearchClusterTopologyElement `json:"cluster_topology"`
// Documents which deployment template was used in the creation of this plan
DeploymentTemplate *DeploymentTemplateReference `json:"deployment_template,omitempty"`
// elasticsearch
// Required: true
Elasticsearch *ElasticsearchConfiguration `json:"elasticsearch"`
// DEPRECATED: Scheduled for removal in a future version of the API.
//
// Whether to add a tiebreaker node in an unused zone (defaults to auto-decide based on topology).
// If master nodes are specified then this cannot be left blank, you must explicitly decide true or false.
TiebreakerOverride *bool `json:"tiebreaker_override,omitempty"`
// DEPRECATED: Scheduled for removal in a future version of the API.
//
// Defines the topology (capacity and location) of the special tiebreaker node. If masters nodes are present, their topology acts as a default for the tiebreaker topology
TiebreakerTopology *TiebreakerTopologyElement `json:"tiebreaker_topology,omitempty"`
// transient
Transient *TransientElasticsearchPlanConfiguration `json:"transient,omitempty"`
// DEPRECATED: Scheduled for removal in a future version of the API. Please use `cluster_topology.zone_count` instead.
//
// The default number of zones in which data nodes will be placed, if not specified in the per topology settings
ZoneCount int32 `json:"zone_count,omitempty"`
}
ElasticsearchClusterPlan The plan for the Elasticsearch cluster. swagger:model ElasticsearchClusterPlan
func (*ElasticsearchClusterPlan) MarshalBinary ¶
func (m *ElasticsearchClusterPlan) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchClusterPlan) UnmarshalBinary ¶
func (m *ElasticsearchClusterPlan) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchClusterPlanInfo ¶
type ElasticsearchClusterPlanInfo struct {
// If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
// Format: date-time
AttemptEndTime strfmt.DateTime `json:"attempt_end_time,omitempty"`
// When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)
// Format: date-time
AttemptStartTime strfmt.DateTime `json:"attempt_start_time,omitempty"`
// Either the plan ended successfully, or is not yet completed (and no errors have occurred)
// Required: true
Healthy *bool `json:"healthy"`
// plan
Plan *ElasticsearchClusterPlan `json:"plan,omitempty"`
// A UUID for each plan attempt
PlanAttemptID string `json:"plan_attempt_id,omitempty"`
// plan attempt log
// Required: true
PlanAttemptLog []*ClusterPlanStepInfo `json:"plan_attempt_log"`
// A human readable name for each plan attempt, only populated when retrieving plan histories
PlanAttemptName string `json:"plan_attempt_name,omitempty"`
// If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
// Format: date-time
PlanEndTime strfmt.DateTime `json:"plan_end_time,omitempty"`
// Information describing the source that facilitated the plans current state
Source *ChangeSourceInfo `json:"source,omitempty"`
}
ElasticsearchClusterPlanInfo Information about the Elasticsearch cluster plan. swagger:model ElasticsearchClusterPlanInfo
func (*ElasticsearchClusterPlanInfo) MarshalBinary ¶
func (m *ElasticsearchClusterPlanInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchClusterPlanInfo) UnmarshalBinary ¶
func (m *ElasticsearchClusterPlanInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchClusterPlansInfo ¶
type ElasticsearchClusterPlansInfo struct {
// current
Current *ElasticsearchClusterPlanInfo `json:"current,omitempty"`
// Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
// Required: true
Healthy *bool `json:"healthy"`
// history
// Required: true
History []*ElasticsearchClusterPlanInfo `json:"history"`
// pending
Pending *ElasticsearchClusterPlanInfo `json:"pending,omitempty"`
}
ElasticsearchClusterPlansInfo Information about the current, pending, and past Elasticsearch cluster plans. swagger:model ElasticsearchClusterPlansInfo
func (*ElasticsearchClusterPlansInfo) MarshalBinary ¶
func (m *ElasticsearchClusterPlansInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchClusterPlansInfo) UnmarshalBinary ¶
func (m *ElasticsearchClusterPlansInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchClusterRole ¶
type ElasticsearchClusterRole struct {
// The list of roles for this user
// Required: true
Roles []string `json:"roles"`
// The username
// Required: true
Username *string `json:"username"`
}
ElasticsearchClusterRole The authorization information for an Elasticsearch cluster user. swagger:model ElasticsearchClusterRole
func (*ElasticsearchClusterRole) MarshalBinary ¶
func (m *ElasticsearchClusterRole) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchClusterRole) UnmarshalBinary ¶
func (m *ElasticsearchClusterRole) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchClusterSecurityInfo ¶
type ElasticsearchClusterSecurityInfo struct {
// The most recent time the security settings were changed (ISO format in UTC)
// Required: true
// Format: date-time
LastModified *strfmt.DateTime `json:"last_modified"`
// An arbitrarily nested JSON object mapping roles to sets of resources and permissions - see the Elasticsearch security documentation for more details on roles
// Required: true
Roles interface{} `json:"roles"`
// users
// Required: true
Users []*ElasticsearchClusterUser `json:"users"`
// users roles
// Required: true
UsersRoles []*ElasticsearchClusterRole `json:"users_roles"`
// The resource version number of the security settings
// Required: true
Version *int32 `json:"version"`
}
ElasticsearchClusterSecurityInfo For 2.x Elasticsearch clusters, specifies the information about the users and roles. For 5.x Elasticsearch clusters, use the Kibana management UI. swagger:model ElasticsearchClusterSecurityInfo
func (*ElasticsearchClusterSecurityInfo) MarshalBinary ¶
func (m *ElasticsearchClusterSecurityInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchClusterSecurityInfo) UnmarshalBinary ¶
func (m *ElasticsearchClusterSecurityInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchClusterSettings ¶
type ElasticsearchClusterSettings struct {
// ccs
Ccs *CrossClusterSearchSettings `json:"ccs,omitempty"`
// curation
Curation *ClusterCurationSettings `json:"curation,omitempty"`
// Threshold starting from which the number of instances in the cluster results in the introduction of dedicated masters. If the cluster is downscaled to a number of nodes below this one, dedicated masters will be removed. Limit is inclusive.
DedicatedMastersThreshold int32 `json:"dedicated_masters_threshold,omitempty"`
// DEPRECATED (Scheduled to be removed in the next major version): The set of rulesets to apply for all the resources in this cluster. When specified the same rulesets will be applied to Kibana and APM clusters as well
IPFiltering *IPFilteringSettings `json:"ip_filtering,omitempty"`
// metadata
Metadata *ClusterMetadataSettings `json:"metadata,omitempty"`
// monitoring
Monitoring *ManagedMonitoringSettings `json:"monitoring,omitempty"`
// snapshot
Snapshot *ClusterSnapshotSettings `json:"snapshot,omitempty"`
// The rulesets to apply to all resources in this cluster. When specified the same rulesets will be applied to Kibana and APM clusters as well
TrafficFilter *TrafficFilterSettings `json:"traffic_filter,omitempty"`
// Configuration of trust with other clusters
Trust *TrustSettings `json:"trust,omitempty"`
}
ElasticsearchClusterSettings The settings for an Elasticsearch cluster. swagger:model ElasticsearchClusterSettings
func (*ElasticsearchClusterSettings) MarshalBinary ¶
func (m *ElasticsearchClusterSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchClusterSettings) UnmarshalBinary ¶
func (m *ElasticsearchClusterSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchClusterTopologyElement ¶
type ElasticsearchClusterTopologyElement struct {
// DEPRECATED: Scheduled for removal in a future version of the API.
//
// Controls the allocation strategy of this node type using a simplified version of the Elasticsearch filter DSL (together with 'node_configuration')
AllocatorFilter interface{} `json:"allocator_filter,omitempty"`
// elasticsearch
Elasticsearch *ElasticsearchConfiguration `json:"elasticsearch,omitempty"`
// Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
InstanceConfigurationID string `json:"instance_configuration_id,omitempty"`
// The memory capacity in MB for each node of this type built in each zone.
MemoryPerNode int32 `json:"memory_per_node,omitempty"`
// DEPRECATED: Scheduled for removal in a future version of the API. Please use `instance_configuration_id`.
//
// Controls the allocation strategy of this node type by pointing to the names of pre-registered allocator settings. Unless otherwise specified for this deployment, only 'default' is supported (equivalent to omitting).
NodeConfiguration string `json:"node_configuration,omitempty"`
// The number of nodes of this type that are allocated within each zone. (i.e. total capacity per zone = `node_count_per_zone` * `memory_per_node` in MB). Cannot be set for tiebreaker topologies. For dedicated master nodes, must be 1 if an entry exists.
NodeCountPerZone int32 `json:"node_count_per_zone,omitempty"`
// node type
NodeType *ElasticsearchNodeType `json:"node_type,omitempty"`
// size
Size *TopologySize `json:"size,omitempty"`
// The default number of zones in which data nodes will be placed
ZoneCount int32 `json:"zone_count,omitempty"`
}
ElasticsearchClusterTopologyElement The topology of the Elasticsearch nodes, including the number, capacity, and type of nodes, and where they can be allocated. swagger:model ElasticsearchClusterTopologyElement
func (*ElasticsearchClusterTopologyElement) MarshalBinary ¶
func (m *ElasticsearchClusterTopologyElement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchClusterTopologyElement) UnmarshalBinary ¶
func (m *ElasticsearchClusterTopologyElement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchClusterUser ¶
type ElasticsearchClusterUser struct {
// The hashed password
// Required: true
PasswordHash *string `json:"password_hash"`
// The username
// Required: true
Username *string `json:"username"`
}
ElasticsearchClusterUser The information about an Elasticsearch cluster user. swagger:model ElasticsearchClusterUser
func (*ElasticsearchClusterUser) MarshalBinary ¶
func (m *ElasticsearchClusterUser) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchClusterUser) UnmarshalBinary ¶
func (m *ElasticsearchClusterUser) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchClustersInfo ¶
type ElasticsearchClustersInfo struct {
// elasticsearch clusters
// Required: true
ElasticsearchClusters []*ElasticsearchClusterInfo `json:"elasticsearch_clusters"`
// If a query is supplied, then the total number of clusters that matched
MatchCount int32 `json:"match_count,omitempty"`
// The number of clusters actually returned
// Required: true
ReturnCount *int32 `json:"return_count"`
}
ElasticsearchClustersInfo Information about a set of Elasticsearch clusters. swagger:model ElasticsearchClustersInfo
func (*ElasticsearchClustersInfo) MarshalBinary ¶
func (m *ElasticsearchClustersInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchClustersInfo) UnmarshalBinary ¶
func (m *ElasticsearchClustersInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchConfiguration ¶
type ElasticsearchConfiguration struct {
// Defines the index curation routing for the cluster
Curation *ElasticsearchCuration `json:"curation,omitempty"`
// A docker URI that allows overriding of the default docker image specified for this version
DockerImage string `json:"docker_image,omitempty"`
// A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
EnabledBuiltInPlugins []string `json:"enabled_built_in_plugins,omitempty"`
// Defines the Elasticsearch node attributes for the instances in the topology
NodeAttributes map[string]string `json:"node_attributes,omitempty"`
// system settings
SystemSettings *ElasticsearchSystemSettings `json:"system_settings,omitempty"`
// A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
UserBundles []*ElasticsearchUserBundle `json:"user_bundles,omitempty"`
// A list of admin-uploaded plugin objects that are available for this user.
UserPlugins []*ElasticsearchUserPlugin `json:"user_plugins,omitempty"`
// An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
UserSettingsJSON interface{} `json:"user_settings_json,omitempty"`
// An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
UserSettingsOverrideJSON interface{} `json:"user_settings_override_json,omitempty"`
// An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
UserSettingsOverrideYaml string `json:"user_settings_override_yaml,omitempty"`
// An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
UserSettingsYaml string `json:"user_settings_yaml,omitempty"`
// The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals)
Version string `json:"version,omitempty"`
}
ElasticsearchConfiguration The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings. swagger:model ElasticsearchConfiguration
func (*ElasticsearchConfiguration) MarshalBinary ¶
func (m *ElasticsearchConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchConfiguration) UnmarshalBinary ¶
func (m *ElasticsearchConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchCuration ¶
type ElasticsearchCuration struct {
// The source instance configuration
// Required: true
FromInstanceConfigurationID *string `json:"from_instance_configuration_id"`
// The destination instance configuration
// Required: true
ToInstanceConfigurationID *string `json:"to_instance_configuration_id"`
}
ElasticsearchCuration The structure that defines the routing settings for index curation. swagger:model ElasticsearchCuration
func (*ElasticsearchCuration) MarshalBinary ¶
func (m *ElasticsearchCuration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchCuration) UnmarshalBinary ¶
func (m *ElasticsearchCuration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchDependant ¶
type ElasticsearchDependant struct {
// The id of the orphaned resource
// Required: true
ID *string `json:"id"`
// The kind of resource
// Required: true
Kind *string `json:"kind"`
}
ElasticsearchDependant Details about an orphaned Elasticsearch-dependent resources. swagger:model ElasticsearchDependant
func (*ElasticsearchDependant) MarshalBinary ¶
func (m *ElasticsearchDependant) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchDependant) UnmarshalBinary ¶
func (m *ElasticsearchDependant) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchElasticUserPasswordResetResponse ¶
type ElasticsearchElasticUserPasswordResetResponse struct {
// The newly-reset password for the given Elasticsearch cluster
// Required: true
Password *string `json:"password"`
// The username for the newly-reset password for the given Elasticsearch cluster
// Required: true
Username *string `json:"username"`
}
ElasticsearchElasticUserPasswordResetResponse Envelope holding the newly-reset password for a cluster's user swagger:model ElasticsearchElasticUserPasswordResetResponse
func (*ElasticsearchElasticUserPasswordResetResponse) MarshalBinary ¶
func (m *ElasticsearchElasticUserPasswordResetResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchElasticUserPasswordResetResponse) UnmarshalBinary ¶
func (m *ElasticsearchElasticUserPasswordResetResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchInfo ¶
type ElasticsearchInfo struct {
// blocking issues
// Required: true
BlockingIssues *ElasticsearchClusterBlockingIssues `json:"blocking_issues"`
// Whether the Elasticsearch cluster is healthy (check the sub-objects for more details if not)
// Required: true
Healthy *bool `json:"healthy"`
// master info
// Required: true
MasterInfo *ElasticsearchMasterInfo `json:"master_info"`
// shard info
// Required: true
ShardInfo *ElasticsearchShardsInfo `json:"shard_info"`
}
ElasticsearchInfo Information about the Elasticsearch cluster. swagger:model ElasticsearchInfo
func (*ElasticsearchInfo) MarshalBinary ¶
func (m *ElasticsearchInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchInfo) UnmarshalBinary ¶
func (m *ElasticsearchInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchMasterElement ¶
type ElasticsearchMasterElement struct {
// The names of the instance/container hosting the node belong to the cluster with the given master
// Required: true
Instances []string `json:"instances"`
// The corresponding instance name of the container hosting the Elasticsearch master node, if available
MasterInstanceName string `json:"master_instance_name,omitempty"`
// The Elasticsearch node id of a master node
// Required: true
MasterNodeID *string `json:"master_node_id"`
}
ElasticsearchMasterElement Information about the Elasticsearch instances. For split-brain cases, this also includes sub-clusters. swagger:model ElasticsearchMasterElement
func (*ElasticsearchMasterElement) MarshalBinary ¶
func (m *ElasticsearchMasterElement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchMasterElement) UnmarshalBinary ¶
func (m *ElasticsearchMasterElement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchMasterInfo ¶
type ElasticsearchMasterInfo struct {
// Whether the master situation in the cluster is healthy (ie is the number of masters != 1), or do any instances have no master
// Required: true
Healthy *bool `json:"healthy"`
// A list of any instances with no master
// Required: true
InstancesWithNoMaster []string `json:"instances_with_no_master"`
// masters
// Required: true
Masters []*ElasticsearchMasterElement `json:"masters"`
}
ElasticsearchMasterInfo Information about the master nodes in the Elasticsearch cluster. swagger:model ElasticsearchMasterInfo
func (*ElasticsearchMasterInfo) MarshalBinary ¶
func (m *ElasticsearchMasterInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchMasterInfo) UnmarshalBinary ¶
func (m *ElasticsearchMasterInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchMonitoringInfo ¶
type ElasticsearchMonitoringInfo struct {
// The list of clusters Ids to which this cluster is currently sending monitoring data
// Required: true
DestinationClusterIds []string `json:"destination_cluster_ids"`
// Whether the Monitoring configuration has been successfully applied
// Required: true
Healthy *bool `json:"healthy"`
// The time the monitoring configuration was last changed
// Required: true
// Format: date-time
LastModified *strfmt.DateTime `json:"last_modified"`
// The status message from the last update (successful or not)
// Required: true
LastUpdateStatus *string `json:"last_update_status"`
// The list of clusters Ids from which this cluster is currently receiving monitoring data
// Required: true
SourceClusterIds []string `json:"source_cluster_ids"`
}
ElasticsearchMonitoringInfo Information about the monitoring status for the Elasticsearch cluster. swagger:model ElasticsearchMonitoringInfo
func (*ElasticsearchMonitoringInfo) MarshalBinary ¶
func (m *ElasticsearchMonitoringInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchMonitoringInfo) UnmarshalBinary ¶
func (m *ElasticsearchMonitoringInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchNodeType ¶
type ElasticsearchNodeType struct {
// Defines whether this node can hold data (default: true)
Data *bool `json:"data,omitempty"`
// Defines whether this node can run an ingest pipeline (default: true)
Ingest *bool `json:"ingest,omitempty"`
// Defines whether this node can be elected master (default: true)
Master *bool `json:"master,omitempty"`
// Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)
Ml *bool `json:"ml,omitempty"`
}
ElasticsearchNodeType Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies. swagger:model ElasticsearchNodeType
func (*ElasticsearchNodeType) MarshalBinary ¶
func (m *ElasticsearchNodeType) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchNodeType) UnmarshalBinary ¶
func (m *ElasticsearchNodeType) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchPayload ¶
type ElasticsearchPayload struct {
// The human readable name for the cluster (defaults to the generated cluster id if not specified)
DisplayName string `json:"display_name,omitempty"`
// The plan for building this Elasticsearch cluster
// Required: true
Plan *ElasticsearchClusterPlan `json:"plan"`
// A locally-unique user-specified id for this Elasticsearch cluster
// Required: true
RefID *string `json:"ref_id"`
// The region where this resource exists
// Required: true
Region *string `json:"region"`
// The settings for building this Elasticsearch cluster
Settings *ElasticsearchClusterSettings `json:"settings,omitempty"`
}
ElasticsearchPayload An alias for an Elasticsearch Cluster paired with a request for creating one swagger:model ElasticsearchPayload
func (*ElasticsearchPayload) MarshalBinary ¶
func (m *ElasticsearchPayload) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchPayload) UnmarshalBinary ¶
func (m *ElasticsearchPayload) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchPlanControlConfiguration ¶
type ElasticsearchPlanControlConfiguration struct {
// This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
CalmWaitTime int64 `json:"calm_wait_time,omitempty"`
// Set to 'forced' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting 'transient.plan_configuration.cluster_reboot': 'forced' will reboot the cluster)
// Enum: [forced]
ClusterReboot string `json:"cluster_reboot,omitempty"`
// If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
ExtendedMaintenance *bool `json:"extended_maintenance,omitempty"`
// When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300
MaxSnapshotAge int64 `json:"max_snapshot_age,omitempty"`
// If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)
MaxSnapshotAttempts int32 `json:"max_snapshot_attempts,omitempty"`
// move allocators
MoveAllocators []*AllocatorMoveRequest `json:"move_allocators"`
// move instances
MoveInstances []*InstanceMoveRequest `json:"move_instances"`
// If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored
MoveOnly *bool `json:"move_only,omitempty"`
// If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints
OverrideFailsafe *bool `json:"override_failsafe,omitempty"`
// List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
PreferredAllocators []string `json:"preferred_allocators"`
// If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
ReallocateInstances *bool `json:"reallocate_instances,omitempty"`
// If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)
SkipDataMigration *bool `json:"skip_data_migration,omitempty"`
// If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)
SkipPostUpgradeSteps *bool `json:"skip_post_upgrade_steps,omitempty"`
// If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster
SkipSnapshot *bool `json:"skip_snapshot,omitempty"`
// If false (the default), the cluster will perform a snapshot after a major version upgrade takes place
SkipSnapshotPostMajorUpgrade *bool `json:"skip_snapshot_post_major_upgrade,omitempty"`
// If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed
SkipUpgradeChecker *bool `json:"skip_upgrade_checker,omitempty"`
// The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.
Timeout int64 `json:"timeout,omitempty"`
}
ElasticsearchPlanControlConfiguration The configuration settings for the timeout and fallback parameters. swagger:model ElasticsearchPlanControlConfiguration
func (*ElasticsearchPlanControlConfiguration) MarshalBinary ¶
func (m *ElasticsearchPlanControlConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchPlanControlConfiguration) UnmarshalBinary ¶
func (m *ElasticsearchPlanControlConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchReplicaElement ¶
type ElasticsearchReplicaElement struct {
// The Elastic Cloud name/id of the instance (container)
// Required: true
InstanceName *string `json:"instance_name"`
// The number of unavailable replicas on this instance
// Required: true
ReplicaCount *int32 `json:"replica_count"`
}
ElasticsearchReplicaElement Information about the unavailable replicas. NOTE: Unlike shards, unavailable replicas indicate a loss of redundancy rather than a loss of availability. swagger:model ElasticsearchReplicaElement
func (*ElasticsearchReplicaElement) MarshalBinary ¶
func (m *ElasticsearchReplicaElement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchReplicaElement) UnmarshalBinary ¶
func (m *ElasticsearchReplicaElement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchResourceInfo ¶
type ElasticsearchResourceInfo struct {
// The randomly-generated id of a Resource
// Required: true
ID *string `json:"id"`
// Info for the resource.
// Required: true
Info *ElasticsearchClusterInfo `json:"info"`
// The locally-unique user-specified id of a Resource
// Required: true
RefID *string `json:"ref_id"`
// The region where this resource exists
// Required: true
Region *string `json:"region"`
}
ElasticsearchResourceInfo Describes an Elasticsearch resource belonging to a Deployment swagger:model ElasticsearchResourceInfo
func (*ElasticsearchResourceInfo) MarshalBinary ¶
func (m *ElasticsearchResourceInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchResourceInfo) UnmarshalBinary ¶
func (m *ElasticsearchResourceInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchScriptTypeSettings ¶
type ElasticsearchScriptTypeSettings struct {
// If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
Enabled *bool `json:"enabled,omitempty"`
// If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
SandboxMode *bool `json:"sandbox_mode,omitempty"`
}
ElasticsearchScriptTypeSettings Enables scripting for the specified type and controls other parameters. Store scripts in indexes (`stored`), upload in file bundles (`file`), or use in API requests (`inline`). swagger:model ElasticsearchScriptTypeSettings
func (*ElasticsearchScriptTypeSettings) MarshalBinary ¶
func (m *ElasticsearchScriptTypeSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchScriptTypeSettings) UnmarshalBinary ¶
func (m *ElasticsearchScriptTypeSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchScriptingUserSettings ¶
type ElasticsearchScriptingUserSettings struct {
// (5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
ExpressionsEnabled *bool `json:"expressions_enabled,omitempty"`
// file
File *ElasticsearchScriptTypeSettings `json:"file,omitempty"`
// inline
Inline *ElasticsearchScriptTypeSettings `json:"inline,omitempty"`
// (5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
MustacheEnabled *bool `json:"mustache_enabled,omitempty"`
// (5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
PainlessEnabled *bool `json:"painless_enabled,omitempty"`
// stored
Stored *ElasticsearchScriptTypeSettings `json:"stored,omitempty"`
}
ElasticsearchScriptingUserSettings Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON. swagger:model ElasticsearchScriptingUserSettings
func (*ElasticsearchScriptingUserSettings) MarshalBinary ¶
func (m *ElasticsearchScriptingUserSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchScriptingUserSettings) UnmarshalBinary ¶
func (m *ElasticsearchScriptingUserSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchShardElement ¶
type ElasticsearchShardElement struct {
// The Elastic Cloud name/id of the instance (container)
// Required: true
InstanceName *string `json:"instance_name"`
// The number of shards of the given type (available/unavailable) on this instance
// Required: true
ShardCount *int32 `json:"shard_count"`
}
ElasticsearchShardElement Information about the shards for each Elasticsearch instance container that hosts an Elasticsearch node. TIP: When the shard is unavailable, the cluster is unable to serve all of the data. swagger:model ElasticsearchShardElement
func (*ElasticsearchShardElement) MarshalBinary ¶
func (m *ElasticsearchShardElement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchShardElement) UnmarshalBinary ¶
func (m *ElasticsearchShardElement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchShardsInfo ¶
type ElasticsearchShardsInfo struct {
// available shards
// Required: true
AvailableShards []*ElasticsearchShardElement `json:"available_shards"`
// Whether the shard situation is healthy (any unavailable shards is unhealthy)
// Required: true
Healthy *bool `json:"healthy"`
// Required: true
UnavailableReplicas []*ElasticsearchReplicaElement `json:"unavailable_replicas"`
// Required: true
UnavailableShards []*ElasticsearchShardElement `json:"unavailable_shards"`
}
ElasticsearchShardsInfo Information about the shards and replicas that comprise the Elasticsearch indices. swagger:model ElasticsearchShardsInfo
func (*ElasticsearchShardsInfo) MarshalBinary ¶
func (m *ElasticsearchShardsInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchShardsInfo) UnmarshalBinary ¶
func (m *ElasticsearchShardsInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchSystemSettings ¶
type ElasticsearchSystemSettings struct {
// If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
AutoCreateIndex *bool `json:"auto_create_index,omitempty"`
// (2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
DefaultShardsPerIndex int32 `json:"default_shards_per_index,omitempty"`
// If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
DestructiveRequiresName *bool `json:"destructive_requires_name,omitempty"`
// Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
EnableCloseIndex *bool `json:"enable_close_index,omitempty"`
// The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
MonitoringCollectionInterval int32 `json:"monitoring_collection_interval,omitempty"`
// The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
MonitoringHistoryDuration string `json:"monitoring_history_duration,omitempty"`
// Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
ReindexWhitelist []string `json:"reindex_whitelist"`
// scripting
Scripting *ElasticsearchScriptingUserSettings `json:"scripting,omitempty"`
// Whether to factor in the available disk space on a node before deciding whether to allocate new shards to that node or actively relocate shards away from the node (default: true). NOTES: (Corresponds to the parameter 'cluster.routing.allocation.disk.threshold_enabled')
UseDiskThreshold *bool `json:"use_disk_threshold,omitempty"`
// The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
WatcherTriggerEngine string `json:"watcher_trigger_engine,omitempty"`
}
ElasticsearchSystemSettings A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use `ElasticsearchSystemSettings` with `user_settings_override*` and `user_settings*`. swagger:model ElasticsearchSystemSettings
func (*ElasticsearchSystemSettings) MarshalBinary ¶
func (m *ElasticsearchSystemSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchSystemSettings) UnmarshalBinary ¶
func (m *ElasticsearchSystemSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchUserBundle ¶
type ElasticsearchUserBundle struct {
// The supported Elasticsearch version (must match the version in the plan)
// Required: true
ElasticsearchVersion *string `json:"elasticsearch_version"`
// The name of the bundle
// Required: true
Name *string `json:"name"`
// The URL of the bundle (must be accessible from the ECE infrastructure)
// Required: true
URL *string `json:"url"`
}
ElasticsearchUserBundle A list of admin-uploaded bundle objects, such as scripts and synonym files. swagger:model ElasticsearchUserBundle
func (*ElasticsearchUserBundle) MarshalBinary ¶
func (m *ElasticsearchUserBundle) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchUserBundle) UnmarshalBinary ¶
func (m *ElasticsearchUserBundle) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElasticsearchUserPlugin ¶
type ElasticsearchUserPlugin struct {
// The supported Elasticsearch version (must match the version in the plan)
// Required: true
ElasticsearchVersion *string `json:"elasticsearch_version"`
// The name of the plugin
// Required: true
Name *string `json:"name"`
// The URL of the plugin (must be accessible from the ECE infrastructure)
// Required: true
URL *string `json:"url"`
}
ElasticsearchUserPlugin A list of admin-uploaded plugin objects. swagger:model ElasticsearchUserPlugin
func (*ElasticsearchUserPlugin) MarshalBinary ¶
func (m *ElasticsearchUserPlugin) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElasticsearchUserPlugin) UnmarshalBinary ¶
func (m *ElasticsearchUserPlugin) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElevatePermissionsRequest ¶
type ElevatePermissionsRequest struct {
// Multi-factor authorization token
// Required: true
Token *string `json:"token"`
}
ElevatePermissionsRequest The request body for elevated permissions. swagger:model ElevatePermissionsRequest
func (*ElevatePermissionsRequest) MarshalBinary ¶
func (m *ElevatePermissionsRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElevatePermissionsRequest) UnmarshalBinary ¶
func (m *ElevatePermissionsRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElevatedPermissions ¶
type ElevatedPermissions struct {
// True if the user has elevated permissions
// Required: true
Enabled *bool `json:"enabled"`
// The time at which the user's elevated permissions expire
// Format: date-time
ExpiresAt strfmt.DateTime `json:"expires_at,omitempty"`
}
ElevatedPermissions A user's elevated permissions status swagger:model ElevatedPermissions
func (*ElevatedPermissions) MarshalBinary ¶
func (m *ElevatedPermissions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElevatedPermissions) UnmarshalBinary ¶
func (m *ElevatedPermissions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EmptyResponse ¶
type EmptyResponse interface{}
EmptyResponse empty response swagger:model EmptyResponse
type EnableIlmRequest ¶
type EnableIlmRequest struct {
// A locally-unique user-specified id for Kibana
// Required: true
IndexPatterns []*IndexPattern `json:"index_patterns"`
}
EnableIlmRequest Request sent to enable ILM on a deployment. swagger:model EnableIlmRequest
func (*EnableIlmRequest) MarshalBinary ¶
func (m *EnableIlmRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnableIlmRequest) UnmarshalBinary ¶
func (m *EnableIlmRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnrollmentTokenRequest ¶
type EnrollmentTokenRequest struct {
// Whether this token can subsequently to its grant be revoked from the UI
// Required: true
Persistent *bool `json:"persistent"`
// The additional services for which this enrollment token applies (empty if not specified, ie system services only)
Roles []string `json:"roles"`
// The time in seconds for which this token is valid (defaults to 1 hour). Currently this can only be set for ephemeral (persistent: false) tokens.
ValidityInSeconds int32 `json:"validity_in_seconds,omitempty"`
}
EnrollmentTokenRequest An enrollment token request for one or more services. swagger:model EnrollmentTokenRequest
func (*EnrollmentTokenRequest) MarshalBinary ¶
func (m *EnrollmentTokenRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnrollmentTokenRequest) UnmarshalBinary ¶
func (m *EnrollmentTokenRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnterpriseSearch ¶
type EnterpriseSearch struct {
// The backend plan as JSON
// Required: true
BackendPlan interface{} `json:"backend_plan"`
// The human readable name (defaults to the generated cluster id if not specified)
// Required: true
DisplayName *string `json:"display_name"`
// The user-specified id of the Elasticsearch Cluster that this will link to
// Required: true
ElasticsearchClusterRefID *string `json:"elasticsearch_cluster_ref_id"`
// A locally-unique user-specified id
// Required: true
RefID *string `json:"ref_id"`
}
EnterpriseSearch Holds diagnostics for an Enterprise Search resource swagger:model EnterpriseSearch
func (*EnterpriseSearch) MarshalBinary ¶
func (m *EnterpriseSearch) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnterpriseSearch) UnmarshalBinary ¶
func (m *EnterpriseSearch) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnterpriseSearchConfiguration ¶
type EnterpriseSearchConfiguration struct {
// A docker URI that allows overriding of the default docker image specified for this version
DockerImage string `json:"docker_image,omitempty"`
// system settings
SystemSettings *EnterpriseSearchSystemSettings `json:"system_settings,omitempty"`
// An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)
UserSettingsJSON interface{} `json:"user_settings_json,omitempty"`
// An arbitrary JSON object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)
UserSettingsOverrideJSON interface{} `json:"user_settings_override_json,omitempty"`
// An arbitrary YAML object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)
UserSettingsOverrideYaml string `json:"user_settings_override_yaml,omitempty"`
// An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)
UserSettingsYaml string `json:"user_settings_yaml,omitempty"`
// The version of the Enterprise Search cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
Version string `json:"version,omitempty"`
}
EnterpriseSearchConfiguration enterprise search configuration swagger:model EnterpriseSearchConfiguration
func (*EnterpriseSearchConfiguration) MarshalBinary ¶
func (m *EnterpriseSearchConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnterpriseSearchConfiguration) UnmarshalBinary ¶
func (m *EnterpriseSearchConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnterpriseSearchInfo ¶
type EnterpriseSearchInfo struct {
// The id of the deployment that this Enterprise Search belongs to.
DeploymentID string `json:"deployment_id,omitempty"`
// elasticsearch cluster
// Required: true
ElasticsearchCluster *TargetElasticsearchCluster `json:"elasticsearch_cluster"`
// External resources related to the Enterprise Search
// Required: true
// Unique: true
ExternalLinks []*ExternalHyperlink `json:"external_links"`
// Whether the Enterprise Search is healthy or not (one or more of the info subsections will have healthy: false)
// Required: true
Healthy *bool `json:"healthy"`
// The id of the Enterprise Search
// Required: true
ID *string `json:"id"`
// A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Links map[string]Hyperlink `json:"links,omitempty"`
// metadata
Metadata *ClusterMetadataInfo `json:"metadata,omitempty"`
// The name of the Enterprise Search
// Required: true
Name *string `json:"name"`
// plan info
// Required: true
PlanInfo *EnterpriseSearchPlansInfo `json:"plan_info"`
// The region that this Enterprise Search belongs to. Only populated in SaaS or federated ECE.
Region string `json:"region,omitempty"`
// The cluster metadata settings for the Enterprise Search
Settings *EnterpriseSearchSettings `json:"settings,omitempty"`
// Enterprise Search status
// Required: true
// Enum: [initializing stopping stopped rebooting restarting reconfiguring started]
Status *string `json:"status"`
// topology
// Required: true
Topology *ClusterTopologyInfo `json:"topology"`
}
EnterpriseSearchInfo The overview information for the Enterprise Search Server. swagger:model EnterpriseSearchInfo
func (*EnterpriseSearchInfo) MarshalBinary ¶
func (m *EnterpriseSearchInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnterpriseSearchInfo) UnmarshalBinary ¶
func (m *EnterpriseSearchInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnterpriseSearchNodeTypes ¶
type EnterpriseSearchNodeTypes struct {
// Defines whether this instance should run as Application/API server
// Required: true
Appserver *bool `json:"appserver"`
// Defines whether this instance should run as Connector
// Required: true
Connector *bool `json:"connector"`
// Defines whether this instance should run as background worker
// Required: true
Worker *bool `json:"worker"`
}
EnterpriseSearchNodeTypes Node types to enable for an Enterprise Search instance swagger:model EnterpriseSearchNodeTypes
func (*EnterpriseSearchNodeTypes) MarshalBinary ¶
func (m *EnterpriseSearchNodeTypes) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnterpriseSearchNodeTypes) UnmarshalBinary ¶
func (m *EnterpriseSearchNodeTypes) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnterpriseSearchPayload ¶
type EnterpriseSearchPayload struct {
// The human readable name for the Enterprise Search cluster (default: takes the name of its Elasticsearch cluster)
DisplayName string `json:"display_name,omitempty"`
// Alias to the Elasticsearch Cluster to attach Enterprise Search to
// Required: true
ElasticsearchClusterRefID *string `json:"elasticsearch_cluster_ref_id"`
// plan
// Required: true
Plan *EnterpriseSearchPlan `json:"plan"`
// A locally-unique user-specified id for Enterprise Search
// Required: true
RefID *string `json:"ref_id"`
// The region where this resource exists
// Required: true
Region *string `json:"region"`
// The settings for building this Enterprise Search cluster
Settings *EnterpriseSearchSettings `json:"settings,omitempty"`
}
EnterpriseSearchPayload An Enterprise Search creation request paired with the alias of the Elasticsearch cluster it should be paired with swagger:model EnterpriseSearchPayload
func (*EnterpriseSearchPayload) MarshalBinary ¶
func (m *EnterpriseSearchPayload) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnterpriseSearchPayload) UnmarshalBinary ¶
func (m *EnterpriseSearchPayload) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnterpriseSearchPlan ¶
type EnterpriseSearchPlan struct {
// cluster topology
ClusterTopology []*EnterpriseSearchTopologyElement `json:"cluster_topology"`
// enterprise search
// Required: true
EnterpriseSearch *EnterpriseSearchConfiguration `json:"enterprise_search"`
// transient
Transient *TransientEnterpriseSearchPlanConfiguration `json:"transient,omitempty"`
}
EnterpriseSearchPlan enterprise search plan swagger:model EnterpriseSearchPlan
func (*EnterpriseSearchPlan) MarshalBinary ¶
func (m *EnterpriseSearchPlan) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnterpriseSearchPlan) UnmarshalBinary ¶
func (m *EnterpriseSearchPlan) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnterpriseSearchPlanControlConfiguration ¶
type EnterpriseSearchPlanControlConfiguration struct {
// This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
CalmWaitTime int64 `json:"calm_wait_time,omitempty"`
// Set to 'forced' to force a reboot as part of the upgrade plan
// Enum: [forced]
ClusterReboot string `json:"cluster_reboot,omitempty"`
// If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
ExtendedMaintenance *bool `json:"extended_maintenance,omitempty"`
// move allocators
MoveAllocators []*AllocatorMoveRequest `json:"move_allocators"`
// move instances
MoveInstances []*InstanceMoveRequest `json:"move_instances"`
// List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
PreferredAllocators []string `json:"preferred_allocators"`
// If true (default: false) does not allow re-using any existing instances currently in the cluster, i.e. even unchanged instances will be re-created
ReallocateInstances *bool `json:"reallocate_instances,omitempty"`
// The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
Timeout int64 `json:"timeout,omitempty"`
}
EnterpriseSearchPlanControlConfiguration enterprise search plan control configuration swagger:model EnterpriseSearchPlanControlConfiguration
func (*EnterpriseSearchPlanControlConfiguration) MarshalBinary ¶
func (m *EnterpriseSearchPlanControlConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnterpriseSearchPlanControlConfiguration) UnmarshalBinary ¶
func (m *EnterpriseSearchPlanControlConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnterpriseSearchPlanInfo ¶
type EnterpriseSearchPlanInfo struct {
// If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
// Format: date-time
AttemptEndTime strfmt.DateTime `json:"attempt_end_time,omitempty"`
// When this plan attempt (ie to apply the plan to the Enterprise Search) started (ISO format in UTC)
// Format: date-time
AttemptStartTime strfmt.DateTime `json:"attempt_start_time,omitempty"`
// Either the plan ended successfully, or is not yet completed (and no errors have occurred)
// Required: true
Healthy *bool `json:"healthy"`
// plan
Plan *EnterpriseSearchPlan `json:"plan,omitempty"`
// A UUID for each plan attempt
PlanAttemptID string `json:"plan_attempt_id,omitempty"`
// plan attempt log
// Required: true
PlanAttemptLog []*ClusterPlanStepInfo `json:"plan_attempt_log"`
// A human readable name for each plan attempt, only populated when retrieving plan histories
PlanAttemptName string `json:"plan_attempt_name,omitempty"`
// If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
// Format: date-time
PlanEndTime strfmt.DateTime `json:"plan_end_time,omitempty"`
// Information describing the source that facilitated the plans current state
Source *ChangeSourceInfo `json:"source,omitempty"`
}
EnterpriseSearchPlanInfo Information about the Enterprise Search Server plan. swagger:model EnterpriseSearchPlanInfo
func (*EnterpriseSearchPlanInfo) MarshalBinary ¶
func (m *EnterpriseSearchPlanInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnterpriseSearchPlanInfo) UnmarshalBinary ¶
func (m *EnterpriseSearchPlanInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnterpriseSearchPlansInfo ¶
type EnterpriseSearchPlansInfo struct {
// current
Current *EnterpriseSearchPlanInfo `json:"current,omitempty"`
// Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
// Required: true
Healthy *bool `json:"healthy"`
// history
// Required: true
History []*EnterpriseSearchPlanInfo `json:"history"`
// pending
Pending *EnterpriseSearchPlanInfo `json:"pending,omitempty"`
}
EnterpriseSearchPlansInfo Information about current, pending, and past Enterprise Search Server plans. swagger:model EnterpriseSearchPlansInfo
func (*EnterpriseSearchPlansInfo) MarshalBinary ¶
func (m *EnterpriseSearchPlansInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnterpriseSearchPlansInfo) UnmarshalBinary ¶
func (m *EnterpriseSearchPlansInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnterpriseSearchResourceInfo ¶
type EnterpriseSearchResourceInfo struct {
// The Elasticsearch cluster that this resource depends on.
// Required: true
ElasticsearchClusterRefID *string `json:"elasticsearch_cluster_ref_id"`
// The randomly-generated id of a Resource
// Required: true
ID *string `json:"id"`
// Info for the resource.
// Required: true
Info *EnterpriseSearchInfo `json:"info"`
// The locally-unique user-specified id of a Resource
// Required: true
RefID *string `json:"ref_id"`
// The region where this resource exists
// Required: true
Region *string `json:"region"`
}
EnterpriseSearchResourceInfo Describes an Enterprise Search resource belonging to a Deployment swagger:model EnterpriseSearchResourceInfo
func (*EnterpriseSearchResourceInfo) MarshalBinary ¶
func (m *EnterpriseSearchResourceInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnterpriseSearchResourceInfo) UnmarshalBinary ¶
func (m *EnterpriseSearchResourceInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnterpriseSearchSettings ¶
type EnterpriseSearchSettings struct {
// metadata
Metadata *ClusterMetadataSettings `json:"metadata,omitempty"`
}
EnterpriseSearchSettings The settings for the Enterprise Search. swagger:model EnterpriseSearchSettings
func (*EnterpriseSearchSettings) MarshalBinary ¶
func (m *EnterpriseSearchSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnterpriseSearchSettings) UnmarshalBinary ¶
func (m *EnterpriseSearchSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnterpriseSearchSubInfo ¶
type EnterpriseSearchSubInfo struct {
// Whether the associated Enterprise Search is currently available
// Required: true
Enabled *bool `json:"enabled"`
// The Enterprise Search Id
// Required: true
EnterpriseSearchID *string `json:"enterprise_search_id"`
// A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Links map[string]Hyperlink `json:"links,omitempty"`
}
EnterpriseSearchSubInfo Information about the APM Servers associated with the Elasticsearch cluster. swagger:model EnterpriseSearchSubInfo
func (*EnterpriseSearchSubInfo) MarshalBinary ¶
func (m *EnterpriseSearchSubInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnterpriseSearchSubInfo) UnmarshalBinary ¶
func (m *EnterpriseSearchSubInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnterpriseSearchSystemSettings ¶
type EnterpriseSearchSystemSettings struct {
// Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the username must also be specified)
ElasticsearchPassword string `json:"elasticsearch_password,omitempty"`
// Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
ElasticsearchURL string `json:"elasticsearch_url,omitempty"`
// Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the password must also be specified)
ElasticsearchUsername string `json:"elasticsearch_username,omitempty"`
// Optionally override the secret session key within Enterprise Search - defaults to the previously existing secretSession
SecretSessionKey string `json:"secret_session_key,omitempty"`
}
EnterpriseSearchSystemSettings This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of Enterprise Search settings) swagger:model EnterpriseSearchSystemSettings
func (*EnterpriseSearchSystemSettings) MarshalBinary ¶
func (m *EnterpriseSearchSystemSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnterpriseSearchSystemSettings) UnmarshalBinary ¶
func (m *EnterpriseSearchSystemSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnterpriseSearchTopologyElement ¶
type EnterpriseSearchTopologyElement struct {
// allocator filter
AllocatorFilter interface{} `json:"allocator_filter,omitempty"`
// enterprise search
EnterpriseSearch *EnterpriseSearchConfiguration `json:"enterprise_search,omitempty"`
// Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
InstanceConfigurationID string `json:"instance_configuration_id,omitempty"`
// memory per node
MemoryPerNode interface{} `json:"memory_per_node,omitempty"`
// node configuration
NodeConfiguration string `json:"node_configuration,omitempty"`
// node count per zone
NodeCountPerZone interface{} `json:"node_count_per_zone,omitempty"`
// Defines the EnterpriseSearch node type
NodeType *EnterpriseSearchNodeTypes `json:"node_type,omitempty"`
// size
Size *TopologySize `json:"size,omitempty"`
// number of zones in which nodes will be placed
ZoneCount int32 `json:"zone_count,omitempty"`
}
EnterpriseSearchTopologyElement Defines the topology of the Enterprise Search nodes (e.g. number/capacity of nodes, and where they can be allocated) swagger:model EnterpriseSearchTopologyElement
func (*EnterpriseSearchTopologyElement) MarshalBinary ¶
func (m *EnterpriseSearchTopologyElement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnterpriseSearchTopologyElement) UnmarshalBinary ¶
func (m *EnterpriseSearchTopologyElement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ExistsQuery ¶
type ExistsQuery struct {
// The field to check for non-null values in.
// Required: true
Field *string `json:"field"`
}
ExistsQuery Matches documents that have at least one non-`null` value in the original field. swagger:model ExistsQuery
func (*ExistsQuery) MarshalBinary ¶
func (m *ExistsQuery) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExistsQuery) UnmarshalBinary ¶
func (m *ExistsQuery) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Extension ¶
type Extension struct {
// The deployments using this extension.
Deployments []string `json:"deployments"`
// The extension description.
Description string `json:"description,omitempty"`
// The download URL specified during extension creation.
DownloadURL string `json:"download_url,omitempty"`
// The extension type.
// Required: true
// Enum: [plugin bundle]
ExtensionType *string `json:"extension_type"`
// The extension ID
// Required: true
ID *string `json:"id"`
// The extension name.
// Required: true
Name *string `json:"name"`
// The extension URL to be used in the plan.
// Required: true
URL *string `json:"url"`
// The Elasticsearch version.
// Required: true
Version *string `json:"version"`
}
Extension An API extension. It represents clusters' plugins and bundles swagger:model Extension
func (*Extension) MarshalBinary ¶
MarshalBinary interface implementation
func (*Extension) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Extensions ¶
type Extensions struct {
// The list of extensions.
// Required: true
Extensions []*Extension `json:"extensions"`
}
Extensions A collection of extensions swagger:model Extensions
func (*Extensions) MarshalBinary ¶
func (m *Extensions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Extensions) UnmarshalBinary ¶
func (m *Extensions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ExternalHyperlink ¶
type ExternalHyperlink struct {
// Identifier of the external link
// Required: true
ID *string `json:"id"`
// Human-readable description of the external link
// Required: true
Label *string `json:"label"`
// hyperlink to an external resource
URI string `json:"uri,omitempty"`
}
ExternalHyperlink external hyperlink swagger:model ExternalHyperlink
func (*ExternalHyperlink) MarshalBinary ¶
func (m *ExternalHyperlink) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExternalHyperlink) UnmarshalBinary ¶
func (m *ExternalHyperlink) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FilterAssociation ¶
type FilterAssociation struct {
// Type of the traffic filter ruleset association, such as 'deployment', 'cluster'
// Required: true
EntityType *string `json:"entity_type"`
// ID of the entity, such as the deployment ID or Elasticsearch cluster ID.
// Required: true
ID *string `json:"id"`
}
FilterAssociation The association with a ruleset or user auth token for a deployment, template, or product. swagger:model FilterAssociation
func (*FilterAssociation) MarshalBinary ¶
func (m *FilterAssociation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FilterAssociation) UnmarshalBinary ¶
func (m *FilterAssociation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GrowShrinkStrategyConfig ¶
type GrowShrinkStrategyConfig interface{}
GrowShrinkStrategyConfig A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. `GrowShrinkStrategyConfig` is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters. swagger:model GrowShrinkStrategyConfig
type Hyperlink ¶
type Hyperlink struct {
// Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).
NeedElevatedPermissions *bool `json:"need_elevated_permissions,omitempty"`
}
Hyperlink hyperlink swagger:model Hyperlink
func (*Hyperlink) MarshalBinary ¶
MarshalBinary interface implementation
func (*Hyperlink) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type IDResponse ¶
type IDResponse struct {
// The ID
// Required: true
ID *string `json:"id"`
}
IDResponse Id response swagger:model IdResponse
func (*IDResponse) MarshalBinary ¶
func (m *IDResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IDResponse) UnmarshalBinary ¶
func (m *IDResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IPFilterRule ¶
type IPFilterRule struct {
// Description of the rule
Description string `json:"description,omitempty"`
// The rule ID
ID string `json:"id,omitempty"`
// IPV4, IPV6 address or CIDR mask to define single or range of IPs
// Required: true
Source *string `json:"source"`
}
IPFilterRule The container for an IP filter rule. swagger:model IpFilterRule
func (*IPFilterRule) MarshalBinary ¶
func (m *IPFilterRule) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IPFilterRule) UnmarshalBinary ¶
func (m *IPFilterRule) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IPFilterRuleset ¶
type IPFilterRuleset struct {
// List of associations. Returned only when include_associations query parameter is true
Associations []*FilterAssociation `json:"associations"`
// Description of the ruleset
Description string `json:"description,omitempty"`
// The ruleset ID
ID string `json:"id,omitempty"`
// Name of the ruleset
// Required: true
Name *string `json:"name"`
// List of rules
// Required: true
Rules []*IPFilterRule `json:"rules"`
// Total number of associations. This includes associations the user does not have permission to view.Returned only when include_associations query parameter is true
TotalAssociations int32 `json:"total_associations,omitempty"`
}
IPFilterRuleset The container for a set of IP filter rules. swagger:model IpFilterRuleset
func (*IPFilterRuleset) MarshalBinary ¶
func (m *IPFilterRuleset) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IPFilterRuleset) UnmarshalBinary ¶
func (m *IPFilterRuleset) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IPFilterRulesets ¶
type IPFilterRulesets struct {
// List of rules
// Required: true
Rulesets []*IPFilterRuleset `json:"rulesets"`
}
IPFilterRulesets The container for a set of IP filter rulesets. swagger:model IpFilterRulesets
func (*IPFilterRulesets) MarshalBinary ¶
func (m *IPFilterRulesets) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IPFilterRulesets) UnmarshalBinary ¶
func (m *IPFilterRulesets) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IPFilteringSettings ¶
type IPFilteringSettings struct {
// IDs of the IP filter rulesets
// Required: true
Rulesets []string `json:"rulesets"`
}
IPFilteringSettings The configuration settings for IP filtering. swagger:model IpFilteringSettings
func (*IPFilteringSettings) MarshalBinary ¶
func (m *IPFilteringSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IPFilteringSettings) UnmarshalBinary ¶
func (m *IPFilteringSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IndexPattern ¶
type IndexPattern struct {
// Index pattern to which the ILM policy will be applied.
// Required: true
IndexPattern *string `json:"index_pattern"`
// Defines the Elasticsearch node attributes for the warm element of the topology
NodeAttributes map[string]string `json:"node_attributes,omitempty"`
// Name of the policy to create
// Required: true
PolicyName *string `json:"policy_name"`
}
IndexPattern An index pattern described indicating how it has to be migrated to ILM. swagger:model IndexPattern
func (*IndexPattern) MarshalBinary ¶
func (m *IndexPattern) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IndexPattern) UnmarshalBinary ¶
func (m *IndexPattern) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IndexSynchronizationResults ¶
type IndexSynchronizationResults struct {
// The ids of documents created in the index by index version
// Required: true
Created []string `json:"created"`
// The ids of documents deleted from the index by index version
// Required: true
Deleted []string `json:"deleted"`
// The ids of documents updated in the index by index version
// Required: true
Updated []string `json:"updated"`
}
IndexSynchronizationResults Results from synchronizing indices swagger:model IndexSynchronizationResults
func (*IndexSynchronizationResults) MarshalBinary ¶
func (m *IndexSynchronizationResults) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IndexSynchronizationResults) UnmarshalBinary ¶
func (m *IndexSynchronizationResults) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InstanceConfiguration ¶
type InstanceConfiguration struct {
// Optional filter to match allocators against
AllocatorFilter *QueryContainer `json:"allocator_filter,omitempty"`
// Date/time that this instance configuration was marked for deletion
// Format: date-time
DeletedOn *strfmt.DateTime `json:"deleted_on,omitempty"`
// Optional description for the instance configuration
Description string `json:"description,omitempty"`
// Numerics representing possible instance sizes that the instance configuration supports.
// Required: true
DiscreteSizes *DiscreteSizes `json:"discrete_sizes"`
// Unique identifier for the instance configuration
ID string `json:"id,omitempty"`
// The type of instance (elasticsearch, kibana)
// Required: true
InstanceType *string `json:"instance_type"`
// Optional arbitrary metadata to associate with this template.
Metadata interface{} `json:"metadata,omitempty"`
// Display name for the instance configuration.
// Required: true
Name *string `json:"name"`
// Node types (master, data) for the instance
NodeTypes []string `json:"node_types,omitempty"`
// Settings for the instance storage multiplier
StorageMultiplier float64 `json:"storage_multiplier,omitempty"`
// Indicates if a instance configuration is system owned (restricts the set of operations that can be performed on it)
SystemOwned *bool `json:"system_owned,omitempty"`
}
InstanceConfiguration The configuration template for Elasticsearch instances, Kibana instances, and APM Servers. swagger:model InstanceConfiguration
func (*InstanceConfiguration) MarshalBinary ¶
func (m *InstanceConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InstanceConfiguration) UnmarshalBinary ¶
func (m *InstanceConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InstanceConfigurationInfo ¶
type InstanceConfigurationInfo struct {
// Optional description for the instance configuration
Description string `json:"description,omitempty"`
// Numerics representing possible instance sizes that the instance configuration supports.
// Required: true
DiscreteSizes *DiscreteSizes `json:"discrete_sizes"`
// Unique identifier for the instance configuration
ID string `json:"id,omitempty"`
// The type of instance (elasticsearch, kibana)
// Required: true
InstanceType *string `json:"instance_type"`
// Display name for the instance configuration.
// Required: true
Name *string `json:"name"`
// Node types (master, data) for the instance
NodeTypes []string `json:"node_types"`
// Settings for the instance storage multiplier
StorageMultiplier float64 `json:"storage_multiplier,omitempty"`
}
InstanceConfigurationInfo The configuration template for Elasticsearch instances, Kibana instances, and APM Servers. swagger:model InstanceConfigurationInfo
func (*InstanceConfigurationInfo) MarshalBinary ¶
func (m *InstanceConfigurationInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InstanceConfigurationInfo) UnmarshalBinary ¶
func (m *InstanceConfigurationInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InstanceMoveRequest ¶
type InstanceMoveRequest struct {
// The instance id that is going to be moved
// Required: true
From *string `json:"from"`
// Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
InstanceDown *bool `json:"instance_down,omitempty"`
// An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
To []string `json:"to"`
}
InstanceMoveRequest The request that specifies the Elasticsearch instances, Kibana instances, and APM Servers to move to allocators as part of the upgrade plan. swagger:model InstanceMoveRequest
func (*InstanceMoveRequest) MarshalBinary ¶
func (m *InstanceMoveRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InstanceMoveRequest) UnmarshalBinary ¶
func (m *InstanceMoveRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InstanceTypeResource ¶
type InstanceTypeResource struct {
// Compatible versions
// Required: true
Compatibility []*CompatibleVersionResource `json:"compatibility"`
// Id of the default instance configuration to use for this instance type.
DefaultInstanceConfigurationID string `json:"default_instance_configuration_id,omitempty"`
// Instance type description
// Required: true
Description *string `json:"description"`
// Instance type, the key for this resource
// Required: true
InstanceType *string `json:"instance_type"`
// Instance type name
// Required: true
Name *string `json:"name"`
// Supported node types
// Required: true
NodeTypes []*NodeTypeResource `json:"node_types"`
}
InstanceTypeResource instance type resource swagger:model InstanceTypeResource
func (*InstanceTypeResource) MarshalBinary ¶
func (m *InstanceTypeResource) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InstanceTypeResource) UnmarshalBinary ¶
func (m *InstanceTypeResource) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KeystoreContents ¶
type KeystoreContents struct {
// List of secrets
// Required: true
Secrets map[string]KeystoreSecret `json:"secrets"`
}
KeystoreContents The contents of the Elasticsearch keystore. swagger:model KeystoreContents
func (*KeystoreContents) MarshalBinary ¶
func (m *KeystoreContents) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KeystoreContents) UnmarshalBinary ¶
func (m *KeystoreContents) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KeystoreSecret ¶
type KeystoreSecret struct {
// Stores the keystore secret as a file. The default is false, which stores the keystore secret as string when value is a plain string, or true when value is an object.
AsFile *bool `json:"as_file,omitempty"`
// Value of this setting. This can either be a string or a JSON object that is stored as a JSON string in the keystore. NOTE: When the keystore secret is unspecified, it is removed.
Value interface{} `json:"value,omitempty"`
}
KeystoreSecret The value that you configure for the Elasticsearch keystore secret. swagger:model KeystoreSecret
func (*KeystoreSecret) MarshalBinary ¶
func (m *KeystoreSecret) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KeystoreSecret) UnmarshalBinary ¶
func (m *KeystoreSecret) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Kibana ¶
type Kibana struct {
// The backend plan as JSON
// Required: true
BackendPlan interface{} `json:"backend_plan"`
// The human readable name (defaults to the generated cluster id if not specified)
// Required: true
DisplayName *string `json:"display_name"`
// The user-specified id of the Elasticsearch Cluster that this will link to
// Required: true
ElasticsearchClusterRefID *string `json:"elasticsearch_cluster_ref_id"`
// A locally-unique user-specified id
// Required: true
RefID *string `json:"ref_id"`
}
Kibana Holds diagnostics for a Kibana resource swagger:model Kibana
func (*Kibana) MarshalBinary ¶
MarshalBinary interface implementation
func (*Kibana) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type KibanaClusterInfo ¶
type KibanaClusterInfo struct {
// The id of the cluster
// Required: true
ClusterID *string `json:"cluster_id"`
// The name of the cluster
// Required: true
ClusterName *string `json:"cluster_name"`
// The id of the deployment to which this Kibana Server belongs to.
DeploymentID string `json:"deployment_id,omitempty"`
// elasticsearch cluster
// Required: true
ElasticsearchCluster *TargetElasticsearchCluster `json:"elasticsearch_cluster"`
// External resources related to the cluster
// Required: true
// Unique: true
ExternalLinks []*ExternalHyperlink `json:"external_links"`
// Whether the cluster is healthy or not (one or more of the info subsections will have healthy: false)
// Required: true
Healthy *bool `json:"healthy"`
// A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Links map[string]Hyperlink `json:"links,omitempty"`
// metadata
// Required: true
Metadata *ClusterMetadataInfo `json:"metadata"`
// plan info
// Required: true
PlanInfo *KibanaClusterPlansInfo `json:"plan_info"`
// The region that this cluster belongs to. Only populated in SaaS or federated ECE.
Region string `json:"region,omitempty"`
// The cluster metadata settings for a kibana cluster
Settings *KibanaClusterSettings `json:"settings,omitempty"`
// Cluster status
// Required: true
// Enum: [initializing stopping stopped rebooting restarting reconfiguring started]
Status *string `json:"status"`
// topology
// Required: true
Topology *ClusterTopologyInfo `json:"topology"`
}
KibanaClusterInfo The top-level object information for a Kibana instance. swagger:model KibanaClusterInfo
func (*KibanaClusterInfo) MarshalBinary ¶
func (m *KibanaClusterInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KibanaClusterInfo) UnmarshalBinary ¶
func (m *KibanaClusterInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KibanaClusterPlan ¶
type KibanaClusterPlan struct {
// cluster topology
ClusterTopology []*KibanaClusterTopologyElement `json:"cluster_topology"`
// kibana
// Required: true
Kibana *KibanaConfiguration `json:"kibana"`
// transient
Transient *TransientKibanaPlanConfiguration `json:"transient,omitempty"`
// DEPRECATED: Scheduled for removal in a future version of the API. Please use `cluster_topology.zone_count` instead.
//
// The number of zones in which data nodes will be placed, if not specified in the per topology settings
ZoneCount int32 `json:"zone_count,omitempty"`
}
KibanaClusterPlan The plan for the Kibana instance. swagger:model KibanaClusterPlan
func (*KibanaClusterPlan) MarshalBinary ¶
func (m *KibanaClusterPlan) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KibanaClusterPlan) UnmarshalBinary ¶
func (m *KibanaClusterPlan) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KibanaClusterPlanInfo ¶
type KibanaClusterPlanInfo struct {
// If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
// Format: date-time
AttemptEndTime strfmt.DateTime `json:"attempt_end_time,omitempty"`
// When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)
// Format: date-time
AttemptStartTime strfmt.DateTime `json:"attempt_start_time,omitempty"`
// Either the plan ended successfully, or is not yet completed (and no errors have occurred)
// Required: true
Healthy *bool `json:"healthy"`
// plan
Plan *KibanaClusterPlan `json:"plan,omitempty"`
// A UUID for each plan attempt
PlanAttemptID string `json:"plan_attempt_id,omitempty"`
// plan attempt log
// Required: true
PlanAttemptLog []*ClusterPlanStepInfo `json:"plan_attempt_log"`
// A human readable name for each plan attempt, only populated when retrieving plan histories
PlanAttemptName string `json:"plan_attempt_name,omitempty"`
// If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
// Format: date-time
PlanEndTime strfmt.DateTime `json:"plan_end_time,omitempty"`
// Information describing the source that facilitated the plans current state
Source *ChangeSourceInfo `json:"source,omitempty"`
}
KibanaClusterPlanInfo Information about the current, pending, or past Kibana instance plan. swagger:model KibanaClusterPlanInfo
func (*KibanaClusterPlanInfo) MarshalBinary ¶
func (m *KibanaClusterPlanInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KibanaClusterPlanInfo) UnmarshalBinary ¶
func (m *KibanaClusterPlanInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KibanaClusterPlansInfo ¶
type KibanaClusterPlansInfo struct {
// current
Current *KibanaClusterPlanInfo `json:"current,omitempty"`
// Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
// Required: true
Healthy *bool `json:"healthy"`
// history
// Required: true
History []*KibanaClusterPlanInfo `json:"history"`
// pending
Pending *KibanaClusterPlanInfo `json:"pending,omitempty"`
}
KibanaClusterPlansInfo Information about the current, pending, or past Kibana instance plans. swagger:model KibanaClusterPlansInfo
func (*KibanaClusterPlansInfo) MarshalBinary ¶
func (m *KibanaClusterPlansInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KibanaClusterPlansInfo) UnmarshalBinary ¶
func (m *KibanaClusterPlansInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KibanaClusterSettings ¶
type KibanaClusterSettings struct {
// metadata
Metadata *ClusterMetadataSettings `json:"metadata,omitempty"`
}
KibanaClusterSettings The settings for multiple Kibana instances. swagger:model KibanaClusterSettings
func (*KibanaClusterSettings) MarshalBinary ¶
func (m *KibanaClusterSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KibanaClusterSettings) UnmarshalBinary ¶
func (m *KibanaClusterSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KibanaClusterTopologyElement ¶
type KibanaClusterTopologyElement struct {
// DEPRECATED: Scheduled for removal in a future version of the API.
//
// Controls the allocation strategy of this node type using a simplified version of the Elasticsearch filter DSL (together with 'node_configuration')
AllocatorFilter interface{} `json:"allocator_filter,omitempty"`
// Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
InstanceConfigurationID string `json:"instance_configuration_id,omitempty"`
// kibana
Kibana *KibanaConfiguration `json:"kibana,omitempty"`
// The memory capacity in MB for each node of this type built in each zone.
MemoryPerNode int32 `json:"memory_per_node,omitempty"`
// DEPRECATED: Scheduled for removal in a future version of the API.
//
// Controls the allocation strategy of this node type by pointing to the names of pre-registered allocator settings. Unless otherwise specified for this deployment, should be omitted.
NodeConfiguration string `json:"node_configuration,omitempty"`
// The number of nodes of this type that are allocated within each zone (i.e. total capacity per zone = `node_count_per_zone` * `memory_per_node` in MB).
NodeCountPerZone int32 `json:"node_count_per_zone,omitempty"`
// size
Size *TopologySize `json:"size,omitempty"`
// number of zones in which nodes will be placed
ZoneCount int32 `json:"zone_count,omitempty"`
}
KibanaClusterTopologyElement The topology of the Kibana nodes, including the number, capacity, and type of nodes, and where they can be allocated. swagger:model KibanaClusterTopologyElement
func (*KibanaClusterTopologyElement) MarshalBinary ¶
func (m *KibanaClusterTopologyElement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KibanaClusterTopologyElement) UnmarshalBinary ¶
func (m *KibanaClusterTopologyElement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KibanaClustersInfo ¶
type KibanaClustersInfo struct {
// kibana clusters
// Required: true
KibanaClusters []*KibanaClusterInfo `json:"kibana_clusters"`
// If a query is supplied, then the total number of clusters that matched
MatchCount int32 `json:"match_count,omitempty"`
// The number of clusters actually returned
// Required: true
ReturnCount *int32 `json:"return_count"`
}
KibanaClustersInfo Information about a set of Kibana instances. swagger:model KibanaClustersInfo
func (*KibanaClustersInfo) MarshalBinary ¶
func (m *KibanaClustersInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KibanaClustersInfo) UnmarshalBinary ¶
func (m *KibanaClustersInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KibanaConfiguration ¶
type KibanaConfiguration struct {
// A docker URI that allows overriding of the default docker image specified for this version
DockerImage string `json:"docker_image,omitempty"`
// system settings
SystemSettings *KibanaSystemSettings `json:"system_settings,omitempty"`
// An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
UserSettingsJSON interface{} `json:"user_settings_json,omitempty"`
// An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
UserSettingsOverrideJSON interface{} `json:"user_settings_override_json,omitempty"`
// An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
UserSettingsOverrideYaml string `json:"user_settings_override_yaml,omitempty"`
// An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
UserSettingsYaml string `json:"user_settings_yaml,omitempty"`
// The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)
Version string `json:"version,omitempty"`
}
KibanaConfiguration The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings. swagger:model KibanaConfiguration
func (*KibanaConfiguration) MarshalBinary ¶
func (m *KibanaConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KibanaConfiguration) UnmarshalBinary ¶
func (m *KibanaConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KibanaPayload ¶
type KibanaPayload struct {
// The human readable name for the Kibana cluster (default: takes the name of its Elasticsearch cluster)
DisplayName string `json:"display_name,omitempty"`
// Alias to the Elasticsearch Cluster to attach Kibana to
// Required: true
ElasticsearchClusterRefID *string `json:"elasticsearch_cluster_ref_id"`
// plan
// Required: true
Plan *KibanaClusterPlan `json:"plan"`
// A locally-unique user-specified id for Kibana
// Required: true
RefID *string `json:"ref_id"`
// The region where this resource exists
// Required: true
Region *string `json:"region"`
// The settings for building this Kibana cluster
Settings *KibanaClusterSettings `json:"settings,omitempty"`
}
KibanaPayload A Kibana creation request paired with the alias of the Elasticsearch cluster it should be paired with swagger:model KibanaPayload
func (*KibanaPayload) MarshalBinary ¶
func (m *KibanaPayload) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KibanaPayload) UnmarshalBinary ¶
func (m *KibanaPayload) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KibanaPlanControlConfiguration ¶
type KibanaPlanControlConfiguration struct {
// This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
CalmWaitTime int64 `json:"calm_wait_time,omitempty"`
// Set to 'forced' to force a reboot as part of the upgrade plan
// Enum: [forced]
ClusterReboot string `json:"cluster_reboot,omitempty"`
// If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
ExtendedMaintenance *bool `json:"extended_maintenance,omitempty"`
// move allocators
MoveAllocators []*AllocatorMoveRequest `json:"move_allocators"`
// move instances
MoveInstances []*InstanceMoveRequest `json:"move_instances"`
// List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
PreferredAllocators []string `json:"preferred_allocators"`
// If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
ReallocateInstances *bool `json:"reallocate_instances,omitempty"`
// The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
Timeout int64 `json:"timeout,omitempty"`
}
KibanaPlanControlConfiguration The configuration settings for the timeout and fallback parameters. swagger:model KibanaPlanControlConfiguration
func (*KibanaPlanControlConfiguration) MarshalBinary ¶
func (m *KibanaPlanControlConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KibanaPlanControlConfiguration) UnmarshalBinary ¶
func (m *KibanaPlanControlConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KibanaResourceInfo ¶
type KibanaResourceInfo struct {
// The Elasticsearch cluster that this resource depends on.
// Required: true
ElasticsearchClusterRefID *string `json:"elasticsearch_cluster_ref_id"`
// The randomly-generated id of a Resource
// Required: true
ID *string `json:"id"`
// Info for the resource.
// Required: true
Info *KibanaClusterInfo `json:"info"`
// The locally-unique user-specified id of a Resource
// Required: true
RefID *string `json:"ref_id"`
// The region where this resource exists
// Required: true
Region *string `json:"region"`
}
KibanaResourceInfo Describes an Kibana resource belonging to a Deployment swagger:model KibanaResourceInfo
func (*KibanaResourceInfo) MarshalBinary ¶
func (m *KibanaResourceInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KibanaResourceInfo) UnmarshalBinary ¶
func (m *KibanaResourceInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KibanaSubClusterInfo ¶
type KibanaSubClusterInfo struct {
// Whether the associated Kibana cluster is currently available
// Required: true
Enabled *bool `json:"enabled"`
// The Kibana cluster Id
// Required: true
KibanaID *string `json:"kibana_id"`
// A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Links map[string]Hyperlink `json:"links,omitempty"`
}
KibanaSubClusterInfo Information about the Kibana instances associated with the Elasticsearch cluster. swagger:model KibanaSubClusterInfo
func (*KibanaSubClusterInfo) MarshalBinary ¶
func (m *KibanaSubClusterInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KibanaSubClusterInfo) UnmarshalBinary ¶
func (m *KibanaSubClusterInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type KibanaSystemSettings ¶
type KibanaSystemSettings struct {
// Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified)
ElasticsearchPassword string `json:"elasticsearch_password,omitempty"`
// Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
ElasticsearchURL string `json:"elasticsearch_url,omitempty"`
// Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified)
ElasticsearchUsername string `json:"elasticsearch_username,omitempty"`
}
KibanaSystemSettings A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use `KibanaSystemSettings` with `user_settings_override_` and `user_settings_`. swagger:model KibanaSystemSettings
func (*KibanaSystemSettings) MarshalBinary ¶
func (m *KibanaSystemSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*KibanaSystemSettings) UnmarshalBinary ¶
func (m *KibanaSystemSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LdapGroupSearch ¶
type LdapGroupSearch struct {
// Specifies a container DN to search for groups in which the user has membership
BaseDn string `json:"base_dn,omitempty"`
// Specifies a filter to search for a group. When unspecified, the security realm searches for group, groupOfNames, groupOfUniqueNames, or posixGroup with the attributes member, memberOf, or memberUid. Any instance of {0} in the filter is replaced by the user attribute defined in user_attribute.
Filter string `json:"filter,omitempty"`
// Specifies whether the group search should be sub_tree, one_level or base. one_level only searches objects directly contained within the base_dn. The default sub_tree searches all objects contained under base_dn. base specifies that the base_dn is a group object, and that it is the only group considered.
// Enum: [sub_tree one_level base]
Scope string `json:"scope,omitempty"`
// Specifies the user attribute that is fetched and provided as a parameter to the filter. When unspecified, the user DN is passed to the filter.
UserAttribute string `json:"user_attribute,omitempty"`
}
LdapGroupSearch The group search configuration for the Elasticsearch security LDAP realm. swagger:model LdapGroupSearch
func (*LdapGroupSearch) MarshalBinary ¶
func (m *LdapGroupSearch) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LdapGroupSearch) UnmarshalBinary ¶
func (m *LdapGroupSearch) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LdapSecurityRealmLoadBalance ¶
type LdapSecurityRealmLoadBalance struct {
// When using dns_failover or dns_round_robin as the load balancing type, this setting controls the amount of time to cache DNS lookups. Defaults to 1h.
CacheTTL string `json:"cache_ttl,omitempty"`
// The behavior to use when there are multiple LDAP URLs defined
// Enum: [failover dns_failover round_robin dns_round_robin]
Type string `json:"type,omitempty"`
}
LdapSecurityRealmLoadBalance The load balancing configuration for the Elasticsearch security LDAP realm. swagger:model LdapSecurityRealmLoadBalance
func (*LdapSecurityRealmLoadBalance) MarshalBinary ¶
func (m *LdapSecurityRealmLoadBalance) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LdapSecurityRealmLoadBalance) UnmarshalBinary ¶
func (m *LdapSecurityRealmLoadBalance) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LdapSecurityRealmRoleMappingRule ¶
type LdapSecurityRealmRoleMappingRule struct {
// The roles that are applied when the mapping rule is successfully evaluated
// Required: true
Roles []string `json:"roles"`
// The type of role mapping rule
// Required: true
// Enum: [user_dn group_dn]
Type *string `json:"type"`
// The value to match when evaluating this rule
// Required: true
Value *string `json:"value"`
}
LdapSecurityRealmRoleMappingRule The role mapping rule for the Elasticsearch security LDAP realm. swagger:model LdapSecurityRealmRoleMappingRule
func (*LdapSecurityRealmRoleMappingRule) MarshalBinary ¶
func (m *LdapSecurityRealmRoleMappingRule) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LdapSecurityRealmRoleMappingRule) UnmarshalBinary ¶
func (m *LdapSecurityRealmRoleMappingRule) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LdapSecurityRealmRoleMappingRules ¶
type LdapSecurityRealmRoleMappingRules struct {
// The default roles applied to all users
// Required: true
DefaultRoles []string `json:"default_roles"`
// The role mapping rules to evaluate
// Required: true
Rules []*LdapSecurityRealmRoleMappingRule `json:"rules"`
}
LdapSecurityRealmRoleMappingRules The role mapping ruleset for the Elasticsearch security LDAP realm. swagger:model LdapSecurityRealmRoleMappingRules
func (*LdapSecurityRealmRoleMappingRules) MarshalBinary ¶
func (m *LdapSecurityRealmRoleMappingRules) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LdapSecurityRealmRoleMappingRules) UnmarshalBinary ¶
func (m *LdapSecurityRealmRoleMappingRules) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LdapSettings ¶
type LdapSettings struct {
// When true, bindDb credentials are ignored
// Required: true
BindAnonymously *bool `json:"bind_anonymously"`
// The distinguished name of the user that is used to bind to the LDAP and perform searches. Only used when bind_type is set to 'user_search'.
BindDn string `json:"bind_dn,omitempty"`
// The user password that is used to bind to the LDAP server. Only used when bind_type is set to 'user_search'.
BindPassword string `json:"bind_password,omitempty"`
// The type of user binding to apply
// Required: true
// Enum: [user_search user_templates]
BindType *string `json:"bind_type"`
// The SSL trusted CA certificate bundle URL. The bundle should be a zip file containing a single keystore file 'keystore.ks' in the directory '/ldap/:id/truststore', where :id is the value of the [id] field.
CertificateURL string `json:"certificate_url,omitempty"`
// The password to the certificate bundle URL truststore
CertificateURLTruststorePassword string `json:"certificate_url_truststore_password,omitempty"`
// The format of the keystore file. Should be jks to use the Java Keystore format or PKCS12 to use PKCS#12 files. The default is jks.
// Enum: [jks PKCS12]
CertificateURLTruststoreType string `json:"certificate_url_truststore_type,omitempty"`
// When true, enables the security realm
Enabled *bool `json:"enabled,omitempty"`
// The LDAP group search configuration
GroupSearch *LdapGroupSearch `json:"group_search,omitempty"`
// The identifier for the security realm
// Required: true
ID *string `json:"id"`
// The LDAP load balancing behavior
LoadBalance *LdapSecurityRealmLoadBalance `json:"load_balance,omitempty"`
// The friendly name of the security realm
// Required: true
Name *string `json:"name"`
// The order that the security realm is evaluated
Order int32 `json:"order,omitempty"`
// Advanced configuration options in YAML format. Any settings defined here will override any configuration set via the API. Note that all keys should omit the 'xpack.security.authc.realms.ldap.{realm_id}' prefix. For example, when the realm ID is set to 'ldap1', the advanced configuration 'xpack.security.authc.realms.ldap.ldap1.ssl.verification_mode: full' should be added as 'ssl.verification_mode: full'.
OverrideYaml string `json:"override_yaml,omitempty"`
// The role mapping rules associated with the security realm
RoleMappings *LdapSecurityRealmRoleMappingRules `json:"role_mappings,omitempty"`
// The LDAP URLs used to authenticate against, in the format ldap[s]://server:port. Note that ldap and ldaps protocols cannot be mixed together.
// Required: true
Urls []string `json:"urls"`
// The distinguished name template that replaces the user name with the string {0}. Only used when bind_type is set to 'user_templates'.
UserDnTemplates []string `json:"user_dn_templates"`
// Specifies the attribute to examine on the user for group membership. If any 'group_search' settings are specified, this setting is ignored. Defaults to 'memberOf'.
UserGroupAttribute string `json:"user_group_attribute,omitempty"`
// The LDAP user search configuration. Only used when bind_type is set to 'user_search'.
UserSearch *LdapUserSearch `json:"user_search,omitempty"`
}
LdapSettings The configuration for the Elasticsearch security LDAP realm. swagger:model LdapSettings
func (*LdapSettings) MarshalBinary ¶
func (m *LdapSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LdapSettings) UnmarshalBinary ¶
func (m *LdapSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LdapUserSearch ¶
type LdapUserSearch struct {
// Specifies a container DN to search for users
BaseDn string `json:"base_dn,omitempty"`
// Specifies the filter to search the directory and match an entry with the username provided by the user. Defaults to (uid={0}). {0} is substituted with the username provided when searching.
Filter string `json:"filter,omitempty"`
// The scope of the user search. Valid values are sub_tree, one_level, or base. one_level only searches objects directly contained in the base_dn. sub_tree searches all objects contained in base_dn. base specifies that the base_dn is the user object, and that it is the only user considered. Defaults to sub_tree.
// Enum: [sub_tree one_level base]
Scope string `json:"scope,omitempty"`
}
LdapUserSearch The user search configuration for the Elasticsearch security LDAP realm. swagger:model LdapUserSearch
func (*LdapUserSearch) MarshalBinary ¶
func (m *LdapUserSearch) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LdapUserSearch) UnmarshalBinary ¶
func (m *LdapUserSearch) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LegacySecuritySettings ¶
type LegacySecuritySettings struct {
// The 'roles' YAML Shield definition
RolesYaml string `json:"roles_yaml,omitempty"`
// The 'users_roles' YAML Shield definition
UsersRolesYaml string `json:"users_roles_yaml,omitempty"`
// The 'users' YAML Shield definition
UsersYaml string `json:"users_yaml,omitempty"`
}
LegacySecuritySettings legacy security settings swagger:model LegacySecuritySettings
func (*LegacySecuritySettings) MarshalBinary ¶
func (m *LegacySecuritySettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LegacySecuritySettings) UnmarshalBinary ¶
func (m *LegacySecuritySettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LicenseInfo ¶
type LicenseInfo struct {
// List of cluster licenses
ClusterLicenses []*ClusterLicenseInfo `json:"cluster_licenses"`
// When the license expires, in milliseconds since the Unix epoch
// Required: true
ExpiryDateInMillis *int64 `json:"expiry_date_in_millis"`
// When the license was issued, in milliseconds since the Unix epoch
// Required: true
IssueDateInMillis *int64 `json:"issue_date_in_millis"`
// Entity the license was issued to
// Required: true
IssuedTo *string `json:"issued_to"`
// Issuer of the license
// Required: true
Issuer *string `json:"issuer"`
// Maximum number of allocators. Empty for version >= 3
MaxAllocators int32 `json:"max_allocators,omitempty"`
// Maximum number of instances. Only present for version 3
MaxInstances int32 `json:"max_instances,omitempty"`
// Maximum RAM per allocator in MB. Empty for version >= 3
MaxRAMPerAllocatorMb int32 `json:"max_ram_per_allocator_mb,omitempty"`
// Maximum number of resource units, where each unit is 64GB. Only present for version > 3
MaxResourceUnits int32 `json:"max_resource_units,omitempty"`
// Operation mode
OperationMode string `json:"operation_mode,omitempty"`
// Digital signature
// Required: true
Signature *string `json:"signature"`
// Initial validity of the license, in milliseconds since the Unix epoch
// Required: true
StartDateInMillis *int64 `json:"start_date_in_millis"`
// Type of the license subscription
SubscriptionType string `json:"subscription_type,omitempty"`
// Type of the license
// Required: true
Type *string `json:"type"`
// Unique identifier of the license
// Required: true
UID *string `json:"uid"`
// Version of the license
Version int32 `json:"version,omitempty"`
}
LicenseInfo Information about a license. swagger:model LicenseInfo
func (*LicenseInfo) MarshalBinary ¶
func (m *LicenseInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LicenseInfo) UnmarshalBinary ¶
func (m *LicenseInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LicenseObject ¶
type LicenseObject struct {
// License data
// Required: true
License *LicenseInfo `json:"license"`
// Information about current usage.
// Read Only: true
UsageStats *UsageStats `json:"usage_stats,omitempty"`
}
LicenseObject The container for a license. swagger:model LicenseObject
func (*LicenseObject) MarshalBinary ¶
func (m *LicenseObject) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LicenseObject) UnmarshalBinary ¶
func (m *LicenseObject) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ListEnrollmentTokenElement ¶
type ListEnrollmentTokenElement struct {
// The services for which this enrollment token applies
// Required: true
Roles []string `json:"roles"`
// An identifier for the token
// Required: true
TokenID *string `json:"token_id"`
}
ListEnrollmentTokenElement Information about an active enrollment token. swagger:model ListEnrollmentTokenElement
func (*ListEnrollmentTokenElement) MarshalBinary ¶
func (m *ListEnrollmentTokenElement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ListEnrollmentTokenElement) UnmarshalBinary ¶
func (m *ListEnrollmentTokenElement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ListEnrollmentTokenReply ¶
type ListEnrollmentTokenReply struct {
// The list of currently active enrollment tokens
// Required: true
Tokens []*ListEnrollmentTokenElement `json:"tokens"`
}
ListEnrollmentTokenReply Information about active enrollment tokens. swagger:model ListEnrollmentTokenReply
func (*ListEnrollmentTokenReply) MarshalBinary ¶
func (m *ListEnrollmentTokenReply) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ListEnrollmentTokenReply) UnmarshalBinary ¶
func (m *ListEnrollmentTokenReply) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LoggingSettings ¶
type LoggingSettings struct {
// Overridden logging levels. Keys are logging levels. Allowable values are OFF, ERROR, WARN, INFO, DEBUG, TRACE, ALL
// Required: true
LoggingLevels map[string]string `json:"logging_levels"`
}
LoggingSettings Information about logging settings. swagger:model LoggingSettings
func (*LoggingSettings) MarshalBinary ¶
func (m *LoggingSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LoggingSettings) UnmarshalBinary ¶
func (m *LoggingSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LoginRequest ¶
type LoginRequest struct {
// login state
LoginState *LoginState `json:"login_state,omitempty"`
// The plain text password part of the login request
// Required: true
Password *string `json:"password"`
// The username part of the login request
// Required: true
Username *string `json:"username"`
}
LoginRequest The body of a login request. swagger:model LoginRequest
func (*LoginRequest) MarshalBinary ¶
func (m *LoginRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LoginRequest) UnmarshalBinary ¶
func (m *LoginRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LoginState ¶
type LoginState struct {
// The path to which to redirect post login - if not specified then no redirect is performed, instead 200 is returned with the token in the body
Path string `json:"path,omitempty"`
}
LoginState Configure how the API responds after a successful login. swagger:model LoginState
func (*LoginState) MarshalBinary ¶
func (m *LoginState) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LoginState) UnmarshalBinary ¶
func (m *LoginState) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ManagedMonitoringSettings ¶
type ManagedMonitoringSettings struct {
// The Id of the target cluster to which to send monitoring information
// Required: true
TargetClusterID *string `json:"target_cluster_id"`
}
ManagedMonitoringSettings The settings for sending monitoring information to another cluster. swagger:model ManagedMonitoringSettings
func (*ManagedMonitoringSettings) MarshalBinary ¶
func (m *ManagedMonitoringSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ManagedMonitoringSettings) UnmarshalBinary ¶
func (m *ManagedMonitoringSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MatchAllQuery ¶
type MatchAllQuery interface{}
MatchAllQuery A query that matches all documents. swagger:model MatchAllQuery
type MatchNoneQuery ¶
type MatchNoneQuery interface{}
MatchNoneQuery A query that doesn't match any documents. swagger:model MatchNoneQuery
type MatchQuery ¶
type MatchQuery struct {
// The analyzer that will be used to perform the analysis process on the text. Defaults to the analyzer that was used to index the field.
Analyzer string `json:"analyzer,omitempty"`
// The minimum number of optional should clauses to match.
MinimumShouldMatch int32 `json:"minimum_should_match,omitempty"`
// The operator flag can be set to or or and to control the boolean clauses (defaults to or).
Operator string `json:"operator,omitempty"`
// The text/numeric/date to query for.
// Required: true
Query *string `json:"query"`
}
MatchQuery Consumes and analyzes text, numbers, and dates, then constructs a query. swagger:model MatchQuery
func (*MatchQuery) MarshalBinary ¶
func (m *MatchQuery) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MatchQuery) UnmarshalBinary ¶
func (m *MatchQuery) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Metadata ¶
type Metadata struct {
// Creation time
// Required: true
// Format: date-time
CreatedTime *strfmt.DateTime `json:"created_time"`
// Modification time
// Required: true
// Format: date-time
ModifiedTime *strfmt.DateTime `json:"modified_time"`
// Version
// Required: true
Version *int32 `json:"version"`
}
Metadata Metadata of an entity swagger:model Metadata
func (*Metadata) MarshalBinary ¶
MarshalBinary interface implementation
func (*Metadata) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MetadataItem ¶
type MetadataItem struct {
// The metadata field name
// Required: true
Key *string `json:"key"`
// The metadata value
// Required: true
Value *string `json:"value"`
}
MetadataItem The key-value pair. swagger:model MetadataItem
func (*MetadataItem) MarshalBinary ¶
func (m *MetadataItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MetadataItem) UnmarshalBinary ¶
func (m *MetadataItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MetadataItemValue ¶
type MetadataItemValue struct {
// The metadata value
// Required: true
Value *string `json:"value"`
}
MetadataItemValue The value of the metadata item, which is primarily used to add a single item when the key is provided in the URL. swagger:model MetadataItemValue
func (*MetadataItemValue) MarshalBinary ¶
func (m *MetadataItemValue) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MetadataItemValue) UnmarshalBinary ¶
func (m *MetadataItemValue) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MetadataItems ¶
type MetadataItems struct {
// A collection of arbitrary metadata items associated with a resource.
// Required: true
Items []*MetadataItem `json:"items"`
}
MetadataItems The container object for metadata items. swagger:model MetadataItems
func (*MetadataItems) MarshalBinary ¶
func (m *MetadataItems) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MetadataItems) UnmarshalBinary ¶
func (m *MetadataItems) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ModelVersionIndexSynchronizationResults ¶
type ModelVersionIndexSynchronizationResults struct {
// The results of synchronizing indices organized by model version
// Required: true
Results map[string]IndexSynchronizationResults `json:"results"`
}
ModelVersionIndexSynchronizationResults Results from synchronizing indices by model version swagger:model ModelVersionIndexSynchronizationResults
func (*ModelVersionIndexSynchronizationResults) MarshalBinary ¶
func (m *ModelVersionIndexSynchronizationResults) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ModelVersionIndexSynchronizationResults) UnmarshalBinary ¶
func (m *ModelVersionIndexSynchronizationResults) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MoveApmClusterConfiguration ¶
type MoveApmClusterConfiguration struct {
// Identifiers for the Apm clusters.
// Required: true
ClusterIds []string `json:"cluster_ids"`
// Plan override to apply to the Apm clusters being moved.
PlanOverride *TransientApmPlanConfiguration `json:"plan_override,omitempty"`
}
MoveApmClusterConfiguration The configuration object for moving APM Servers. swagger:model MoveApmClusterConfiguration
func (*MoveApmClusterConfiguration) MarshalBinary ¶
func (m *MoveApmClusterConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MoveApmClusterConfiguration) UnmarshalBinary ¶
func (m *MoveApmClusterConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MoveApmClusterDetails ¶
type MoveApmClusterDetails struct {
// If only validating the move, then the plan configuration that would be applied to the cluster.
CalculatedPlan *TransientApmPlanConfiguration `json:"calculated_plan,omitempty"`
// Identifier for the Apm cluster.
// Required: true
ClusterID *string `json:"cluster_id"`
// A list of errors that occurred if the attempt to move the cluster failed.
Errors []*BasicFailedReplyElement `json:"errors"`
}
MoveApmClusterDetails Information about the APM Server that you want to move. swagger:model MoveApmClusterDetails
func (*MoveApmClusterDetails) MarshalBinary ¶
func (m *MoveApmClusterDetails) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MoveApmClusterDetails) UnmarshalBinary ¶
func (m *MoveApmClusterDetails) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MoveAppSearchConfiguration ¶
type MoveAppSearchConfiguration struct {
// Identifiers for the App Searches.
// Required: true
ClusterIds []string `json:"cluster_ids"`
// Plan override to apply to the App Searches being moved.
PlanOverride *TransientAppSearchPlanConfiguration `json:"plan_override,omitempty"`
}
MoveAppSearchConfiguration The configuration object for moving App Searches. swagger:model MoveAppSearchConfiguration
func (*MoveAppSearchConfiguration) MarshalBinary ¶
func (m *MoveAppSearchConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MoveAppSearchConfiguration) UnmarshalBinary ¶
func (m *MoveAppSearchConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MoveAppSearchDetails ¶
type MoveAppSearchDetails struct {
// If only validating the move, then the plan configuration that would be applied to the cluster.
CalculatedPlan *TransientAppSearchPlanConfiguration `json:"calculated_plan,omitempty"`
// Identifier for the App Search.
// Required: true
ClusterID *string `json:"cluster_id"`
// A list of errors that occurred if the attempt to move the cluster failed.
Errors []*BasicFailedReplyElement `json:"errors"`
}
MoveAppSearchDetails Information about the App Search that you want to move. swagger:model MoveAppSearchDetails
func (*MoveAppSearchDetails) MarshalBinary ¶
func (m *MoveAppSearchDetails) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MoveAppSearchDetails) UnmarshalBinary ¶
func (m *MoveAppSearchDetails) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MoveClustersCommandResponse ¶
type MoveClustersCommandResponse struct {
// Detailed information about the clusters that failed to move.
// Required: true
Failures *MoveClustersDetails `json:"failures"`
// Detailed information about the clusters being moved off the allocator.
// Required: true
Moves *MoveClustersDetails `json:"moves"`
}
MoveClustersCommandResponse Information about the move operations for the Elasticsearch clusters, multiple Kibana instances, and multiple APM Servers, prior to the move. swagger:model MoveClustersCommandResponse
func (*MoveClustersCommandResponse) MarshalBinary ¶
func (m *MoveClustersCommandResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MoveClustersCommandResponse) UnmarshalBinary ¶
func (m *MoveClustersCommandResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MoveClustersDetails ¶
type MoveClustersDetails struct {
// Detailed information about the Apm clusters being moved.
// Required: true
ApmClusters []*MoveApmClusterDetails `json:"apm_clusters"`
// Detailed information about the App Search clusters being moved.
// Required: true
AppsearchClusters []*MoveAppSearchDetails `json:"appsearch_clusters"`
// Detailed information about the Elasticsearch clusters being moved.
// Required: true
ElasticsearchClusters []*MoveElasticsearchClusterDetails `json:"elasticsearch_clusters"`
// Detailed information about the Elastic Enterprise Search clusters being moved.
// Required: true
EnterpriseSearchClusters []*MoveEnterpriseSearchDetails `json:"enterprise_search_clusters"`
// Detailed information about the Kibana clusters being moved.
// Required: true
KibanaClusters []*MoveKibanaClusterDetails `json:"kibana_clusters"`
}
MoveClustersDetails Information about the Elasticsearch clusters, multiple Kibana instances, and multiple APM Servers that are moved off of the allocator. swagger:model MoveClustersDetails
func (*MoveClustersDetails) MarshalBinary ¶
func (m *MoveClustersDetails) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MoveClustersDetails) UnmarshalBinary ¶
func (m *MoveClustersDetails) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MoveClustersRequest ¶
type MoveClustersRequest struct {
// Optional list of Apm clusters to move off the allocator.
ApmClusters []*MoveApmClusterConfiguration `json:"apm_clusters"`
// Optional list of App Search clusters to move off the allocator.
AppsearchClusters []*MoveAppSearchConfiguration `json:"appsearch_clusters"`
// Optional list of Elasticsearch clusters to move off the allocator.
ElasticsearchClusters []*MoveElasticsearchClusterConfiguration `json:"elasticsearch_clusters"`
// Optional list of Elastic Enterprise Search clusters to move off the allocator.
EnterpriseSearchClusters []*MoveEnterpriseSearchConfiguration `json:"enterprise_search_clusters"`
// Optional list of Kibana clusters to move off the allocator.
KibanaClusters []*MoveKibanaClusterConfiguration `json:"kibana_clusters"`
}
MoveClustersRequest The request for moving Elasticsearch clusters off an allocator. swagger:model MoveClustersRequest
func (*MoveClustersRequest) MarshalBinary ¶
func (m *MoveClustersRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MoveClustersRequest) UnmarshalBinary ¶
func (m *MoveClustersRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MoveElasticsearchClusterConfiguration ¶
type MoveElasticsearchClusterConfiguration struct {
// Identifiers for the Elasticsearch clusters.
// Required: true
ClusterIds []string `json:"cluster_ids"`
// Plan override to apply to the Elasticsearch clusters being moved.
PlanOverride *TransientElasticsearchPlanConfiguration `json:"plan_override,omitempty"`
}
MoveElasticsearchClusterConfiguration The configuration object for moving Elasticsearch clusters. swagger:model MoveElasticsearchClusterConfiguration
func (*MoveElasticsearchClusterConfiguration) MarshalBinary ¶
func (m *MoveElasticsearchClusterConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MoveElasticsearchClusterConfiguration) UnmarshalBinary ¶
func (m *MoveElasticsearchClusterConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MoveElasticsearchClusterDetails ¶
type MoveElasticsearchClusterDetails struct {
// If only validating the move, then the plan configuration that would be applied to the cluster.
CalculatedPlan *TransientElasticsearchPlanConfiguration `json:"calculated_plan,omitempty"`
// Identifier for the Elasticsearch cluster.
// Required: true
ClusterID *string `json:"cluster_id"`
// A list of errors that occurred if the attempt to move the cluster failed.
Errors []*BasicFailedReplyElement `json:"errors"`
}
MoveElasticsearchClusterDetails Information about the Elasticsearch cluster that you want to move. swagger:model MoveElasticsearchClusterDetails
func (*MoveElasticsearchClusterDetails) MarshalBinary ¶
func (m *MoveElasticsearchClusterDetails) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MoveElasticsearchClusterDetails) UnmarshalBinary ¶
func (m *MoveElasticsearchClusterDetails) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MoveEnterpriseSearchConfiguration ¶
type MoveEnterpriseSearchConfiguration struct {
// Identifiers for the Elastic Enterprise Search clusters.
// Required: true
ClusterIds []string `json:"cluster_ids"`
// Plan override to apply to the Elastic Enterprise Search instances being moved.
PlanOverride *TransientEnterpriseSearchPlanConfiguration `json:"plan_override,omitempty"`
}
MoveEnterpriseSearchConfiguration The configuration object for moving Elastic Enterprise Search instances. swagger:model MoveEnterpriseSearchConfiguration
func (*MoveEnterpriseSearchConfiguration) MarshalBinary ¶
func (m *MoveEnterpriseSearchConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MoveEnterpriseSearchConfiguration) UnmarshalBinary ¶
func (m *MoveEnterpriseSearchConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MoveEnterpriseSearchDetails ¶
type MoveEnterpriseSearchDetails struct {
// If only validating the move, then the plan configuration that would be applied to the cluster.
CalculatedPlan *TransientEnterpriseSearchPlanConfiguration `json:"calculated_plan,omitempty"`
// Identifier for the Elastic Enterprise Search.
// Required: true
ClusterID *string `json:"cluster_id"`
// A list of errors that occurred if the attempt to move the cluster failed.
Errors []*BasicFailedReplyElement `json:"errors"`
}
MoveEnterpriseSearchDetails Information about the Elastic Enterprise Search that you want to move. swagger:model MoveEnterpriseSearchDetails
func (*MoveEnterpriseSearchDetails) MarshalBinary ¶
func (m *MoveEnterpriseSearchDetails) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MoveEnterpriseSearchDetails) UnmarshalBinary ¶
func (m *MoveEnterpriseSearchDetails) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MoveKibanaClusterConfiguration ¶
type MoveKibanaClusterConfiguration struct {
// Identifiers for the Kibana clusters.
// Required: true
ClusterIds []string `json:"cluster_ids"`
// Plan override to apply to the Kibana clusters being moved.
PlanOverride *TransientKibanaPlanConfiguration `json:"plan_override,omitempty"`
}
MoveKibanaClusterConfiguration The configuration object for moving Kibana instances. swagger:model MoveKibanaClusterConfiguration
func (*MoveKibanaClusterConfiguration) MarshalBinary ¶
func (m *MoveKibanaClusterConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MoveKibanaClusterConfiguration) UnmarshalBinary ¶
func (m *MoveKibanaClusterConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MoveKibanaClusterDetails ¶
type MoveKibanaClusterDetails struct {
// If only validating the move, then the plan configuration that would be applied to the cluster.
CalculatedPlan *TransientKibanaPlanConfiguration `json:"calculated_plan,omitempty"`
// Identifier for the Kibana cluster.
// Required: true
ClusterID *string `json:"cluster_id"`
// A list of errors that occurred if the attempt to move the cluster failed.
Errors []*BasicFailedReplyElement `json:"errors"`
}
MoveKibanaClusterDetails Information about the Kibana instance that you want to move. swagger:model MoveKibanaClusterDetails
func (*MoveKibanaClusterDetails) MarshalBinary ¶
func (m *MoveKibanaClusterDetails) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MoveKibanaClusterDetails) UnmarshalBinary ¶
func (m *MoveKibanaClusterDetails) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NestedQuery ¶
type NestedQuery struct {
// The path to the nested object.
// Required: true
Path *string `json:"path"`
// The actual query to execute on the nested objects.
// Required: true
Query *QueryContainer `json:"query"`
// Allows to specify how inner children matching affects score of the parent. Refer to the Elasticsearch documentation for details.
// Enum: [avg sum min max none]
ScoreMode string `json:"score_mode,omitempty"`
}
NestedQuery A query that matches nested objects. swagger:model NestedQuery
func (*NestedQuery) MarshalBinary ¶
func (m *NestedQuery) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NestedQuery) UnmarshalBinary ¶
func (m *NestedQuery) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NodeTypeResource ¶
type NodeTypeResource struct {
// Id of the default instance configuration to use for this node type.
DefaultInstanceConfigurationID string `json:"default_instance_configuration_id,omitempty"`
// Node type description
// Required: true
Description *string `json:"description"`
// Flag to specify a node type is mandatory in the corresponding cluster's plan
Mandatory *bool `json:"mandatory,omitempty"`
// Node type name
// Required: true
Name *string `json:"name"`
// Node type, part of the key for this resource
// Required: true
NodeType *string `json:"node_type"`
}
NodeTypeResource Information about the node type. swagger:model NodeTypeResource
func (*NodeTypeResource) MarshalBinary ¶
func (m *NodeTypeResource) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NodeTypeResource) UnmarshalBinary ¶
func (m *NodeTypeResource) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Note ¶
type Note struct {
// note id
ID string `json:"id,omitempty"`
// Note message
// Required: true
Message *string `json:"message"`
// Note last modification timestamp
// Format: date-time
Timestamp strfmt.DateTime `json:"timestamp,omitempty"`
// Note author
UserID string `json:"user_id,omitempty"`
}
Note Note swagger:model Note
func (*Note) MarshalBinary ¶
MarshalBinary interface implementation
func (*Note) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Notes ¶
type Notes struct {
// Notes
// Required: true
Notes []*Note `json:"notes"`
}
Notes User notes swagger:model Notes
func (*Notes) MarshalBinary ¶
MarshalBinary interface implementation
func (*Notes) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Orphaned ¶
type Orphaned struct {
// List of orphaned APM resource ids
// Required: true
Apm []string `json:"apm"`
// List of orphaned AppSearch resource ids
// Required: true
Appsearch []string `json:"appsearch"`
// List of orphaned Elasticsearch resources
// Required: true
Elasticsearch []*OrphanedElasticsearch `json:"elasticsearch"`
// List of orphaned Enterprise Search resource ids
// Required: true
EnterpriseSearch []string `json:"enterprise_search"`
// List of orphaned Kibana resource ids
// Required: true
Kibana []string `json:"kibana"`
}
Orphaned Details about orphaned resources. swagger:model Orphaned
func (*Orphaned) MarshalBinary ¶
MarshalBinary interface implementation
func (*Orphaned) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type OrphanedElasticsearch ¶
type OrphanedElasticsearch struct {
// List of orphaned dependent resources
// Required: true
Dependents []*ElasticsearchDependant `json:"dependents"`
// The id of the orphaned resource
// Required: true
ID *string `json:"id"`
}
OrphanedElasticsearch Details about an orphaned Elasticsearch resources. swagger:model OrphanedElasticsearch
func (*OrphanedElasticsearch) MarshalBinary ¶
func (m *OrphanedElasticsearch) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OrphanedElasticsearch) UnmarshalBinary ¶
func (m *OrphanedElasticsearch) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PendingState ¶
type PendingState struct {
// Whether a runner is pending blessings or not
// Required: true
Value *bool `json:"value"`
}
PendingState Pending state swagger:model PendingState
func (*PendingState) MarshalBinary ¶
func (m *PendingState) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PendingState) UnmarshalBinary ¶
func (m *PendingState) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PendingStates ¶
type PendingStates struct {
// A mapping of Runner Ids to whether or not they are waiting to be blessed to run the associated role
// Required: true
RunnerIdsToPendingState map[string]PendingState `json:"runner_ids_to_pending_state"`
}
PendingStates Describes whether certain runners are waiting to be blessed. swagger:model PendingStates
func (*PendingStates) MarshalBinary ¶
func (m *PendingStates) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PendingStates) UnmarshalBinary ¶
func (m *PendingStates) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PendingStatesWithMeta ¶
type PendingStatesWithMeta struct {
// The metadata
// Required: true
Meta *Metadata `json:"meta"`
// The pending stages
// Required: true
Value *PendingStates `json:"value"`
}
PendingStatesWithMeta Persisted pending states for a role along with metadata swagger:model PendingStatesWithMeta
func (*PendingStatesWithMeta) MarshalBinary ¶
func (m *PendingStatesWithMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PendingStatesWithMeta) UnmarshalBinary ¶
func (m *PendingStatesWithMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PlanStrategy ¶
type PlanStrategy struct {
// autodetect
Autodetect AutodetectStrategyConfig `json:"autodetect,omitempty"`
// grow and shrink
GrowAndShrink GrowShrinkStrategyConfig `json:"grow_and_shrink,omitempty"`
// rolling
Rolling *RollingStrategyConfig `json:"rolling,omitempty"`
// rolling grow and shrink
RollingGrowAndShrink RollingGrowShrinkStrategyConfig `json:"rolling_grow_and_shrink,omitempty"`
}
PlanStrategy The options for performing a plan change. Specify only one property each time. The default is `grow_and_shrink`. swagger:model PlanStrategy
func (*PlanStrategy) MarshalBinary ¶
func (m *PlanStrategy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PlanStrategy) UnmarshalBinary ¶
func (m *PlanStrategy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PlatformInfo ¶
type PlatformInfo struct {
// Indicates if the End User License Agreement been accepted
// Required: true
EulaAccepted *bool `json:"eula_accepted"`
// Is the phone-home service, which returns anonymized usage statistics to Elastic, enabled
// Required: true
PhoneHomeEnabled *bool `json:"phone_home_enabled"`
// Information on regions
// Required: true
Regions []*RegionInfo `json:"regions"`
// services
// Required: true
Services []*PlatformServiceInfo `json:"services"`
// Information on currently unreachable regions
// Required: true
UnreachableRegions []*UnreachableRegionInfo `json:"unreachable_regions"`
// Platform version
// Required: true
Version *string `json:"version"`
}
PlatformInfo Information about the platform. swagger:model PlatformInfo
func (*PlatformInfo) MarshalBinary ¶
func (m *PlatformInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PlatformInfo) UnmarshalBinary ¶
func (m *PlatformInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PlatformResourcesSummary ¶
type PlatformResourcesSummary struct {
// Number of accounts
// Required: true
AccountCount *int32 `json:"account_count"`
// Number of available resources
// Required: true
AvailableCount *int32 `json:"available_count"`
// Whether all resources are healthy
// Required: true
Healthy *bool `json:"healthy"`
// Minimum number of available resources
// Required: true
MinimumAvailableCount *int32 `json:"minimum_available_count"`
// Number of missing resources
// Required: true
MissingCount *int32 `json:"missing_count"`
// Number of used resources
// Required: true
UsedCount *int32 `json:"used_count"`
}
PlatformResourcesSummary Information about resources. swagger:model PlatformResourcesSummary
func (*PlatformResourcesSummary) MarshalBinary ¶
func (m *PlatformResourcesSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PlatformResourcesSummary) UnmarshalBinary ¶
func (m *PlatformResourcesSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PlatformServiceImageInfo ¶
type PlatformServiceImageInfo struct {
// Image hash code
// Required: true
Hash *string `json:"hash"`
// Id of runner that hosts the container
// Required: true
ID *string `json:"id"`
// Image tag
// Required: true
Tag *string `json:"tag"`
// Version of service
// Required: true
Version *string `json:"version"`
}
PlatformServiceImageInfo The docker image that is used to run a service. swagger:model PlatformServiceImageInfo
func (*PlatformServiceImageInfo) MarshalBinary ¶
func (m *PlatformServiceImageInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PlatformServiceImageInfo) UnmarshalBinary ¶
func (m *PlatformServiceImageInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PlatformServiceInfo ¶
type PlatformServiceInfo struct {
// image
// Required: true
Image []*PlatformServiceImageInfo `json:"image"`
// Name of service
// Required: true
Type *string `json:"type"`
}
PlatformServiceInfo The platform service information. swagger:model PlatformServiceInfo
func (*PlatformServiceInfo) MarshalBinary ¶
func (m *PlatformServiceInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PlatformServiceInfo) UnmarshalBinary ¶
func (m *PlatformServiceInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PortBinding ¶
type PortBinding struct {
// IP to bind to on the host. I.e {@code 0.0.0.0}
HostIP string `json:"host_ip,omitempty"`
// Port as observed by the host.
// Required: true
HostPort *string `json:"host_port"`
}
PortBinding Value used to bind to a port on the host. swagger:model PortBinding
func (*PortBinding) MarshalBinary ¶
func (m *PortBinding) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PortBinding) UnmarshalBinary ¶
func (m *PortBinding) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PrefixQuery ¶
type PrefixQuery struct {
// An optional boost value to apply to the query.
Boost float32 `json:"boost,omitempty"`
// The prefix to search for.
// Required: true
Value *string `json:"value"`
}
PrefixQuery The query that matches documents with fields that contain terms with a specified, not analyzed, prefix. swagger:model PrefixQuery
func (*PrefixQuery) MarshalBinary ¶
func (m *PrefixQuery) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PrefixQuery) UnmarshalBinary ¶
func (m *PrefixQuery) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProxiesAllocationsInfo ¶
type ProxiesAllocationsInfo struct {
// The type of proxy allocations (e.g. Elasticsearch, Kibana, APM)
// Required: true
AllocationsType *string `json:"allocations_type"`
// The maximum number of allocations
// Required: true
MaxAllocations *int32 `json:"max_allocations"`
// The number of proxies that have the maximum number of allocations
// Required: true
ProxiesAtMaxAllocations *int32 `json:"proxies_at_max_allocations"`
}
ProxiesAllocationsInfo The allocation status for a specified type, such as Elasticsearch, Kibana, or APM. The status is part of the overall proxy health information. swagger:model ProxiesAllocationsInfo
func (*ProxiesAllocationsInfo) MarshalBinary ¶
func (m *ProxiesAllocationsInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProxiesAllocationsInfo) UnmarshalBinary ¶
func (m *ProxiesAllocationsInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProxiesFilter ¶
type ProxiesFilter struct {
// Key of the proxy metadata item to be matched
// Required: true
Key *string `json:"key"`
// Value of the proxy metadata item to be matched
// Required: true
Value *string `json:"value"`
}
ProxiesFilter Selects proxies by matching a proxy metadata item. swagger:model ProxiesFilter
func (*ProxiesFilter) MarshalBinary ¶
func (m *ProxiesFilter) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProxiesFilter) UnmarshalBinary ¶
func (m *ProxiesFilter) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProxiesFilteredGroup ¶
type ProxiesFilteredGroup struct {
// Expected minimum number of proxies matching all filters in this group
// Required: true
ExpectedProxiesCount *int32 `json:"expected_proxies_count"`
// Filters to be matched
// Required: true
Filters []*ProxiesFilter `json:"filters"`
// Identifier of the filtered group of proxies
ID string `json:"id,omitempty"`
}
ProxiesFilteredGroup A set of proxy filters with an expected number of matching proxies. swagger:model ProxiesFilteredGroup
func (*ProxiesFilteredGroup) MarshalBinary ¶
func (m *ProxiesFilteredGroup) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProxiesFilteredGroup) UnmarshalBinary ¶
func (m *ProxiesFilteredGroup) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProxiesFilteredGroupHealth ¶
type ProxiesFilteredGroupHealth struct {
// Settings of the filtered group
// Required: true
Group *ProxiesFilteredGroup `json:"group"`
// The number of proxies that match all of the filters in the group
// Required: true
ObservedProxiesCount *int32 `json:"observed_proxies_count"`
// "Health status for this filtered group. One of "Green", "Yellow" or "Red"
// Required: true
Status *string `json:"status"`
}
ProxiesFilteredGroupHealth The health status of a filtered proxy group. swagger:model ProxiesFilteredGroupHealth
func (*ProxiesFilteredGroupHealth) MarshalBinary ¶
func (m *ProxiesFilteredGroupHealth) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProxiesFilteredGroupHealth) UnmarshalBinary ¶
func (m *ProxiesFilteredGroupHealth) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProxiesHTTPSettings ¶
type ProxiesHTTPSettings struct {
// Secret string for the HTTP cookie
// Required: true
CookieSecret *string `json:"cookie_secret"`
// Base URL for the dashboard
// Required: true
DashboardsBaseURL *string `json:"dashboards_base_url"`
// Cutoff interval after disconnection in milliseconds
// Required: true
DisconnectedCutoff *int64 `json:"disconnected_cutoff"`
// Minimum number of proxy instances
// Required: true
MinimumProxyServices *int32 `json:"minimum_proxy_services"`
// Settings related to single-sign-on
// Required: true
SsoSettings *ProxiesSSOSettings `json:"sso_settings"`
// User key for the HTTP cookie
// Required: true
UserCookieKey *string `json:"user_cookie_key"`
}
ProxiesHTTPSettings The HTTP settings for all proxies. swagger:model ProxiesHttpSettings
func (*ProxiesHTTPSettings) MarshalBinary ¶
func (m *ProxiesHTTPSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProxiesHTTPSettings) UnmarshalBinary ¶
func (m *ProxiesHTTPSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProxiesHealth ¶
type ProxiesHealth struct {
// Allocations for proxies
// Required: true
Allocations []*ProxiesAllocationsInfo `json:"allocations"`
// Expected minimum number of proxies
// Required: true
ExpectedProxiesCount *int32 `json:"expected_proxies_count"`
// Filtered groups of proxies with associated status
// Required: true
FilteredGroups []*ProxiesFilteredGroupHealth `json:"filtered_groups"`
// Total number of proxies
// Required: true
ObservedProxiesCount *int32 `json:"observed_proxies_count"`
// "Health status for all proxies. One of "Green", "Yellow" or "Red"
// Required: true
Status *string `json:"status"`
}
ProxiesHealth proxies health swagger:model ProxiesHealth
func (*ProxiesHealth) MarshalBinary ¶
func (m *ProxiesHealth) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProxiesHealth) UnmarshalBinary ¶
func (m *ProxiesHealth) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProxiesSSOSettings ¶
type ProxiesSSOSettings struct {
// Name of the HTTP cookie used for single-sign-on
// Required: true
CookieName *string `json:"cookie_name"`
// Default path where users are redirected after a successful single-sign-on
// Required: true
DefaultRedirectPath *string `json:"default_redirect_path"`
// If true, don't log requests
// Required: true
DontLogRequests *bool `json:"dont_log_requests"`
// Name of the cookie that bypasses maintenance
// Required: true
MaintenanceBypassCookieName *string `json:"maintenance_bypass_cookie_name"`
// Maximum age of single-sign-on token in milliseconds
// Required: true
MaxAge *int64 `json:"max_age"`
// Secret string for single-sign-on
// Required: true
SsoSecret *string `json:"sso_secret"`
}
ProxiesSSOSettings The single sign-on settings for all proxies. swagger:model ProxiesSSOSettings
func (*ProxiesSSOSettings) MarshalBinary ¶
func (m *ProxiesSSOSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProxiesSSOSettings) UnmarshalBinary ¶
func (m *ProxiesSSOSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProxiesSettings ¶
type ProxiesSettings struct {
// Expected number of proxies
// Required: true
ExpectedProxiesCount *int32 `json:"expected_proxies_count"`
// HTTP settings
// Required: true
HTTPSettings *ProxiesHTTPSettings `json:"http_settings"`
// Secret string for signature generation
// Required: true
SignatureSecret *string `json:"signature_secret"`
// Signature validity in milliseconds
// Required: true
SignatureValidForMillis *int64 `json:"signature_valid_for_millis"`
}
ProxiesSettings The settings for all proxies. swagger:model ProxiesSettings
func (*ProxiesSettings) MarshalBinary ¶
func (m *ProxiesSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProxiesSettings) UnmarshalBinary ¶
func (m *ProxiesSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProxiesSummary ¶
type ProxiesSummary struct {
// Expected number of proxies
// Required: true
ExpectedProxiesCount *int32 `json:"expected_proxies_count"`
// Whether all proxies are healthy
// Required: true
Healthy *bool `json:"healthy"`
// Summarized information about each proxy
// Required: true
Proxies []*ProxySummary `json:"proxies"`
// Total number of proxies
// Required: true
ProxiesCount *int32 `json:"proxies_count"`
}
ProxiesSummary Summarized information about proxies. swagger:model ProxiesSummary
func (*ProxiesSummary) MarshalBinary ¶
func (m *ProxiesSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProxiesSummary) UnmarshalBinary ¶
func (m *ProxiesSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProxyAllocationCounts ¶
type ProxyAllocationCounts struct {
// The allocations count.
// Required: true
Allocations *int32 `json:"allocations"`
// The connector count.
// Required: true
Connectors *int32 `json:"connectors"`
}
ProxyAllocationCounts The number of proxy allocations. swagger:model ProxyAllocationCounts
func (*ProxyAllocationCounts) MarshalBinary ¶
func (m *ProxyAllocationCounts) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProxyAllocationCounts) UnmarshalBinary ¶
func (m *ProxyAllocationCounts) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProxyAllocationInfo ¶
type ProxyAllocationInfo struct {
// The type of proxy allocations (e.g. Elasticsearch, Kibana, APM)
// Required: true
AllocationsType *string `json:"allocations_type"`
// Proxy allocation counts.
// Required: true
Counts *ProxyAllocationCounts `json:"counts"`
}
ProxyAllocationInfo The single proxy allocation for a specified type, such as Elasticsearch, Kibana, or APM. swagger:model ProxyAllocationInfo
func (*ProxyAllocationInfo) MarshalBinary ¶
func (m *ProxyAllocationInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProxyAllocationInfo) UnmarshalBinary ¶
func (m *ProxyAllocationInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProxyInfo ¶
type ProxyInfo struct {
// Allocation information by type.
// Required: true
Allocations []*ProxyAllocationInfo `json:"allocations"`
// Specifies if the proxy is healthy
// Required: true
Healthy *bool `json:"healthy"`
// IP of the host the proxy runs on
// Required: true
HostIP *string `json:"host_ip"`
// Arbitrary metadata associated with the proxy
// Required: true
Metadata interface{} `json:"metadata"`
// The proxy identifier
// Required: true
ProxyID *string `json:"proxy_id"`
// Public hostname of the host the proxy runs on
// Required: true
PublicHostname *string `json:"public_hostname"`
// Identifier of the runner for the proxy
RunnerID string `json:"runner_id,omitempty"`
// The zone.
Zone string `json:"zone,omitempty"`
}
ProxyInfo Information about a proxy. swagger:model ProxyInfo
func (*ProxyInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*ProxyInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ProxyOverview ¶
type ProxyOverview struct {
// Proxies
// Required: true
Proxies []*ProxyInfo `json:"proxies"`
// Number of proxies
// Required: true
ProxiesCount *int32 `json:"proxies_count"`
// Settings
// Required: true
Settings *ProxiesSettings `json:"settings"`
}
ProxyOverview Information about all of the proxies. swagger:model ProxyOverview
func (*ProxyOverview) MarshalBinary ¶
func (m *ProxyOverview) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProxyOverview) UnmarshalBinary ¶
func (m *ProxyOverview) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProxySummary ¶
type ProxySummary struct {
// Whether this proxy is healthy
// Required: true
Healthy *bool `json:"healthy"`
// The proxy identifier
// Required: true
ProxyID *string `json:"proxy_id"`
}
ProxySummary Summarized information about a proxy. swagger:model ProxySummary
func (*ProxySummary) MarshalBinary ¶
func (m *ProxySummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProxySummary) UnmarshalBinary ¶
func (m *ProxySummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PublicCertChain ¶
type PublicCertChain struct {
// The list of PEM encoded X509 certificates that make up the certificate chain
// Required: true
Chain []string `json:"chain"`
}
PublicCertChain The public portion of the certificate chain that contains the PEM encoded server certificate, intermediate certificates, and the CA certificate. NOTE: The private key, normally included in certificate chains, is omitted. swagger:model PublicCertChain
func (*PublicCertChain) MarshalBinary ¶
func (m *PublicCertChain) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PublicCertChain) UnmarshalBinary ¶
func (m *PublicCertChain) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PublicCertChainCollection ¶
type PublicCertChainCollection struct {
// The map of extra certificate ids to their public certificate chains
// Required: true
Certs map[string]PublicCertChain `json:"certs"`
}
PublicCertChainCollection Collections of public certificate chains for all the defined extra certificates swagger:model PublicCertChainCollection
func (*PublicCertChainCollection) MarshalBinary ¶
func (m *PublicCertChainCollection) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PublicCertChainCollection) UnmarshalBinary ¶
func (m *PublicCertChainCollection) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type QueryContainer ¶
type QueryContainer struct {
// bool
Bool *BoolQuery `json:"bool,omitempty"`
// exists
Exists *ExistsQuery `json:"exists,omitempty"`
// match
Match map[string]MatchQuery `json:"match,omitempty"`
// match all
MatchAll MatchAllQuery `json:"match_all,omitempty"`
// match none
MatchNone MatchNoneQuery `json:"match_none,omitempty"`
// nested
Nested *NestedQuery `json:"nested,omitempty"`
// prefix
Prefix map[string]PrefixQuery `json:"prefix,omitempty"`
// query string
QueryString *QueryStringQuery `json:"query_string,omitempty"`
// range
Range map[string]RangeQuery `json:"range,omitempty"`
// term
Term map[string]TermQuery `json:"term,omitempty"`
}
QueryContainer The container for all of the allowed Elasticsearch queries. Specify only one property each time. swagger:model QueryContainer
func (*QueryContainer) MarshalBinary ¶
func (m *QueryContainer) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*QueryContainer) UnmarshalBinary ¶
func (m *QueryContainer) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type QueryStringQuery ¶
type QueryStringQuery struct {
// When set, * or ? are allowed as the first character. Defaults to false.
AllowLeadingWildcard *bool `json:"allow_leading_wildcard,omitempty"`
// The analyzer used to analyze each term of the query when creating composite queries.
Analyzer string `json:"analyzer,omitempty"`
// The default field for query terms if no prefix field is specified.
DefaultField string `json:"default_field,omitempty"`
// The default operator used if no explicit operator is specified.
DefaultOperator string `json:"default_operator,omitempty"`
// The actual query to be parsed.
// Required: true
Query *string `json:"query"`
}
QueryStringQuery A query that uses the `SimpleQueryParser` for parsing. swagger:model QueryStringQuery
func (*QueryStringQuery) MarshalBinary ¶
func (m *QueryStringQuery) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*QueryStringQuery) UnmarshalBinary ¶
func (m *QueryStringQuery) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RangeQuery ¶
type RangeQuery struct {
// An optional boost value to apply to the query.
Boost float32 `json:"boost,omitempty"`
// Formatted dates will be parsed using the format specified on the date field by default, but it can be overridden by passing the format parameter.
Format string `json:"format,omitempty"`
// Greater-than
Gt interface{} `json:"gt,omitempty"`
// Greater-than or equal to
Gte interface{} `json:"gte,omitempty"`
// Less-than
Lt interface{} `json:"lt,omitempty"`
// Less-than or equal to.
Lte interface{} `json:"lte,omitempty"`
// Dates can be converted from another timezone to UTC either by specifying the time zone in the date value itself (if the format accepts it), or it can be specified as the time_zone parameter.
TimeZone string `json:"time_zone,omitempty"`
}
RangeQuery The query that matches documents with fields that contain terms within a specified range. swagger:model RangeQuery
func (*RangeQuery) MarshalBinary ¶
func (m *RangeQuery) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RangeQuery) UnmarshalBinary ¶
func (m *RangeQuery) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ReAuthenticationRequest ¶
type ReAuthenticationRequest struct {
// The plain text password
// Required: true
Password *string `json:"password"`
}
ReAuthenticationRequest The body of the request to authenticate for generating API key swagger:model ReAuthenticationRequest
func (*ReAuthenticationRequest) MarshalBinary ¶
func (m *ReAuthenticationRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ReAuthenticationRequest) UnmarshalBinary ¶
func (m *ReAuthenticationRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ReAuthenticationResponse ¶
type ReAuthenticationResponse struct {
// The security token part of the Create API key request
// Required: true
SecurityToken *string `json:"security_token"`
}
ReAuthenticationResponse The re-authentication response body swagger:model ReAuthenticationResponse
func (*ReAuthenticationResponse) MarshalBinary ¶
func (m *ReAuthenticationResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ReAuthenticationResponse) UnmarshalBinary ¶
func (m *ReAuthenticationResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ReadOnlyRequest ¶
type ReadOnlyRequest struct {
// Enabled or disabled read-only mode
// Required: true
Enabled *bool `json:"enabled"`
}
ReadOnlyRequest Read-only mode request payload swagger:model ReadOnlyRequest
func (*ReadOnlyRequest) MarshalBinary ¶
func (m *ReadOnlyRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ReadOnlyRequest) UnmarshalBinary ¶
func (m *ReadOnlyRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ReadOnlyResponse ¶
type ReadOnlyResponse struct {
// Whether read-only mode is enabled or disabled
// Required: true
Enabled *bool `json:"enabled"`
}
ReadOnlyResponse Read-only mode response swagger:model ReadOnlyResponse
func (*ReadOnlyResponse) MarshalBinary ¶
func (m *ReadOnlyResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ReadOnlyResponse) UnmarshalBinary ¶
func (m *ReadOnlyResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RegionInfo ¶
type RegionInfo struct {
// Information about allocators
// Required: true
Allocators *AllocatorsSummary `json:"allocators"`
// Information about constructors
// Required: true
Constructors *ConstructorOverview `json:"constructors"`
// Information about container sets
// Required: true
ContainerSetsStatus *ContainerSetsSummary `json:"container_sets_status"`
// Information about coordinators
// Required: true
Coordinators *CoordinatorsSummary `json:"coordinators"`
// Information about proxies
// Required: true
Proxies *ProxiesSummary `json:"proxies"`
// Identifier of this region
// Required: true
RegionID *string `json:"region_id"`
// Information about resources
// Required: true
Resources *PlatformResourcesSummary `json:"resources"`
// Information about runners
// Required: true
Runners *RunnersSummary `json:"runners"`
// Information about the Zookeeper state
// Required: true
ZookeeperStates *ZookeeperSummary `json:"zookeeper_states"`
}
RegionInfo Information about a region. swagger:model RegionInfo
func (*RegionInfo) MarshalBinary ¶
func (m *RegionInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RegionInfo) UnmarshalBinary ¶
func (m *RegionInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RemoteClusterInfo ¶
type RemoteClusterInfo struct {
// Flag indicating whether the remote cluster version is compatible
// Required: true
Compatible *bool `json:"compatible"`
// The remote Elasticsearch cluster deployment id
// Required: true
ID *string `json:"id"`
// Remote cluster Elasticsearch version
Version string `json:"version,omitempty"`
}
RemoteClusterInfo Information about the remote cluster for cross-cluster search. swagger:model RemoteClusterInfo
func (*RemoteClusterInfo) MarshalBinary ¶
func (m *RemoteClusterInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RemoteClusterInfo) UnmarshalBinary ¶
func (m *RemoteClusterInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RemoteClusterRef ¶
type RemoteClusterRef struct {
// Cluster id of the remote cluster
// Required: true
ClusterID *string `json:"cluster_id"`
SkipUnavailable *bool `json:"skip_unavailable,omitempty"`
}
RemoteClusterRef The Elasticsearch cluster to connect to for cross-cluster search. swagger:model RemoteClusterRef
func (*RemoteClusterRef) MarshalBinary ¶
func (m *RemoteClusterRef) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RemoteClusterRef) UnmarshalBinary ¶
func (m *RemoteClusterRef) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RemoteResourceRef ¶
type RemoteResourceRef struct {
// The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores
// Required: true
Alias *string `json:"alias"`
// The id of the deployment
// Required: true
DeploymentID *string `json:"deployment_id"`
// The locally-unique user-specified id of an Elasticsearch Resource
// Required: true
ElasticsearchRefID *string `json:"elasticsearch_ref_id"`
SkipUnavailable *bool `json:"skip_unavailable,omitempty"`
}
RemoteResourceRef The Elasticsearch resource used as a Remote Cluster. swagger:model RemoteResourceRef
func (*RemoteResourceRef) MarshalBinary ¶
func (m *RemoteResourceRef) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RemoteResourceRef) UnmarshalBinary ¶
func (m *RemoteResourceRef) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RemoteResources ¶
type RemoteResources struct {
// The remote resources
// Required: true
Resources []*RemoteResourceRef `json:"resources"`
}
RemoteResources The list of resources used as remote clusters swagger:model RemoteResources
func (*RemoteResources) MarshalBinary ¶
func (m *RemoteResources) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RemoteResources) UnmarshalBinary ¶
func (m *RemoteResources) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ReplyWarning ¶
type ReplyWarning struct {
// A structured code representing the error type that occurred
// Required: true
Code *string `json:"code"`
// A human readable message describing the warning that occurred
Message string `json:"message,omitempty"`
}
ReplyWarning reply warning swagger:model ReplyWarning
func (*ReplyWarning) MarshalBinary ¶
func (m *ReplyWarning) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ReplyWarning) UnmarshalBinary ¶
func (m *ReplyWarning) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RepositoryConfig ¶
type RepositoryConfig struct {
// Elasticsearch configuration JSON for a snapshot repository
// Required: true
Config interface{} `json:"config"`
// Elasticsearch snapshot repository name
// Required: true
RepositoryName *string `json:"repository_name"`
}
RepositoryConfig The snapshot repository configuration. swagger:model RepositoryConfig
func (*RepositoryConfig) MarshalBinary ¶
func (m *RepositoryConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RepositoryConfig) UnmarshalBinary ¶
func (m *RepositoryConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RepositoryConfigs ¶
type RepositoryConfigs struct {
// List of snapshot configurations
// Required: true
Configs []*RepositoryConfig `json:"configs"`
}
RepositoryConfigs A list of snapshot repository configurations. swagger:model RepositoryConfigs
func (*RepositoryConfigs) MarshalBinary ¶
func (m *RepositoryConfigs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RepositoryConfigs) UnmarshalBinary ¶
func (m *RepositoryConfigs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RequestEnrollmentTokenReply ¶
type RequestEnrollmentTokenReply struct {
// The requested token
// Required: true
Token *string `json:"token"`
// An identifier for the requested token (if persistent) that can be used in listing and deletion
TokenID string `json:"token_id,omitempty"`
}
RequestEnrollmentTokenReply Returns the enrollment token that is used to securely start a new server with designated roles. swagger:model RequestEnrollmentTokenReply
func (*RequestEnrollmentTokenReply) MarshalBinary ¶
func (m *RequestEnrollmentTokenReply) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RequestEnrollmentTokenReply) UnmarshalBinary ¶
func (m *RequestEnrollmentTokenReply) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RestartPolicy ¶
type RestartPolicy struct {
// Maximum number of times to re-try before giving up
MaximumRetryCount int32 `json:"maximum_retry_count,omitempty"`
// Identifier for the policy.
// Required: true
Name *string `json:"name"`
}
RestartPolicy A policy that is applied when a container unexpectedly exits swagger:model RestartPolicy
func (*RestartPolicy) MarshalBinary ¶
func (m *RestartPolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RestartPolicy) UnmarshalBinary ¶
func (m *RestartPolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RestoreSnapshotAPIConfiguration ¶
type RestoreSnapshotAPIConfiguration struct {
// The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)
Indices []string `json:"indices"`
// This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats
RawSettings interface{} `json:"raw_settings,omitempty"`
}
RestoreSnapshotAPIConfiguration The configuration for the restore command, such as which indices you want to restore. swagger:model RestoreSnapshotApiConfiguration
func (*RestoreSnapshotAPIConfiguration) MarshalBinary ¶
func (m *RestoreSnapshotAPIConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RestoreSnapshotAPIConfiguration) UnmarshalBinary ¶
func (m *RestoreSnapshotAPIConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RestoreSnapshotConfiguration ¶
type RestoreSnapshotConfiguration struct {
// Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id
RepositoryConfig *RestoreSnapshotRepoConfiguration `json:"repository_config,omitempty"`
// If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')
RepositoryName string `json:"repository_name,omitempty"`
// restore payload
RestorePayload *RestoreSnapshotAPIConfiguration `json:"restore_payload,omitempty"`
// The name of the snapshot to restore. Use '\_\_latest_success\_\_' to get the most recent snapshot from the specified repository
// Required: true
SnapshotName *string `json:"snapshot_name"`
// If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config
SourceClusterID string `json:"source_cluster_id,omitempty"`
// The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only
// Enum: [partial full recovery]
Strategy string `json:"strategy,omitempty"`
}
RestoreSnapshotConfiguration Restores a snapshot from a local or remote repository. swagger:model RestoreSnapshotConfiguration
func (*RestoreSnapshotConfiguration) MarshalBinary ¶
func (m *RestoreSnapshotConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RestoreSnapshotConfiguration) UnmarshalBinary ¶
func (m *RestoreSnapshotConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RestoreSnapshotRepoConfiguration ¶
type RestoreSnapshotRepoConfiguration struct {
// The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats
RawSettings interface{} `json:"raw_settings,omitempty"`
}
RestoreSnapshotRepoConfiguration Configures the location of a remote repository. The default is the system repository. swagger:model RestoreSnapshotRepoConfiguration
func (*RestoreSnapshotRepoConfiguration) MarshalBinary ¶
func (m *RestoreSnapshotRepoConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RestoreSnapshotRepoConfiguration) UnmarshalBinary ¶
func (m *RestoreSnapshotRepoConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Role ¶
type Role struct {
// Whether runners are automatically allowed to be assigned the containers of this role.
// Required: true
AutoBlessed *bool `json:"auto_blessed"`
// The containers that are part of this role
// Required: true
Containers []*ContainersEntry `json:"containers"`
// The unique id of this role
// Required: true
ID *string `json:"id"`
}
Role Describes whether certain runners are blessed to run a Role. swagger:model Role
func (*Role) MarshalBinary ¶
MarshalBinary interface implementation
func (*Role) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type RoleAggregate ¶
type RoleAggregate struct {
// The blessings data associated with the role
Blessings *BlessingsWithMeta `json:"blessings,omitempty"`
// The unique id of this role
// Required: true
ID *string `json:"id"`
// The pending states data associated with the role
Pending *PendingStatesWithMeta `json:"pending,omitempty"`
// The role data with metadata
// Required: true
Role *RoleWithMeta `json:"role"`
}
RoleAggregate Describes whether certain runners are blessed to run a Role. swagger:model RoleAggregate
func (*RoleAggregate) MarshalBinary ¶
func (m *RoleAggregate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RoleAggregate) UnmarshalBinary ¶
func (m *RoleAggregate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RoleAggregateCreateData ¶
type RoleAggregateCreateData struct {
// The blessings data associated with the role
Blessings *Blessings `json:"blessings,omitempty"`
// The role data
// Required: true
Role *Role `json:"role"`
}
RoleAggregateCreateData Creation data for a role swagger:model RoleAggregateCreateData
func (*RoleAggregateCreateData) MarshalBinary ¶
func (m *RoleAggregateCreateData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RoleAggregateCreateData) UnmarshalBinary ¶
func (m *RoleAggregateCreateData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RoleAggregates ¶
type RoleAggregates struct {
// The list
// Required: true
Values []*RoleAggregate `json:"values"`
}
RoleAggregates A list of Role aggregates swagger:model RoleAggregates
func (*RoleAggregates) MarshalBinary ¶
func (m *RoleAggregates) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RoleAggregates) UnmarshalBinary ¶
func (m *RoleAggregates) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RoleWithMeta ¶
type RoleWithMeta struct {
// The metadata
// Required: true
Meta *Metadata `json:"meta"`
// The pending stages
// Required: true
Value *Role `json:"value"`
}
RoleWithMeta Persisted role along with metadata swagger:model RoleWithMeta
func (*RoleWithMeta) MarshalBinary ¶
func (m *RoleWithMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RoleWithMeta) UnmarshalBinary ¶
func (m *RoleWithMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RollingGrowShrinkStrategyConfig ¶
type RollingGrowShrinkStrategyConfig interface{}
RollingGrowShrinkStrategyConfig A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity. swagger:model RollingGrowShrinkStrategyConfig
type RollingStrategyConfig ¶
type RollingStrategyConfig struct {
// Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
AllowInlineResize *bool `json:"allow_inline_resize,omitempty"`
// Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '\_\_all\_\_' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '\_\_name\_\_' (roll one instance at a time, the default if not specified). Note that '\_\_all\_\_' is required when performing a major version upgrade
GroupBy string `json:"group_by,omitempty"`
// The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
ShardInitWaitTime int64 `json:"shard_init_wait_time,omitempty"`
// Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
SkipSyncedFlush *bool `json:"skip_synced_flush,omitempty"`
}
RollingStrategyConfig Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[__all__]';, rolling is required. swagger:model RollingStrategyConfig
func (*RollingStrategyConfig) MarshalBinary ¶
func (m *RollingStrategyConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RollingStrategyConfig) UnmarshalBinary ¶
func (m *RollingStrategyConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RuleSetResponse ¶
type RuleSetResponse struct {
// The new ruleset ID
// Required: true
ID *string `json:"id"`
}
RuleSetResponse The response after you create a new ruleset. swagger:model RuleSetResponse
func (*RuleSetResponse) MarshalBinary ¶
func (m *RuleSetResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RuleSetResponse) UnmarshalBinary ¶
func (m *RuleSetResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RulesetAssociations ¶
type RulesetAssociations struct {
// List of associations
// Required: true
Associations []*FilterAssociation `json:"associations"`
// Total number of associations. This includes associations the user does not have permission to view.
// Required: true
TotalAssociations *int32 `json:"total_associations"`
}
RulesetAssociations The configuration settings for the traffic filter. swagger:model RulesetAssociations
func (*RulesetAssociations) MarshalBinary ¶
func (m *RulesetAssociations) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RulesetAssociations) UnmarshalBinary ¶
func (m *RulesetAssociations) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RunnerBuildInfo ¶
type RunnerBuildInfo struct {
// Git commit hash
CommitHash string `json:"commit_hash,omitempty"`
// Version of the runner artifact
Version string `json:"version,omitempty"`
}
RunnerBuildInfo runner build info swagger:model RunnerBuildInfo
func (*RunnerBuildInfo) MarshalBinary ¶
func (m *RunnerBuildInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RunnerBuildInfo) UnmarshalBinary ¶
func (m *RunnerBuildInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RunnerContainerInfo ¶
type RunnerContainerInfo struct {
// Name of this container
// Required: true
ContainerName *string `json:"container_name"`
// Name of the container set for the container
// Required: true
ContainerSetName *string `json:"container_set_name"`
}
RunnerContainerInfo Information about a container within a runner. swagger:model RunnerContainerInfo
func (*RunnerContainerInfo) MarshalBinary ¶
func (m *RunnerContainerInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RunnerContainerInfo) UnmarshalBinary ¶
func (m *RunnerContainerInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RunnerInfo ¶
type RunnerInfo struct {
// Build Info of the container artifact
BuildInfo *RunnerBuildInfo `json:"build_info,omitempty"`
// Specifies if the runner is connected
// Required: true
Connected *bool `json:"connected"`
// Containers for the runner
// Required: true
Containers []*RunnerContainerInfo `json:"containers"`
// State of features of the runner
Features map[string]bool `json:"features,omitempty"`
// Specifies if the runner is healthy
// Required: true
Healthy *bool `json:"healthy"`
// Host IP for the runner
// Required: true
HostIP *string `json:"host_ip"`
// Public hostname for the runner
// Required: true
PublicHostname *string `json:"public_hostname"`
// The region that this runner belongs to. Only populated in SaaS or federated ECE.
Region string `json:"region,omitempty"`
// Roles for the runner
// Required: true
Roles []*RunnerRoleInfo `json:"roles"`
// The runner identifier
// Required: true
RunnerID *string `json:"runner_id"`
// The runner name
RunnerName string `json:"runner_name,omitempty"`
// Meta data of the runner, like image ID or processor architecture
Tags map[string]string `json:"tags,omitempty"`
// Identifier of the zone
Zone string `json:"zone,omitempty"`
}
RunnerInfo Information about a specified runner. swagger:model RunnerInfo
func (*RunnerInfo) MarshalBinary ¶
func (m *RunnerInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RunnerInfo) UnmarshalBinary ¶
func (m *RunnerInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RunnerOverview ¶
type RunnerOverview struct {
// List of runners
// Required: true
Runners []*RunnerInfo `json:"runners"`
}
RunnerOverview Information about all of the runners. swagger:model RunnerOverview
func (*RunnerOverview) MarshalBinary ¶
func (m *RunnerOverview) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RunnerOverview) UnmarshalBinary ¶
func (m *RunnerOverview) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RunnerRoleInfo ¶
type RunnerRoleInfo struct {
// Name of the role
// Required: true
RoleName *string `json:"role_name"`
}
RunnerRoleInfo Information about a runner role. swagger:model RunnerRoleInfo
func (*RunnerRoleInfo) MarshalBinary ¶
func (m *RunnerRoleInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RunnerRoleInfo) UnmarshalBinary ¶
func (m *RunnerRoleInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RunnerRolesInfo ¶
type RunnerRolesInfo struct {
// List of roles
// Required: true
Roles []*RunnerRoleInfo `json:"roles"`
}
RunnerRolesInfo A list of runner roles. swagger:model RunnerRolesInfo
func (*RunnerRolesInfo) MarshalBinary ¶
func (m *RunnerRolesInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RunnerRolesInfo) UnmarshalBinary ¶
func (m *RunnerRolesInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RunnersSummary ¶
type RunnersSummary struct {
// Total capacity of connected runners in megabytes
// Required: true
ConnectedCapacity *int32 `json:"connected_capacity"`
// Number of connected runners
// Required: true
ConnectedRunners *int32 `json:"connected_runners"`
// Total number of containers
// Required: true
ContainersCount *int32 `json:"containers_count"`
// Whether all runners are healthy
// Required: true
Healthy *bool `json:"healthy"`
// Maximum capacity available in one runner in megabytes
// Required: true
MaxAvailableCapacity *int32 `json:"max_available_capacity"`
// Total number of runners
// Required: true
TotalRunners *int32 `json:"total_runners"`
}
RunnersSummary Summarized information about the runners. swagger:model RunnersSummary
func (*RunnersSummary) MarshalBinary ¶
func (m *RunnersSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RunnersSummary) UnmarshalBinary ¶
func (m *RunnersSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SamlAttributeSettings ¶
type SamlAttributeSettings struct {
// The Name of the SAML attribute that contains the user's X.50 Distinguished Name
Dn string `json:"dn,omitempty"`
// The Name of the SAML attribute that contains the user's groups
// Required: true
Groups *string `json:"groups"`
// The Name of the SAML attribute that contains the user's email address
Mail string `json:"mail,omitempty"`
// The Name of the SAML attribute that contains the user's full name
Name string `json:"name,omitempty"`
// The Name of the SAML attribute that contains the user's principal (username)
// Required: true
Principal *string `json:"principal"`
}
SamlAttributeSettings The mapping configuration for the Elasticsearch security SAML attribute. swagger:model SamlAttributeSettings
func (*SamlAttributeSettings) MarshalBinary ¶
func (m *SamlAttributeSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SamlAttributeSettings) UnmarshalBinary ¶
func (m *SamlAttributeSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SamlIdpSettings ¶
type SamlIdpSettings struct {
// The Entity ID of the SAML Identity Provider. An Entity ID is a URI with a maximum length of 1024 characters. It can be a URL or a URN and can be found in the configuration or the SAML metadata of the Identity Provider.
// Required: true
EntityID *string `json:"entity_id"`
// The URL to a SAML 2.0 metadata file describing the capabilities and configuration of the Identity Provider
// Required: true
MetadataPath *string `json:"metadata_path"`
// Indicates whether to utilise the Identity Provider's Single Logout service
UseSingleLogout *bool `json:"use_single_logout,omitempty"`
}
SamlIdpSettings The configuration for the Elasticsearch security SAML Identity Provider. swagger:model SamlIdpSettings
func (*SamlIdpSettings) MarshalBinary ¶
func (m *SamlIdpSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SamlIdpSettings) UnmarshalBinary ¶
func (m *SamlIdpSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SamlSecurityRealmRoleMappingRule ¶
type SamlSecurityRealmRoleMappingRule struct {
// The roles that are applied when the mapping rule is successfully evaluated
// Required: true
Roles []string `json:"roles"`
// The type of role mapping rule
// Required: true
// Enum: [username groups dn]
Type *string `json:"type"`
// The value to match when evaluating this rule
// Required: true
Value *string `json:"value"`
}
SamlSecurityRealmRoleMappingRule The mapping rule for the Elasticsearch security SAML role. swagger:model SamlSecurityRealmRoleMappingRule
func (*SamlSecurityRealmRoleMappingRule) MarshalBinary ¶
func (m *SamlSecurityRealmRoleMappingRule) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SamlSecurityRealmRoleMappingRule) UnmarshalBinary ¶
func (m *SamlSecurityRealmRoleMappingRule) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SamlSecurityRealmRoleMappingRules ¶
type SamlSecurityRealmRoleMappingRules struct {
// The default roles applied to all users
// Required: true
DefaultRoles []string `json:"default_roles"`
// The role mapping rules to evaluate
// Required: true
Rules []*SamlSecurityRealmRoleMappingRule `json:"rules"`
}
SamlSecurityRealmRoleMappingRules The mapping ruleset for the Elasticsearch security SAML role. swagger:model SamlSecurityRealmRoleMappingRules
func (*SamlSecurityRealmRoleMappingRules) MarshalBinary ¶
func (m *SamlSecurityRealmRoleMappingRules) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SamlSecurityRealmRoleMappingRules) UnmarshalBinary ¶
func (m *SamlSecurityRealmRoleMappingRules) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SamlSettings ¶
type SamlSettings struct {
// The SAML attribute mapping configuration
// Required: true
Attributes *SamlAttributeSettings `json:"attributes"`
// When true, enables the security realm
Enabled *bool `json:"enabled,omitempty"`
// The SAML encryption certificate bundle URL. The bundle should be a zip file containing 'encryption.key' and 'encryption.pem' files in the directory '/saml/:id', where :id is the value of the [id] field.
EncryptionCertificateURL string `json:"encryption_certificate_url,omitempty"`
// The password to the encryption certificate bundle
EncryptionCertificateURLPassword string `json:"encryption_certificate_url_password,omitempty"`
// Specifies whether to set the ForceAuthn attribute when requesting that the IdP authenticate the current user. If set to true, the IdP is required to verify the user's identity, irrespective of any existing sessions they might have.
ForceAuthn *bool `json:"force_authn,omitempty"`
// The identifier for the security realm
// Required: true
ID *string `json:"id"`
// The SAML Identity Provider configuration
// Required: true
Idp *SamlIdpSettings `json:"idp"`
// The friendly name of the security realm
// Required: true
Name *string `json:"name"`
// The order that the security realm is evaluated
Order int32 `json:"order,omitempty"`
// Advanced configuration options in YAML format. Any settings defined here will override any configuration set via the API. Note that all keys should omit 'xpack.security.authc.realms.{realm_type}.{realm_id}'.
OverrideYaml string `json:"override_yaml,omitempty"`
// The role mapping rules associated with the security realm
RoleMappings *SamlSecurityRealmRoleMappingRules `json:"role_mappings,omitempty"`
// The SAML signing certificate bundle URL. The bundle should be a zip file containing 'signing.key' and 'signing.pem' files in the directory '/saml/:id', where :id is the value of the [id] field.
SigningCertificateURL string `json:"signing_certificate_url,omitempty"`
// The password to the signing certificate bundle
SigningCertificateURLPassword string `json:"signing_certificate_url_password,omitempty"`
// A list of SAML message types that should be signed. Each element in the list should be the local name of a SAML XML Element. Supported element types are AuthnRequest, LogoutRequest and LogoutResponse. Only valid if a signing certificate is also specified.
SigningSamlMessages []string `json:"signing_saml_messages"`
// The SAML Service Provider configuration
// Required: true
Sp *SamlSpSettings `json:"sp"`
// The SSL trusted CA certificate bundle URL. The bundle should be a zip file containing a single keystore file 'keystore.ks' Note that all keys should omit the 'xpack.security.authc.realms.saml.{realm_id}' prefix. For example, when the realm ID is set to 'saml1', the advanced configuration 'xpack.security.authc.realms.saml.saml1.ssl.verification_mode: full' should be added as 'ssl.verification_mode: full'.
SslCertificateURL string `json:"ssl_certificate_url,omitempty"`
// The password to the SSL certificate bundle URL truststore
SslCertificateURLTruststorePassword string `json:"ssl_certificate_url_truststore_password,omitempty"`
// The format of the keystore file. Should be jks to use the Java Keystore format or PKCS12 to use PKCS#12 files. The default is jks.
// Enum: [jks PKCS12]
SslCertificateURLTruststoreType string `json:"ssl_certificate_url_truststore_type,omitempty"`
}
SamlSettings The configuration for the Elasticsearch security SAML realm. swagger:model SamlSettings
func (*SamlSettings) MarshalBinary ¶
func (m *SamlSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SamlSettings) UnmarshalBinary ¶
func (m *SamlSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SamlSpSettings ¶
type SamlSpSettings struct {
// The URL of the Assertion Consumer service
// Required: true
Acs *string `json:"acs"`
// The Entity ID to use for this SAML Service Provider. This should be entered as a URI.
// Required: true
EntityID *string `json:"entity_id"`
// The URL of the Single Logout service
// Required: true
Logout *string `json:"logout"`
}
SamlSpSettings The configuration for the Elasticsearch security SAML Service Provider. swagger:model SamlSpSettings
func (*SamlSpSettings) MarshalBinary ¶
func (m *SamlSpSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SamlSpSettings) UnmarshalBinary ¶
func (m *SamlSpSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SearchRequest ¶
type SearchRequest struct {
// from
From int32 `json:"from,omitempty"`
// query
Query *QueryContainer `json:"query,omitempty"`
// The maximum number of search results to return.
Size int32 `json:"size,omitempty"`
// An array of fields to sort the search results by.
Sort []interface{} `json:"sort"`
}
SearchRequest An Elasticsearch search request with a subset of options. swagger:model SearchRequest
func (*SearchRequest) MarshalBinary ¶
func (m *SearchRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SearchRequest) UnmarshalBinary ¶
func (m *SearchRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SecurityDeployment ¶
type SecurityDeployment struct {
// The identifier for the security deployment cluster
// Required: true
ClusterID *string `json:"cluster_id"`
// True if a pending plan is in progress
// Required: true
HasPendingPlan *bool `json:"has_pending_plan"`
// True if the security cluster is currently enabled
// Required: true
IsEnabled *bool `json:"is_enabled"`
// True if the cluster is healthy
// Required: true
IsHealthy *bool `json:"is_healthy"`
// The name of the security deployment cluster
// Required: true
Name *string `json:"name"`
// The current status of the cluster
// Required: true
// Enum: [initializing stopping stopped rebooting restarting reconfiguring started]
Status *string `json:"status"`
// The version of the Elasticsearch cluster
Version string `json:"version,omitempty"`
}
SecurityDeployment The Elasticsearch security deployment. swagger:model SecurityDeployment
func (*SecurityDeployment) MarshalBinary ¶
func (m *SecurityDeployment) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecurityDeployment) UnmarshalBinary ¶
func (m *SecurityDeployment) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SecurityDeploymentCreateRequest ¶
type SecurityDeploymentCreateRequest struct {
// The name of the security deployment cluster
Name string `json:"name,omitempty"`
// The cluster topology used to create the security deployment cluster
Topology *SecurityDeploymentTopology `json:"topology,omitempty"`
// The version of the Elasticsearch cluster
Version string `json:"version,omitempty"`
}
SecurityDeploymentCreateRequest The creation request for the Elasticsearch security deployment. swagger:model SecurityDeploymentCreateRequest
func (*SecurityDeploymentCreateRequest) MarshalBinary ¶
func (m *SecurityDeploymentCreateRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecurityDeploymentCreateRequest) UnmarshalBinary ¶
func (m *SecurityDeploymentCreateRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SecurityDeploymentTopology ¶
type SecurityDeploymentTopology struct {
// The security deployment topology size
Size *TopologySize `json:"size,omitempty"`
// The number of zones in which data nodes will be placed
ZoneCount int32 `json:"zone_count,omitempty"`
}
SecurityDeploymentTopology The cluster topology for the Elasticsearch security deployment. swagger:model SecurityDeploymentTopology
func (*SecurityDeploymentTopology) MarshalBinary ¶
func (m *SecurityDeploymentTopology) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecurityDeploymentTopology) UnmarshalBinary ¶
func (m *SecurityDeploymentTopology) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SecurityDeploymentUpdateRequest ¶
type SecurityDeploymentUpdateRequest struct {
// The cluster topology changes to apply to the security deployment cluster. When not included, no topology changes are performed.
Topology *SecurityDeploymentTopology `json:"topology,omitempty"`
// The version of Elasticsearch to upgrade to. When not included, no upgrade is performed.
Version string `json:"version,omitempty"`
}
SecurityDeploymentUpdateRequest The update request for the Elasticsearch security deployment. swagger:model SecurityDeploymentUpdateRequest
func (*SecurityDeploymentUpdateRequest) MarshalBinary ¶
func (m *SecurityDeploymentUpdateRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecurityDeploymentUpdateRequest) UnmarshalBinary ¶
func (m *SecurityDeploymentUpdateRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SecurityRealmInfo ¶
type SecurityRealmInfo struct {
// True if the security realm is enabled
Enabled *bool `json:"enabled,omitempty"`
// The identifier for the security realm
// Required: true
ID *string `json:"id"`
// The friendly name of the security realm
// Required: true
Name *string `json:"name"`
// The order the security realm should be evaluated
Order int32 `json:"order,omitempty"`
// The type of the security realm
// Required: true
// Enum: [native ldap saml active_directory]
Type *string `json:"type"`
// The URLs associated with the security realm
// Required: true
Urls []string `json:"urls"`
}
SecurityRealmInfo The overview for the Elasticsearch security realm. swagger:model SecurityRealmInfo
func (*SecurityRealmInfo) MarshalBinary ¶
func (m *SecurityRealmInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecurityRealmInfo) UnmarshalBinary ¶
func (m *SecurityRealmInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SecurityRealmInfoList ¶
type SecurityRealmInfoList struct {
// The list of security realms
// Required: true
Realms []*SecurityRealmInfo `json:"realms"`
}
SecurityRealmInfoList A list of Elasticsearch security realms. swagger:model SecurityRealmInfoList
func (*SecurityRealmInfoList) MarshalBinary ¶
func (m *SecurityRealmInfoList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecurityRealmInfoList) UnmarshalBinary ¶
func (m *SecurityRealmInfoList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SecurityRealmsReorderRequest ¶
type SecurityRealmsReorderRequest struct {
// The list of security realms in the desired order
// Required: true
Realms []string `json:"realms"`
}
SecurityRealmsReorderRequest A reorder request for Elasticsearch security realms. swagger:model SecurityRealmsReorderRequest
func (*SecurityRealmsReorderRequest) MarshalBinary ¶
func (m *SecurityRealmsReorderRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecurityRealmsReorderRequest) UnmarshalBinary ¶
func (m *SecurityRealmsReorderRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SnapshotRepositoryConfiguration ¶
type SnapshotRepositoryConfiguration struct {
// Elasticsearch repository configuration settings JSON. See [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html) for more information
// Required: true
Settings interface{} `json:"settings"`
// Repository type, (Currently supported: 's3')
// Required: true
Type *string `json:"type"`
}
SnapshotRepositoryConfiguration The configuration for an Elasticsearch snapshot repository. swagger:model SnapshotRepositoryConfiguration
func (*SnapshotRepositoryConfiguration) MarshalBinary ¶
func (m *SnapshotRepositoryConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SnapshotRepositoryConfiguration) UnmarshalBinary ¶
func (m *SnapshotRepositoryConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SnapshotStatusInfo ¶
type SnapshotStatusInfo struct {
// Number of snapshots stored for this cluster
// Required: true
Count *int32 `json:"count"`
// Health status of snapshots for this cluster
// Required: true
Healthy *bool `json:"healthy"`
// The end time of the most recently attempted snapshot
// Format: date-time
LatestEndTime strfmt.DateTime `json:"latest_end_time,omitempty"`
// Status of the latest snapshot attempt, if any exist.
LatestStatus string `json:"latest_status,omitempty"`
// Latest snapshot status
LatestSuccessful *bool `json:"latest_successful,omitempty"`
// The end time of the most recently successful snapshot
// Format: date-time
LatestSuccessfulEndTime strfmt.DateTime `json:"latest_successful_end_time,omitempty"`
// Indicates whether the cluster has a relatively recent successful snapshot.
// Required: true
RecentSuccess *bool `json:"recent_success"`
// Scheduled time of next snapshot attempt
// Format: date-time
ScheduledTime strfmt.DateTime `json:"scheduled_time,omitempty"`
}
SnapshotStatusInfo Information about the snapshot status for the Elasticsearch cluster. For example, the health status. swagger:model SnapshotStatusInfo
func (*SnapshotStatusInfo) MarshalBinary ¶
func (m *SnapshotStatusInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SnapshotStatusInfo) UnmarshalBinary ¶
func (m *SnapshotStatusInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SsoAuthenticationMethodInfo ¶
type SsoAuthenticationMethodInfo struct {
// The friendly name of the single sign-on method.
// Required: true
Name *string `json:"name"`
// Indicates the protocol of the single sign-on method.
// Required: true
// Enum: [saml openid]
SsoType *string `json:"sso_type"`
// The URL to initiate the single sign-on login.
// Required: true
URL *string `json:"url"`
}
SsoAuthenticationMethodInfo Specifies the authentication methods that are enabled on the Elasticsearch cluster. NOTE: When all fields are `false`, only the Platform admin and Platform viewer are available. swagger:model SsoAuthenticationMethodInfo
func (*SsoAuthenticationMethodInfo) MarshalBinary ¶
func (m *SsoAuthenticationMethodInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SsoAuthenticationMethodInfo) UnmarshalBinary ¶
func (m *SsoAuthenticationMethodInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionApmConfig ¶
type StackVersionApmConfig struct {
// List of configuration options that cannot be overridden by user settings
// Required: true
Blacklist []string `json:"blacklist"`
// capacity constraints
CapacityConstraints *StackVersionInstanceCapacityConstraint `json:"capacity_constraints,omitempty"`
// Node types that are compatible with this one
CompatibleNodeTypes []string `json:"compatible_node_types"`
// Docker image for the APM
// Required: true
DockerImage *string `json:"docker_image"`
// Settings that are applied to all nodes of this type
Settings interface{} `json:"settings,omitempty"`
// Version of APM
Version string `json:"version,omitempty"`
}
StackVersionApmConfig The APM Server configuration for an Elastic Stack version. swagger:model StackVersionApmConfig
func (*StackVersionApmConfig) MarshalBinary ¶
func (m *StackVersionApmConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionApmConfig) UnmarshalBinary ¶
func (m *StackVersionApmConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionAppSearchConfig ¶
type StackVersionAppSearchConfig struct {
// List of configuration options that cannot be overridden by user settings
// Required: true
Blacklist []string `json:"blacklist"`
// capacity constraints
CapacityConstraints *StackVersionInstanceCapacityConstraint `json:"capacity_constraints,omitempty"`
// Node types that are compatible with this one
CompatibleNodeTypes []string `json:"compatible_node_types"`
// Docker image for the AppSearch
// Required: true
DockerImage *string `json:"docker_image"`
// Node types that are supported by this stack version
NodeTypes []*StackVersionNodeType `json:"node_types"`
// Settings that are applied to all nodes of this type
Settings interface{} `json:"settings,omitempty"`
// Version of AppSearch
Version string `json:"version,omitempty"`
}
StackVersionAppSearchConfig AppSearch related configuration of an Elastic Stack version swagger:model StackVersionAppSearchConfig
func (*StackVersionAppSearchConfig) MarshalBinary ¶
func (m *StackVersionAppSearchConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionAppSearchConfig) UnmarshalBinary ¶
func (m *StackVersionAppSearchConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionArchiveProcessingError ¶
type StackVersionArchiveProcessingError struct {
// errors
// Required: true
Errors *BasicFailedReply `json:"errors"`
// Version of the stack (ie directory name in archive root)
// Required: true
StackVersion *string `json:"stack_version"`
}
StackVersionArchiveProcessingError Information about the errors that occurred from processing an Elastic Stack version. swagger:model StackVersionArchiveProcessingError
func (*StackVersionArchiveProcessingError) MarshalBinary ¶
func (m *StackVersionArchiveProcessingError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionArchiveProcessingError) UnmarshalBinary ¶
func (m *StackVersionArchiveProcessingError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionArchiveProcessingResult ¶
type StackVersionArchiveProcessingResult struct {
// Errors occurred while processing the Elastic Stack pack. Key: stack version, Value: List of errors
// Required: true
Errors []*StackVersionArchiveProcessingError `json:"errors"`
// stacks
// Required: true
Stacks []*StackVersionConfig `json:"stacks"`
}
StackVersionArchiveProcessingResult The result from processing an archive of an Elastic Stack version. swagger:model StackVersionArchiveProcessingResult
func (*StackVersionArchiveProcessingResult) MarshalBinary ¶
func (m *StackVersionArchiveProcessingResult) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionArchiveProcessingResult) UnmarshalBinary ¶
func (m *StackVersionArchiveProcessingResult) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionConfig ¶
type StackVersionConfig struct {
// Whether or not this version is accessible by the calling user. This is only relevant in EC (SaaS) and is not sent in ECE.
Accessible *bool `json:"accessible,omitempty"`
// apm
Apm *StackVersionApmConfig `json:"apm,omitempty"`
// appsearch
Appsearch *StackVersionAppSearchConfig `json:"appsearch,omitempty"`
// Identifies that the Elastic Stack version is marked for deletion
// Read Only: true
Deleted *bool `json:"deleted,omitempty"`
// elasticsearch
// Required: true
Elasticsearch *StackVersionElasticsearchConfig `json:"elasticsearch"`
// enterprise search
EnterpriseSearch *StackVersionEnterpriseSearchConfig `json:"enterprise_search,omitempty"`
// kibana
// Required: true
Kibana *StackVersionKibanaConfig `json:"kibana"`
// metadata
Metadata *StackVersionMetadata `json:"metadata,omitempty"`
// The minimum version recommended to upgrade this version.
MinUpgradableFrom string `json:"min_upgradable_from,omitempty"`
// template
// Required: true
Template *StackVersionTemplateInfo `json:"template"`
// Stack Versions that this version can upgrade to
// Required: true
UpgradableTo []string `json:"upgradable_to"`
// Stack version
// Read Only: true
Version string `json:"version,omitempty"`
// Whether or not this version is whitelisted. This is only relevant in EC (SaaS) and is not sent in ECE.
Whitelisted *bool `json:"whitelisted,omitempty"`
}
StackVersionConfig The details for an Elastic Stack configuration. swagger:model StackVersionConfig
func (*StackVersionConfig) MarshalBinary ¶
func (m *StackVersionConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionConfig) UnmarshalBinary ¶
func (m *StackVersionConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionConfigPost ¶
type StackVersionConfigPost struct {
// apm
Apm *StackVersionApmConfig `json:"apm,omitempty"`
// appsearch
Appsearch *StackVersionAppSearchConfig `json:"appsearch,omitempty"`
// elasticsearch
// Required: true
Elasticsearch *StackVersionElasticsearchConfig `json:"elasticsearch"`
// enterprise search
EnterpriseSearch *StackVersionEnterpriseSearchConfig `json:"enterprise_search,omitempty"`
// kibana
// Required: true
Kibana *StackVersionKibanaConfig `json:"kibana"`
// metadata
Metadata *StackVersionMetadata `json:"metadata,omitempty"`
}
StackVersionConfigPost The configuration for an Elastic Stack version. swagger:model StackVersionConfigPost
func (*StackVersionConfigPost) MarshalBinary ¶
func (m *StackVersionConfigPost) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionConfigPost) UnmarshalBinary ¶
func (m *StackVersionConfigPost) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionConfigs ¶
type StackVersionConfigs struct {
// stacks
// Required: true
Stacks []*StackVersionConfig `json:"stacks"`
}
StackVersionConfigs The details for multiple Elastic Stack configurations. swagger:model StackVersionConfigs
func (*StackVersionConfigs) MarshalBinary ¶
func (m *StackVersionConfigs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionConfigs) UnmarshalBinary ¶
func (m *StackVersionConfigs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionElasticsearchConfig ¶
type StackVersionElasticsearchConfig struct {
// List of configuration options that cannot be overridden by user settings
// Required: true
Blacklist []string `json:"blacklist"`
// capacity constraints
CapacityConstraints *StackVersionInstanceCapacityConstraint `json:"capacity_constraints,omitempty"`
// Node types that are compatible with this one
CompatibleNodeTypes []string `json:"compatible_node_types"`
// List of default plugins
// Required: true
DefaultPlugins []string `json:"default_plugins"`
// Docker image for the Elasticsearch
// Required: true
DockerImage *string `json:"docker_image"`
// Node types that are supported by this stack version
NodeTypes []*StackVersionNodeType `json:"node_types"`
// List of available plugins
// Required: true
Plugins []string `json:"plugins"`
// Settings that are applied to all nodes of this type
Settings interface{} `json:"settings,omitempty"`
}
StackVersionElasticsearchConfig The Elasticsearch configuration for an Elastic Stack version. swagger:model StackVersionElasticsearchConfig
func (*StackVersionElasticsearchConfig) MarshalBinary ¶
func (m *StackVersionElasticsearchConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionElasticsearchConfig) UnmarshalBinary ¶
func (m *StackVersionElasticsearchConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionEnterpriseSearchConfig ¶
type StackVersionEnterpriseSearchConfig struct {
// List of configuration options that cannot be overridden by user settings
// Required: true
Blacklist []string `json:"blacklist"`
// capacity constraints
CapacityConstraints *StackVersionInstanceCapacityConstraint `json:"capacity_constraints,omitempty"`
// Node types that are compatible with this one
CompatibleNodeTypes []string `json:"compatible_node_types"`
// Docker image for the EnterpriseSearch
// Required: true
DockerImage *string `json:"docker_image"`
// Node types that are supported by this stack version
NodeTypes []*StackVersionNodeType `json:"node_types"`
// Settings that are applied to all nodes of this type
Settings interface{} `json:"settings,omitempty"`
// Version of EnterpriseSearch
Version string `json:"version,omitempty"`
}
StackVersionEnterpriseSearchConfig EnterpriseSearch related configuration of an Elastic Stack version swagger:model StackVersionEnterpriseSearchConfig
func (*StackVersionEnterpriseSearchConfig) MarshalBinary ¶
func (m *StackVersionEnterpriseSearchConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionEnterpriseSearchConfig) UnmarshalBinary ¶
func (m *StackVersionEnterpriseSearchConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionInstanceCapacityConstraint ¶
type StackVersionInstanceCapacityConstraint struct {
// Max capacity of the instances
// Required: true
Max *int32 `json:"max"`
// Min capacity of the instances
// Required: true
Min *int32 `json:"min"`
}
StackVersionInstanceCapacityConstraint The Elasticsearch instance, Kibana instance, APM Server capacity constraints for an Elastic Stack node type. swagger:model StackVersionInstanceCapacityConstraint
func (*StackVersionInstanceCapacityConstraint) MarshalBinary ¶
func (m *StackVersionInstanceCapacityConstraint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionInstanceCapacityConstraint) UnmarshalBinary ¶
func (m *StackVersionInstanceCapacityConstraint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionKibanaConfig ¶
type StackVersionKibanaConfig struct {
// List of configuration options that cannot be overridden by user settings
// Required: true
Blacklist []string `json:"blacklist"`
// capacity constraints
CapacityConstraints *StackVersionInstanceCapacityConstraint `json:"capacity_constraints,omitempty"`
// Node types that are compatible with this one
CompatibleNodeTypes []string `json:"compatible_node_types"`
// Docker image for the kibana
// Required: true
DockerImage *string `json:"docker_image"`
// Settings that are applied to all nodes of this type
Settings interface{} `json:"settings,omitempty"`
// Version of Kibana
Version string `json:"version,omitempty"`
}
StackVersionKibanaConfig The Kibana configuration for an Elastic Stack version. swagger:model StackVersionKibanaConfig
func (*StackVersionKibanaConfig) MarshalBinary ¶
func (m *StackVersionKibanaConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionKibanaConfig) UnmarshalBinary ¶
func (m *StackVersionKibanaConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionMetadata ¶
type StackVersionMetadata struct {
// The minimum version of the platform that the stack pack version is compatible with
MinPlatformVersion string `json:"min_platform_version,omitempty"`
// Notes for administrator
Notes string `json:"notes,omitempty"`
// Indicates that the stack pack version is not GA and is not supposed to be used in production
PreRelease *bool `json:"pre_release,omitempty"`
// The schema version of the stack pack version
SchemaVersion int32 `json:"schema_version,omitempty"`
}
StackVersionMetadata The metadata for the Elastic Stack. swagger:model StackVersionMetadata
func (*StackVersionMetadata) MarshalBinary ¶
func (m *StackVersionMetadata) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionMetadata) UnmarshalBinary ¶
func (m *StackVersionMetadata) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionNodeType ¶
type StackVersionNodeType struct {
// capacity constraints
CapacityConstraints *StackVersionInstanceCapacityConstraint `json:"capacity_constraints,omitempty"`
// Node types that are compatible with this one
CompatibleNodeTypes []string `json:"compatible_node_types"`
// Description of the node type
// Required: true
Description *string `json:"description"`
// Flag to specify a node type is mandatory in a cluster's plan
Mandatory *bool `json:"mandatory,omitempty"`
// Name of the node type
// Required: true
Name *string `json:"name"`
// Type of the node (master, data, ...)
// Required: true
NodeType *string `json:"node_type"`
// Settings that are applied to all nodes of this type
Settings interface{} `json:"settings,omitempty"`
}
StackVersionNodeType The configuration for an Elastic Stack node type. swagger:model StackVersionNodeType
func (*StackVersionNodeType) MarshalBinary ¶
func (m *StackVersionNodeType) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionNodeType) UnmarshalBinary ¶
func (m *StackVersionNodeType) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionTemplateFileHash ¶
type StackVersionTemplateFileHash struct {
// SHA-256 hash of a file
// Required: true
Hash *string `json:"hash"`
// File path relative to template's root
// Required: true
Path *string `json:"path"`
}
StackVersionTemplateFileHash The template file hash for an Elastic Stack version. swagger:model StackVersionTemplateFileHash
func (*StackVersionTemplateFileHash) MarshalBinary ¶
func (m *StackVersionTemplateFileHash) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionTemplateFileHash) UnmarshalBinary ¶
func (m *StackVersionTemplateFileHash) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StackVersionTemplateInfo ¶
type StackVersionTemplateInfo struct {
// Relative paths of files with SHA-256 hashes that contains the template
// Read Only: true
Hashes []*StackVersionTemplateFileHash `json:"hashes"`
// Template version
// Read Only: true
TemplateVersion string `json:"template_version,omitempty"`
}
StackVersionTemplateInfo The template information for an Elastic Stack version. swagger:model StackVersionTemplateInfo
func (*StackVersionTemplateInfo) MarshalBinary ¶
func (m *StackVersionTemplateInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StackVersionTemplateInfo) UnmarshalBinary ¶
func (m *StackVersionTemplateInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TLSPublicCertChain ¶
type TLSPublicCertChain struct {
// The list of PEM encoded X509 certificates that make up the certificate chain
// Required: true
Chain []string `json:"chain"`
// Was this certificate chain user supplied or automatically generated?
// Required: true
UserSupplied *bool `json:"user_supplied"`
}
TLSPublicCertChain The public portion of the certificate chain that contains the PEM encoded server certificate, intermediate certificates, and the CA certificate. NOTE: The private key, normally included in certificate chains, is omitted. swagger:model TlsPublicCertChain
func (*TLSPublicCertChain) MarshalBinary ¶
func (m *TLSPublicCertChain) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TLSPublicCertChain) UnmarshalBinary ¶
func (m *TLSPublicCertChain) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TargetElasticsearchCluster ¶
type TargetElasticsearchCluster struct {
// The Elasticsearch cluster Id
// Required: true
ElasticsearchID *string `json:"elasticsearch_id"`
// A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Links map[string]Hyperlink `json:"links,omitempty"`
}
TargetElasticsearchCluster Information about the specified Elasticsearch cluster. swagger:model TargetElasticsearchCluster
func (*TargetElasticsearchCluster) MarshalBinary ¶
func (m *TargetElasticsearchCluster) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TargetElasticsearchCluster) UnmarshalBinary ¶
func (m *TargetElasticsearchCluster) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TelemetryConfig ¶
type TelemetryConfig struct {
// Whether ECE telemetry is enabled
// Required: true
Enabled *bool `json:"enabled"`
}
TelemetryConfig The current ECE telemetry configuration swagger:model TelemetryConfig
func (*TelemetryConfig) MarshalBinary ¶
func (m *TelemetryConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TelemetryConfig) UnmarshalBinary ¶
func (m *TelemetryConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TelemetryConfigRequest ¶
type TelemetryConfigRequest struct {
// Whether to enable ECE telemetry
// Required: true
Enabled *bool `json:"enabled"`
}
TelemetryConfigRequest The desired ECE telemetry configuration swagger:model TelemetryConfigRequest
func (*TelemetryConfigRequest) MarshalBinary ¶
func (m *TelemetryConfigRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TelemetryConfigRequest) UnmarshalBinary ¶
func (m *TelemetryConfigRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TermQuery ¶
type TermQuery struct {
// The exact value to query for.
// Required: true
Value interface{} `json:"value"`
}
TermQuery A query for documents that contain the specified terms in the inverted index. swagger:model TermQuery
func (*TermQuery) MarshalBinary ¶
MarshalBinary interface implementation
func (*TermQuery) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type TiebreakerTopologyElement ¶
type TiebreakerTopologyElement struct {
// The memory capacity in MB for the tiebreaker node.
// Required: true
MemoryPerNode *int32 `json:"memory_per_node"`
}
TiebreakerTopologyElement Defines the topology, such as capacity and location, of the special tiebreaker node. TIP: When there are master nodes present, the master node topology is the default. swagger:model TiebreakerTopologyElement
func (*TiebreakerTopologyElement) MarshalBinary ¶
func (m *TiebreakerTopologyElement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TiebreakerTopologyElement) UnmarshalBinary ¶
func (m *TiebreakerTopologyElement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TokenResponse ¶
type TokenResponse struct {
// The authorization bearer token that you use in subsequent requests
// Required: true
Token *string `json:"token"`
}
TokenResponse The response value after a login without redirect configured, or after elevated permissions are enabled or disabled. swagger:model TokenResponse
func (*TokenResponse) MarshalBinary ¶
func (m *TokenResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TokenResponse) UnmarshalBinary ¶
func (m *TokenResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TopologySize ¶
type TopologySize struct {
// Type of resource
// Required: true
// Enum: [memory storage]
Resource *string `json:"resource"`
// Amount of resource
// Required: true
Value *int32 `json:"value"`
}
TopologySize Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration. swagger:model TopologySize
func (*TopologySize) MarshalBinary ¶
func (m *TopologySize) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TopologySize) UnmarshalBinary ¶
func (m *TopologySize) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TrafficFilterRule ¶
type TrafficFilterRule struct {
// Description of the rule
Description string `json:"description,omitempty"`
// The rule ID
ID string `json:"id,omitempty"`
// Allowed traffic filter source: IP address, CIDR mask, or VPC endpoint ID
// Required: true
Source *string `json:"source"`
}
TrafficFilterRule The container for an IP filter rule. swagger:model TrafficFilterRule
func (*TrafficFilterRule) MarshalBinary ¶
func (m *TrafficFilterRule) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TrafficFilterRule) UnmarshalBinary ¶
func (m *TrafficFilterRule) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TrafficFilterRulesetInfo ¶
type TrafficFilterRulesetInfo struct {
// List of associations. Returned only when include_associations query parameter is true
Associations []*FilterAssociation `json:"associations"`
// Description of the ruleset
Description string `json:"description,omitempty"`
// The ruleset ID
// Required: true
ID *string `json:"id"`
// Should the ruleset be automatically included in the new deployments
// Required: true
IncludeByDefault *bool `json:"include_by_default"`
// Name of the ruleset
// Required: true
Name *string `json:"name"`
// The ruleset can be attached only to deployments in the specific region
// Required: true
Region *string `json:"region"`
// List of rules
// Required: true
Rules []*TrafficFilterRule `json:"rules"`
// Total number of associations. This includes associations the user does not have permission to view.Returned only when include_associations query parameter is true
TotalAssociations int32 `json:"total_associations,omitempty"`
// Type of the ruleset
// Required: true
Type *string `json:"type"`
}
TrafficFilterRulesetInfo The container for a set of traffic filter rules. swagger:model TrafficFilterRulesetInfo
func (*TrafficFilterRulesetInfo) MarshalBinary ¶
func (m *TrafficFilterRulesetInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TrafficFilterRulesetInfo) UnmarshalBinary ¶
func (m *TrafficFilterRulesetInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TrafficFilterRulesetRequest ¶
type TrafficFilterRulesetRequest struct {
// Description of the ruleset
Description string `json:"description,omitempty"`
// Should the ruleset be automatically included in the new deployments
// Required: true
IncludeByDefault *bool `json:"include_by_default"`
// Name of the ruleset
// Required: true
Name *string `json:"name"`
// The ruleset can be attached only to deployments in the specific region
// Required: true
Region *string `json:"region"`
// List of rules
// Required: true
Rules []*TrafficFilterRule `json:"rules"`
// Type of the ruleset
// Required: true
Type *string `json:"type"`
}
TrafficFilterRulesetRequest The specification for traffic filter ruleset. swagger:model TrafficFilterRulesetRequest
func (*TrafficFilterRulesetRequest) MarshalBinary ¶
func (m *TrafficFilterRulesetRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TrafficFilterRulesetRequest) UnmarshalBinary ¶
func (m *TrafficFilterRulesetRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TrafficFilterRulesetResponse ¶
type TrafficFilterRulesetResponse struct {
// The new ruleset ID
// Required: true
ID *string `json:"id"`
}
TrafficFilterRulesetResponse The response after you create a new ruleset. swagger:model TrafficFilterRulesetResponse
func (*TrafficFilterRulesetResponse) MarshalBinary ¶
func (m *TrafficFilterRulesetResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TrafficFilterRulesetResponse) UnmarshalBinary ¶
func (m *TrafficFilterRulesetResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TrafficFilterRulesets ¶
type TrafficFilterRulesets struct {
// List of traffic filter rules
// Required: true
Rulesets []*TrafficFilterRulesetInfo `json:"rulesets"`
}
TrafficFilterRulesets The container for a set of traffic filter rulesets. swagger:model TrafficFilterRulesets
func (*TrafficFilterRulesets) MarshalBinary ¶
func (m *TrafficFilterRulesets) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TrafficFilterRulesets) UnmarshalBinary ¶
func (m *TrafficFilterRulesets) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TrafficFilterSettings ¶
type TrafficFilterSettings struct {
// IDs of the traffic filter rulesets
// Required: true
Rulesets []string `json:"rulesets"`
}
TrafficFilterSettings The configuration settings for the traffic filter. swagger:model TrafficFilterSettings
func (*TrafficFilterSettings) MarshalBinary ¶
func (m *TrafficFilterSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TrafficFilterSettings) UnmarshalBinary ¶
func (m *TrafficFilterSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TransientApmPlanConfiguration ¶
type TransientApmPlanConfiguration struct {
// plan configuration
PlanConfiguration *ApmPlanControlConfiguration `json:"plan_configuration,omitempty"`
// strategy
Strategy *PlanStrategy `json:"strategy,omitempty"`
}
TransientApmPlanConfiguration Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings. swagger:model TransientApmPlanConfiguration
func (*TransientApmPlanConfiguration) MarshalBinary ¶
func (m *TransientApmPlanConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TransientApmPlanConfiguration) UnmarshalBinary ¶
func (m *TransientApmPlanConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TransientAppSearchPlanConfiguration ¶
type TransientAppSearchPlanConfiguration struct {
// plan configuration
PlanConfiguration *AppSearchPlanControlConfiguration `json:"plan_configuration,omitempty"`
// strategy
Strategy *PlanStrategy `json:"strategy,omitempty"`
}
TransientAppSearchPlanConfiguration Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied swagger:model TransientAppSearchPlanConfiguration
func (*TransientAppSearchPlanConfiguration) MarshalBinary ¶
func (m *TransientAppSearchPlanConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TransientAppSearchPlanConfiguration) UnmarshalBinary ¶
func (m *TransientAppSearchPlanConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TransientElasticsearchPlanConfiguration ¶
type TransientElasticsearchPlanConfiguration struct {
// If specified, contains transient settings to be applied to an Elasticsearch cluster during changes, default values shown below applied.
// These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied.
// NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).
// - indices.store.throttle.max_bytes_per_sec: 150Mb
// - indices.recovery.max_bytes_per_sec: 150Mb
// - cluster.routing.allocation.cluster_concurrent_rebalance: 10
// - cluster.routing.allocation.node_initial_primaries_recoveries: 8
// - cluster.routing.allocation.node_concurrent_incoming_recoveries: 8
//
ClusterSettingsJSON interface{} `json:"cluster_settings_json,omitempty"`
// plan configuration
PlanConfiguration *ElasticsearchPlanControlConfiguration `json:"plan_configuration,omitempty"`
// restore snapshot
RestoreSnapshot *RestoreSnapshotConfiguration `json:"restore_snapshot,omitempty"`
// strategy
Strategy *PlanStrategy `json:"strategy,omitempty"`
}
TransientElasticsearchPlanConfiguration Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings. swagger:model TransientElasticsearchPlanConfiguration
func (*TransientElasticsearchPlanConfiguration) MarshalBinary ¶
func (m *TransientElasticsearchPlanConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TransientElasticsearchPlanConfiguration) UnmarshalBinary ¶
func (m *TransientElasticsearchPlanConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TransientEnterpriseSearchPlanConfiguration ¶
type TransientEnterpriseSearchPlanConfiguration struct {
// plan configuration
PlanConfiguration *EnterpriseSearchPlanControlConfiguration `json:"plan_configuration,omitempty"`
// strategy
Strategy *PlanStrategy `json:"strategy,omitempty"`
}
TransientEnterpriseSearchPlanConfiguration Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied swagger:model TransientEnterpriseSearchPlanConfiguration
func (*TransientEnterpriseSearchPlanConfiguration) MarshalBinary ¶
func (m *TransientEnterpriseSearchPlanConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TransientEnterpriseSearchPlanConfiguration) UnmarshalBinary ¶
func (m *TransientEnterpriseSearchPlanConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TransientKibanaPlanConfiguration ¶
type TransientKibanaPlanConfiguration struct {
// plan configuration
PlanConfiguration *KibanaPlanControlConfiguration `json:"plan_configuration,omitempty"`
// strategy
Strategy *PlanStrategy `json:"strategy,omitempty"`
}
TransientKibanaPlanConfiguration Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings. swagger:model TransientKibanaPlanConfiguration
func (*TransientKibanaPlanConfiguration) MarshalBinary ¶
func (m *TransientKibanaPlanConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TransientKibanaPlanConfiguration) UnmarshalBinary ¶
func (m *TransientKibanaPlanConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TrustSettings ¶
type TrustSettings struct {
// The list of trust relationships with different accounts
// Required: true
Accounts []*AccountTrustRelationship `json:"accounts"`
}
TrustSettings Configuration of trust with other clusters. swagger:model TrustSettings
func (*TrustSettings) MarshalBinary ¶
func (m *TrustSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TrustSettings) UnmarshalBinary ¶
func (m *TrustSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UnreachableRegionInfo ¶
type UnreachableRegionInfo struct {
// Identifier of this region
// Required: true
RegionID *string `json:"region_id"`
}
UnreachableRegionInfo Information about an unreachable region. swagger:model UnreachableRegionInfo
func (*UnreachableRegionInfo) MarshalBinary ¶
func (m *UnreachableRegionInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UnreachableRegionInfo) UnmarshalBinary ¶
func (m *UnreachableRegionInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateExtensionRequest ¶
type UpdateExtensionRequest struct {
// The extension description.
Description string `json:"description,omitempty"`
// The URL to download the extension archive.
DownloadURL string `json:"download_url,omitempty"`
// The extension type.
// Required: true
// Enum: [plugin bundle]
ExtensionType *string `json:"extension_type"`
// The extension name.
// Required: true
Name *string `json:"name"`
// The Elasticsearch version.
// Required: true
Version *string `json:"version"`
}
UpdateExtensionRequest The body of a request to update an extension swagger:model UpdateExtensionRequest
func (*UpdateExtensionRequest) MarshalBinary ¶
func (m *UpdateExtensionRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateExtensionRequest) UnmarshalBinary ¶
func (m *UpdateExtensionRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Updates ¶
type Updates struct {
// Diagnostics for APMs
Apm []*Apm `json:"apm"`
// Diagnostics for AppSearches
Appsearch []*AppSearch `json:"appsearch"`
// Diagnostics for Elasticsearch clusters
Elasticsearch []*Elasticsearch `json:"elasticsearch"`
// Diagnostics for Enterprise Search resources
EnterpriseSearch []*EnterpriseSearch `json:"enterprise_search"`
// Diagnostics for Kibanas
Kibana []*Kibana `json:"kibana"`
}
Updates Holds diagnostics for existing resources that might be updated swagger:model Updates
func (*Updates) MarshalBinary ¶
MarshalBinary interface implementation
func (*Updates) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type UsageStats ¶
type UsageStats struct {
// The total amount of memory available to your system
// Required: true
TotalConnectedMemoryTotal *int32 `json:"total_connected_memory_total"`
}
UsageStats Information about the current usage. swagger:model UsageStats
func (*UsageStats) MarshalBinary ¶
func (m *UsageStats) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UsageStats) UnmarshalBinary ¶
func (m *UsageStats) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type User ¶
type User struct {
// True if the user is a built-in read-only user
Builtin *bool `json:"builtin,omitempty"`
// The user's optional email address
Email string `json:"email,omitempty"`
// The user's optional full name
FullName string `json:"full_name,omitempty"`
// The users metadata
Metadata *UserMetadata `json:"metadata,omitempty"`
// The user's security information
// Required: true
Security *UserSecurity `json:"security"`
// The user's identifier
// Required: true
UserName *string `json:"user_name"`
}
User An API user swagger:model User
func (*User) MarshalBinary ¶
MarshalBinary interface implementation
func (*User) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type UserAPIKey ¶
type UserAPIKey struct {
// The API key ID.
// Required: true
APIKeyID *string `json:"api_key_id"`
// The user ID.
// Required: true
UserID *string `json:"user_id"`
}
UserAPIKey The model to specify a user and their API key in a delete request. swagger:model UserApiKey
func (*UserAPIKey) MarshalBinary ¶
func (m *UserAPIKey) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserAPIKey) UnmarshalBinary ¶
func (m *UserAPIKey) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UserList ¶
type UserList struct {
// A list of users
// Required: true
Users []*User `json:"users"`
}
UserList A collection of users swagger:model UserList
func (*UserList) MarshalBinary ¶
MarshalBinary interface implementation
func (*UserList) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type UserMetadata ¶
type UserMetadata struct {
// The date and time when the user was created
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty"`
// The Id of the user that created this user
CreatedBy string `json:"created_by,omitempty"`
// The date and time when the user first logged in
// Format: date-time
FirstLoginAt strfmt.DateTime `json:"first_login_at,omitempty"`
// The date and time when the user last logged in
// Format: date-time
LastLoginAt strfmt.DateTime `json:"last_login_at,omitempty"`
// The date and time when the user was last updated
// Format: date-time
UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"`
// The Id of the user that last updated this user
UpdatedBy string `json:"updated_by,omitempty"`
}
UserMetadata Metadata for a user swagger:model UserMetadata
func (*UserMetadata) MarshalBinary ¶
func (m *UserMetadata) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserMetadata) UnmarshalBinary ¶
func (m *UserMetadata) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UserSecurity ¶
type UserSecurity struct {
// The user's elevated permission status
ElevatedPermissions *ElevatedPermissions `json:"elevated_permissions,omitempty"`
// True if the user is enabled
Enabled *bool `json:"enabled,omitempty"`
// The user's password. Only used when modifying a user.
Password string `json:"password,omitempty"`
// The distinct set of permissions allowed by the user's roles. These correspond to operationId values in the OpenAPI definition.
Permissions []string `json:"permissions,omitempty"`
// The set of roles assigned to a user
Roles []string `json:"roles,omitempty"`
// The user's security realm
SecurityRealm *UserSecurityRealm `json:"security_realm,omitempty"`
}
UserSecurity A user's security information swagger:model UserSecurity
func (*UserSecurity) MarshalBinary ¶
func (m *UserSecurity) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserSecurity) UnmarshalBinary ¶
func (m *UserSecurity) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UserSecurityRealm ¶
type UserSecurityRealm struct {
// The identifier for the security realm
// Required: true
ID *string `json:"id"`
// The type of the security realm
// Required: true
// Enum: [native ldap saml active_directory]
Type *string `json:"type"`
}
UserSecurityRealm The security realm the user belongs to swagger:model UserSecurityRealm
func (*UserSecurityRealm) MarshalBinary ¶
func (m *UserSecurityRealm) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UserSecurityRealm) UnmarshalBinary ¶
func (m *UserSecurityRealm) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ZookeeperNodeInfo ¶
type ZookeeperNodeInfo struct {
// Identifier of this ZooKeeper node
// Required: true
ID *string `json:"id"`
// State of the ZooKeeper node
// Required: true
// Enum: [connected suspended reconnected lost read_only]
State *string `json:"state"`
}
ZookeeperNodeInfo Information about a ZooKeeper node. swagger:model ZookeeperNodeInfo
func (*ZookeeperNodeInfo) MarshalBinary ¶
func (m *ZookeeperNodeInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ZookeeperNodeInfo) UnmarshalBinary ¶
func (m *ZookeeperNodeInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ZookeeperSummary ¶
type ZookeeperSummary struct {
// Information about the nodes
// Required: true
States []*ZookeeperNodeInfo `json:"states"`
}
ZookeeperSummary Information about the ZooKeeper state. swagger:model ZookeeperSummary
func (*ZookeeperSummary) MarshalBinary ¶
func (m *ZookeeperSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ZookeeperSummary) UnmarshalBinary ¶
func (m *ZookeeperSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files
¶
- account_trust_relationship.go
- active_directory_group_search.go
- active_directory_security_realm_load_balance.go
- active_directory_security_realm_role_mapping_rule.go
- active_directory_security_realm_role_mapping_rules.go
- active_directory_settings.go
- active_directory_user_search.go
- adminconsole_info.go
- adminconsoles_overview.go
- allocated_instance_plans_info.go
- allocated_instance_status.go
- allocator_build_info.go
- allocator_capacity.go
- allocator_capacity_memory.go
- allocator_health_status.go
- allocator_info.go
- allocator_move_request.go
- allocator_overview.go
- allocator_settings.go
- allocator_zone_info.go
- allocators_summary.go
- allocators_zone_summary.go
- api_base_url_data.go
- api_key_response.go
- api_keys_response.go
- apm.go
- apm_configuration.go
- apm_crud_response.go
- apm_info.go
- apm_payload.go
- apm_plan.go
- apm_plan_control_configuration.go
- apm_plan_info.go
- apm_plans_info.go
- apm_resource_info.go
- apm_settings.go
- apm_sub_info.go
- apm_system_settings.go
- apm_topology_element.go
- apms_info.go
- app_search.go
- app_search_configuration.go
- app_search_info.go
- app_search_node_types.go
- app_search_payload.go
- app_search_plan.go
- app_search_plan_control_configuration.go
- app_search_plan_info.go
- app_search_plans_info.go
- app_search_resource_info.go
- app_search_settings.go
- app_search_sub_info.go
- app_search_system_settings.go
- app_search_topology_element.go
- authentication_info.go
- autodetect_strategy_config.go
- available_authentication_methods.go
- basic_failed_reply.go
- basic_failed_reply_element.go
- blessing.go
- blessings.go
- blessings_with_meta.go
- bool_query.go
- capacity_constraints_resource.go
- change_source_info.go
- cluster_command_response.go
- cluster_credentials.go
- cluster_crud_response.go
- cluster_curation_settings.go
- cluster_curation_spec.go
- cluster_info.go
- cluster_instance_configuration_info.go
- cluster_instance_disk_info.go
- cluster_instance_info.go
- cluster_instance_memory_info.go
- cluster_license_info.go
- cluster_metadata_cpu_resources_settings.go
- cluster_metadata_info.go
- cluster_metadata_port_info.go
- cluster_metadata_resources_settings.go
- cluster_metadata_settings.go
- cluster_plan_migration_response.go
- cluster_plan_step_info.go
- cluster_plan_step_log_message_info.go
- cluster_snapshot_repository_default.go
- cluster_snapshot_repository_info.go
- cluster_snapshot_repository_reference.go
- cluster_snapshot_repository_static.go
- cluster_snapshot_request.go
- cluster_snapshot_response.go
- cluster_snapshot_retention.go
- cluster_snapshot_settings.go
- cluster_system_alert.go
- cluster_topology_info.go
- cluster_upgrade_info.go
- clusters_info.go
- comment.go
- comment_create_request.go
- comment_update_request.go
- comment_with_meta.go
- comments_with_metas.go
- compatible_node_types_resource.go
- compatible_version_resource.go
- config_store_option.go
- config_store_option_data.go
- config_store_option_list.go
- constructor_health_status.go
- constructor_info.go
- constructor_overview.go
- container_config_host_config.go
- container_set_summary.go
- container_sets_summary.go
- containers_entry.go
- containers_entry_options.go
- containers_entry_options_acl.go
- containers_entry_options_auth.go
- containers_entry_options_container_config.go
- containers_entry_options_overrides.go
- coordinator_summary.go
- coordinators_summary.go
- create_api_key_request.go
- create_apm_in_create_elasticsearch_request.go
- create_apm_request.go
- create_app_search_request.go
- create_elasticsearch_cluster_request.go
- create_enterprise_search_request.go
- create_extension_request.go
- create_kibana_in_create_elasticsearch_request.go
- create_kibana_request.go
- creates.go
- cross_cluster_search_clusters.go
- cross_cluster_search_info.go
- cross_cluster_search_settings.go
- delete_api_keys_request.go
- delete_users_api_keys_request.go
- deployment_create_metadata.go
- deployment_create_request.go
- deployment_create_resources.go
- deployment_create_response.go
- deployment_create_settings.go
- deployment_delete_response.go
- deployment_diagnostics.go
- deployment_get_response.go
- deployment_metadata.go
- deployment_resource.go
- deployment_resource_command_response.go
- deployment_resource_crud_response.go
- deployment_resource_upgrade_response.go
- deployment_resources.go
- deployment_restore_response.go
- deployment_search_response.go
- deployment_settings.go
- deployment_shutdown_response.go
- deployment_template_definition_request.go
- deployment_template_info.go
- deployment_template_info_v2.go
- deployment_template_reference.go
- deployment_template_request_body.go
- deployment_update_metadata.go
- deployment_update_request.go
- deployment_update_resources.go
- deployment_update_response.go
- deployments_list_response.go
- deployments_listing_data.go
- deployments_search_response.go
- deprecated_elasticsearch_cluster_settings.go
- discrete_sizes.go
- elasticsearch.go
- elasticsearch_cluster_blocking_issue_element.go
- elasticsearch_cluster_blocking_issues.go
- elasticsearch_cluster_info.go
- elasticsearch_cluster_instance_settings_overrides.go
- elasticsearch_cluster_plan.go
- elasticsearch_cluster_plan_info.go
- elasticsearch_cluster_plans_info.go
- elasticsearch_cluster_role.go
- elasticsearch_cluster_security_info.go
- elasticsearch_cluster_settings.go
- elasticsearch_cluster_topology_element.go
- elasticsearch_cluster_user.go
- elasticsearch_clusters_info.go
- elasticsearch_configuration.go
- elasticsearch_curation.go
- elasticsearch_dependant.go
- elasticsearch_elastic_user_password_reset_response.go
- elasticsearch_info.go
- elasticsearch_master_element.go
- elasticsearch_master_info.go
- elasticsearch_monitoring_info.go
- elasticsearch_node_type.go
- elasticsearch_payload.go
- elasticsearch_plan_control_configuration.go
- elasticsearch_replica_element.go
- elasticsearch_resource_info.go
- elasticsearch_script_type_settings.go
- elasticsearch_scripting_user_settings.go
- elasticsearch_shard_element.go
- elasticsearch_shards_info.go
- elasticsearch_system_settings.go
- elasticsearch_user_bundle.go
- elasticsearch_user_plugin.go
- elevate_permissions_request.go
- elevated_permissions.go
- empty_response.go
- enable_ilm_request.go
- enrollment_token_request.go
- enterprise_search.go
- enterprise_search_configuration.go
- enterprise_search_info.go
- enterprise_search_node_types.go
- enterprise_search_payload.go
- enterprise_search_plan.go
- enterprise_search_plan_control_configuration.go
- enterprise_search_plan_info.go
- enterprise_search_plans_info.go
- enterprise_search_resource_info.go
- enterprise_search_settings.go
- enterprise_search_sub_info.go
- enterprise_search_system_settings.go
- enterprise_search_topology_element.go
- exists_query.go
- extension.go
- extensions.go
- external_hyperlink.go
- filter_association.go
- grow_shrink_strategy_config.go
- hyperlink.go
- id_response.go
- index_pattern.go
- index_synchronization_results.go
- instance_configuration.go
- instance_configuration_info.go
- instance_move_request.go
- instance_type_resource.go
- ip_filter_rule.go
- ip_filter_ruleset.go
- ip_filter_rulesets.go
- ip_filtering_settings.go
- keystore_contents.go
- keystore_secret.go
- kibana.go
- kibana_cluster_info.go
- kibana_cluster_plan.go
- kibana_cluster_plan_info.go
- kibana_cluster_plans_info.go
- kibana_cluster_settings.go
- kibana_cluster_topology_element.go
- kibana_clusters_info.go
- kibana_configuration.go
- kibana_payload.go
- kibana_plan_control_configuration.go
- kibana_resource_info.go
- kibana_sub_cluster_info.go
- kibana_system_settings.go
- ldap_group_search.go
- ldap_security_realm_load_balance.go
- ldap_security_realm_role_mapping_rule.go
- ldap_security_realm_role_mapping_rules.go
- ldap_settings.go
- ldap_user_search.go
- legacy_security_settings.go
- license_info.go
- license_object.go
- list_enrollment_token_element.go
- list_enrollment_token_reply.go
- logging_settings.go
- login_request.go
- login_state.go
- managed_monitoring_settings.go
- match_all_query.go
- match_none_query.go
- match_query.go
- metadata.go
- metadata_item.go
- metadata_item_value.go
- metadata_items.go
- model_version_index_synchronization_results.go
- move_apm_cluster_configuration.go
- move_apm_cluster_details.go
- move_app_search_configuration.go
- move_app_search_details.go
- move_clusters_command_response.go
- move_clusters_details.go
- move_clusters_request.go
- move_elasticsearch_cluster_configuration.go
- move_elasticsearch_cluster_details.go
- move_enterprise_search_configuration.go
- move_enterprise_search_details.go
- move_kibana_cluster_configuration.go
- move_kibana_cluster_details.go
- nested_query.go
- node_type_resource.go
- note.go
- notes.go
- orphaned.go
- orphaned_elasticsearch.go
- pending_state.go
- pending_states.go
- pending_states_with_meta.go
- plan_strategy.go
- platform_info.go
- platform_resources_summary.go
- platform_service_image_info.go
- platform_service_info.go
- port_binding.go
- prefix_query.go
- proxies_allocations_info.go
- proxies_filter.go
- proxies_filtered_group.go
- proxies_filtered_group_health.go
- proxies_health.go
- proxies_http_settings.go
- proxies_s_s_o_settings.go
- proxies_settings.go
- proxies_summary.go
- proxy_allocation_counts.go
- proxy_allocation_info.go
- proxy_info.go
- proxy_overview.go
- proxy_summary.go
- public_cert_chain.go
- public_cert_chain_collection.go
- query_container.go
- query_string_query.go
- range_query.go
- re_authentication_request.go
- re_authentication_response.go
- read_only_request.go
- read_only_response.go
- region_info.go
- remote_cluster_info.go
- remote_cluster_ref.go
- remote_resource_ref.go
- remote_resources.go
- reply_warning.go
- repository_config.go
- repository_configs.go
- request_enrollment_token_reply.go
- restart_policy.go
- restore_snapshot_api_configuration.go
- restore_snapshot_configuration.go
- restore_snapshot_repo_configuration.go
- role.go
- role_aggregate.go
- role_aggregate_create_data.go
- role_aggregates.go
- role_with_meta.go
- rolling_grow_shrink_strategy_config.go
- rolling_strategy_config.go
- rule_set_response.go
- ruleset_associations.go
- runner_build_info.go
- runner_container_info.go
- runner_info.go
- runner_overview.go
- runner_role_info.go
- runner_roles_info.go
- runners_summary.go
- saml_attribute_settings.go
- saml_idp_settings.go
- saml_security_realm_role_mapping_rule.go
- saml_security_realm_role_mapping_rules.go
- saml_settings.go
- saml_sp_settings.go
- search_request.go
- security_deployment.go
- security_deployment_create_request.go
- security_deployment_topology.go
- security_deployment_update_request.go
- security_realm_info.go
- security_realm_info_list.go
- security_realms_reorder_request.go
- snapshot_repository_configuration.go
- snapshot_status_info.go
- sso_authentication_method_info.go
- stack_version_apm_config.go
- stack_version_app_search_config.go
- stack_version_archive_processing_error.go
- stack_version_archive_processing_result.go
- stack_version_config.go
- stack_version_config_post.go
- stack_version_configs.go
- stack_version_elasticsearch_config.go
- stack_version_enterprise_search_config.go
- stack_version_instance_capacity_constraint.go
- stack_version_kibana_config.go
- stack_version_metadata.go
- stack_version_node_type.go
- stack_version_template_file_hash.go
- stack_version_template_info.go
- target_elasticsearch_cluster.go
- telemetry_config.go
- telemetry_config_request.go
- term_query.go
- tiebreaker_topology_element.go
- tls_public_cert_chain.go
- token_response.go
- topology_size.go
- traffic_filter_rule.go
- traffic_filter_ruleset_info.go
- traffic_filter_ruleset_request.go
- traffic_filter_ruleset_response.go
- traffic_filter_rulesets.go
- traffic_filter_settings.go
- transient_apm_plan_configuration.go
- transient_app_search_plan_configuration.go
- transient_elasticsearch_plan_configuration.go
- transient_enterprise_search_plan_configuration.go
- transient_kibana_plan_configuration.go
- trust_settings.go
- unreachable_region_info.go
- update_extension_request.go
- updates.go
- usage_stats.go
- user.go
- user_api_key.go
- user_list.go
- user_metadata.go
- user_security.go
- user_security_realm.go
- zookeeper_node_info.go
- zookeeper_summary.go