A B C D E F G H I L M P Q R S T U V W X Z

A

accept(Path) - Method in interface com.yahoo.config.application.api.ApplicationFile.PathFilter

active() - Method in class com.yahoo.config.application.api.DeploymentSpec.DeclaredZone

Returns whether this zone should receive production traffic

addFile(String) - Method in interface com.yahoo.config.application.api.FileRegistry

addUri(String) - Method in interface com.yahoo.config.application.api.FileRegistry

Allow(ValidationId, Instant) - Constructor for class com.yahoo.config.application.api.ValidationOverrides.Allow

allows(ValidationId, Instant) - Method in class com.yahoo.config.application.api.ValidationOverrides.Allow

allows(String, Instant) - Method in class com.yahoo.config.application.api.ValidationOverrides

allows(ValidationId, Instant) - Method in class com.yahoo.config.application.api.ValidationOverrides

Returns whether the given (assumed invalid) change is allowed by this at the moment

appendFile(String) - Method in class com.yahoo.config.application.api.ApplicationFile

Appends the given string to this text file.

ApplicationFile - Class in com.yahoo.config.application.api

An application file represents a file within an application package.

ApplicationFile(Path) - Constructor for class com.yahoo.config.application.api.ApplicationFile

ApplicationFile.MetaData - Class in com.yahoo.config.application.api

ApplicationFile.PathFilter - Interface in com.yahoo.config.application.api

ApplicationMetaData - Class in com.yahoo.config.application.api

Metadata about an application package.

ApplicationMetaData(File, String, String, Long, boolean, String, Long, long) - Constructor for class com.yahoo.config.application.api.ApplicationMetaData

ApplicationMetaData(String, String, Long, boolean, String, String, Long, long) - Constructor for class com.yahoo.config.application.api.ApplicationMetaData

ApplicationPackage - Interface in com.yahoo.config.application.api

Represents an application package, that is, used as input when creating a VespaModel and as a general reference to all contents in an application.

asJsonString() - Method in class com.yahoo.config.application.api.ApplicationMetaData

athenzDomain() - Method in class com.yahoo.config.application.api.DeploymentSpec

Returns the athenz domain if configured

athenzService(Environment, RegionName) - Method in class com.yahoo.config.application.api.DeploymentSpec

Returns the athenz service for environment/region if configured

athenzService() - Method in class com.yahoo.config.application.api.DeploymentSpec.DeclaredZone

B

blocksRevisions() - Method in class com.yahoo.config.application.api.DeploymentSpec.ChangeBlocker

blocksVersions() - Method in class com.yahoo.config.application.api.DeploymentSpec.ChangeBlocker

C

canChangeRevisionAt(Instant) - Method in class com.yahoo.config.application.api.DeploymentSpec

Returns whether an application revision change can occur at the given instant

canUpgradeAt(Instant) - Method in class com.yahoo.config.application.api.DeploymentSpec

Returns whether upgrade can occur at the given instant

changeBlocker() - Method in class com.yahoo.config.application.api.DeploymentSpec

Returns time windows where upgrades are disallowed

ChangeBlocker(boolean, boolean, TimeWindow) - Constructor for class com.yahoo.config.application.api.DeploymentSpec.ChangeBlocker

com.yahoo.config.application.api - package com.yahoo.config.application.api

COMPONENT_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

ComponentInfo - Class in com.yahoo.config.application.api

Describes a component residing in the components directory.

ComponentInfo(String) - Constructor for class com.yahoo.config.application.api.ComponentInfo

CONFIG_DEFINITIONS_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

Do not use

ContentStatusChanged - Static variable in class com.yahoo.config.application.api.ApplicationFile

ContentStatusDeleted - Static variable in class com.yahoo.config.application.api.ApplicationFile

ContentStatusNew - Static variable in class com.yahoo.config.application.api.ApplicationFile

createDirectory() - Method in class com.yahoo.config.application.api.ApplicationFile

Create a directory at the path represented by this file.

createInputStream() - Method in class com.yahoo.config.application.api.ApplicationFile

Create an InputStream for the contents of this file.

createReader() - Method in class com.yahoo.config.application.api.ApplicationFile

Create a Reader for the contents of this file.

D

days() - Method in class com.yahoo.config.application.api.TimeWindow

Returns days in this time window

DeclaredZone(Environment) - Constructor for class com.yahoo.config.application.api.DeploymentSpec.DeclaredZone

DeclaredZone(Environment, Optional<RegionName>, boolean) - Constructor for class com.yahoo.config.application.api.DeploymentSpec.DeclaredZone

DeclaredZone(Environment, Optional<RegionName>, boolean, Optional<AthenzService>) - Constructor for class com.yahoo.config.application.api.DeploymentSpec.DeclaredZone

Delay(Duration) - Constructor for class com.yahoo.config.application.api.DeploymentSpec.Delay

delete() - Method in class com.yahoo.config.application.api.ApplicationFile

Delete the file pointed to by this.

DeployLogger - Interface in com.yahoo.config.application.api

Used during application deployment to propagate messages to the end user

DEPLOYMENT_FILE - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

DeploymentSpec - Class in com.yahoo.config.application.api

Specifies the environments and regions to which an application should be deployed.

DeploymentSpec(Optional<String>, DeploymentSpec.UpgradePolicy, List<DeploymentSpec.ChangeBlocker>, List<DeploymentSpec.Step>) - Constructor for class com.yahoo.config.application.api.DeploymentSpec

DeploymentSpec(Optional<String>, DeploymentSpec.UpgradePolicy, List<DeploymentSpec.ChangeBlocker>, List<DeploymentSpec.Step>, String, Optional<AthenzDomain>, Optional<AthenzService>) - Constructor for class com.yahoo.config.application.api.DeploymentSpec

DeploymentSpec.ChangeBlocker - Class in com.yahoo.config.application.api

A blocking of changes in a given time window

DeploymentSpec.DeclaredZone - Class in com.yahoo.config.application.api

A deployment step which is to run deployment in a particular zone

DeploymentSpec.Delay - Class in com.yahoo.config.application.api

A deployment step which is to wait for some time before progressing to the next step

DeploymentSpec.ParallelZones - Class in com.yahoo.config.application.api

A deployment step which is to run deployment to multiple zones in parallel

DeploymentSpec.Step - Class in com.yahoo.config.application.api

A deployment step

DeploymentSpec.UpgradePolicy - Enum in com.yahoo.config.application.api

Controls when this application will be upgraded to new Vespa versions

deploysTo(Environment, Optional<RegionName>) - Method in class com.yahoo.config.application.api.DeploymentSpec.DeclaredZone

deploysTo(Environment, Optional<RegionName>) - Method in class com.yahoo.config.application.api.DeploymentSpec.Delay

deploysTo(Environment, Optional<RegionName>) - Method in class com.yahoo.config.application.api.DeploymentSpec.ParallelZones

deploysTo(Environment) - Method in class com.yahoo.config.application.api.DeploymentSpec.Step

Returns whether this step deploys to the given region

deploysTo(Environment, Optional<RegionName>) - Method in class com.yahoo.config.application.api.DeploymentSpec.Step

Returns whether this step deploys to the given environment, and (if specified) region

DOCPROCCHAINS_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

duration() - Method in class com.yahoo.config.application.api.DeploymentSpec.Delay

E

empty - Static variable in class com.yahoo.config.application.api.DeploymentSpec

The empty deployment spec, specifying no zones or rotation, and defaults for all settings

empty - Static variable in class com.yahoo.config.application.api.ValidationOverrides

Entry(String, FileReference) - Constructor for class com.yahoo.config.application.api.FileRegistry.Entry

environment() - Method in class com.yahoo.config.application.api.DeploymentSpec.DeclaredZone

equals(Object) - Method in class com.yahoo.config.application.api.ApplicationFile

equals(Object) - Method in class com.yahoo.config.application.api.DeploymentSpec.DeclaredZone

equals(Object) - Method in class com.yahoo.config.application.api.DeploymentSpec.ParallelZones

exists() - Method in class com.yahoo.config.application.api.ApplicationFile

Test whether or not this file exists.

export() - Method in interface com.yahoo.config.application.api.FileRegistry

EXT_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

F

FileRegistry - Interface in com.yahoo.config.application.api

FileRegistry.Entry - Class in com.yahoo.config.application.api

fileSourceHost() - Method in interface com.yahoo.config.application.api.FileRegistry

Returns the name of the host which is the source of the files

from(String, String, String) - Static method in class com.yahoo.config.application.api.TimeWindow

Parse a time window from the given day, hour and time zone specification

from(String) - Static method in enum com.yahoo.config.application.api.ValidationId

Returns the validation id from this string.

fromJsonString(String) - Static method in class com.yahoo.config.application.api.ApplicationMetaData

fromXml(Reader) - Static method in class com.yahoo.config.application.api.DeploymentSpec

Creates a deployment spec from XML.

fromXml(String) - Static method in class com.yahoo.config.application.api.DeploymentSpec

Creates a deployment spec from XML.

fromXml(String, boolean) - Static method in class com.yahoo.config.application.api.DeploymentSpec

Creates a deployment spec from XML.

fromXml(Reader) - Static method in class com.yahoo.config.application.api.ValidationOverrides

Returns a ValidationOverrides instance with the content of the given Reader.

fromXml(String) - Static method in class com.yahoo.config.application.api.ValidationOverrides

Returns a ValidationOverrides instance with the content of the given XML string.

G

getAllExistingConfigDefs() - Method in interface com.yahoo.config.application.api.ApplicationPackage

Returns all the config definitions available in this package as unparsed data.

getAllocatedHosts() - Method in interface com.yahoo.config.application.api.ApplicationPackage

Returns the host allocation info of this, or empty if no allocation is available

getApplicationName() - Method in class com.yahoo.config.application.api.ApplicationMetaData

Gets the name of the application (name of the directory from which application was deployed.

getApplicationName() - Method in interface com.yahoo.config.application.api.ApplicationPackage

The name of the application package

getBundleSdFiles(String, JarFile) - Static method in interface com.yahoo.config.application.api.ApplicationPackage

Returns the name-payload pairs of any sd files under path/searchdefinitions/ in the given jar bundle

getCheckSum() - Method in class com.yahoo.config.application.api.ApplicationMetaData

Returns an md5 hash of the contents of the application package

getComponentsInfo(Version) - Method in interface com.yahoo.config.application.api.ApplicationPackage

getDeployedByUser() - Method in class com.yahoo.config.application.api.ApplicationMetaData

Gets the user who deployed the application.

getDeployment() - Method in interface com.yahoo.config.application.api.ApplicationPackage

getDeployPath() - Method in class com.yahoo.config.application.api.ApplicationMetaData

Gets the directory where the application was deployed from.

getDeployTimestamp() - Method in class com.yahoo.config.application.api.ApplicationMetaData

Gets the time the application was deployed Will return null if a problem occurred while getting metadata

getFile(Path) - Method in interface com.yahoo.config.application.api.ApplicationPackage

Returns inforamtion about a file

getFileName(JarEntry) - Static method in interface com.yahoo.config.application.api.ApplicationPackage

The name of an SD in a JarEntry

getFileReference(Path) - Method in interface com.yahoo.config.application.api.ApplicationPackage

getFileRegistryMap() - Method in interface com.yahoo.config.application.api.ApplicationPackage

getFiles(Path, String, boolean) - Method in interface com.yahoo.config.application.api.ApplicationPackage

Returns the files in a directory as readers.

getFiles(Path, String) - Method in interface com.yahoo.config.application.api.ApplicationPackage

Same as getFiles(pathFromRoot, suffix, false)

getGeneration() - Method in class com.yahoo.config.application.api.ApplicationMetaData

Gets the time the application was deployed Will return null if a problem occurred while getting metadata

getHosts() - Method in interface com.yahoo.config.application.api.ApplicationPackage

Contents of hosts.xml.

getHostSource() - Method in interface com.yahoo.config.application.api.ApplicationPackage

getMajorVersion() - Method in interface com.yahoo.config.application.api.ApplicationPackage

Returns the major version this application is valid for, or empty if it is valid for all versions

getMd5() - Method in class com.yahoo.config.application.api.ApplicationFile.MetaData

getMessage() - Method in exception com.yahoo.config.application.api.ValidationOverrides.ValidationException

Returns "validationId: message"

getMetaData() - Method in class com.yahoo.config.application.api.ApplicationFile

getMetaData() - Method in interface com.yahoo.config.application.api.ApplicationPackage

Gets the ApplicationMetaData instance for this application package.

getMetaPath() - Method in class com.yahoo.config.application.api.ApplicationFile

getPageTemplateFiles() - Method in interface com.yahoo.config.application.api.ApplicationPackage

Does ApplicationPackage.getFiles(com.yahoo.path.Path, java.lang.String, boolean) on the page template directory and gets all xml files

getPath() - Method in class com.yahoo.config.application.api.ApplicationFile

Get the path that this file represents.

getPathRelativeToAppDir() - Method in class com.yahoo.config.application.api.ComponentInfo

getPreviousActiveGeneration() - Method in class com.yahoo.config.application.api.ApplicationMetaData

Returns the previously active generation at the point when this application was created.

getProvisionInfoMap() - Method in interface com.yahoo.config.application.api.ApplicationPackage

Deprecated.

please use #getAllocatedHosts

getQueryProfileFiles() - Method in interface com.yahoo.config.application.api.ApplicationPackage

Does ApplicationPackage.getFiles(com.yahoo.path.Path, java.lang.String, boolean) on the query profile directory and gets all xml files

getQueryProfileTypeFiles() - Method in interface com.yahoo.config.application.api.ApplicationPackage

Does ApplicationPackage.getFiles(com.yahoo.path.Path, java.lang.String, boolean) on the query profile directory and gets all xml files

getRankingExpression(String) - Method in interface com.yahoo.config.application.api.ApplicationPackage

Reads a ranking expression from file to a string and returns it.

getSearchDefinitions() - Method in interface com.yahoo.config.application.api.ApplicationPackage

getServices() - Method in interface com.yahoo.config.application.api.ApplicationPackage

Contents of services.xml.

getServicesSource() - Method in interface com.yahoo.config.application.api.ApplicationPackage

getSlime() - Method in class com.yahoo.config.application.api.ApplicationMetaData

getStatus() - Method in class com.yahoo.config.application.api.ApplicationFile.MetaData

getUnparsedContent() - Method in interface com.yahoo.config.application.api.UnparsedConfigDefinition

getUserIncludeDirs() - Method in interface com.yahoo.config.application.api.ApplicationPackage

Returns the include dirs given by the user in the services.xml file.

getValidationOverrides() - Method in interface com.yahoo.config.application.api.ApplicationPackage

globalServiceId() - Method in class com.yahoo.config.application.api.DeploymentSpec

Returns the ID of the service to expose through global routing, if present

H

hashCode() - Method in class com.yahoo.config.application.api.DeploymentSpec.DeclaredZone

hashCode() - Method in class com.yahoo.config.application.api.DeploymentSpec.ParallelZones

HOSTS - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

hours() - Method in class com.yahoo.config.application.api.TimeWindow

Returns hours in this time window

I

includes(Environment, Optional<RegionName>) - Method in class com.yahoo.config.application.api.DeploymentSpec

Returns whether this deployment spec specifies the given zone, either implicitly or explicitly

includes(Instant) - Method in class com.yahoo.config.application.api.TimeWindow

Returns whether the given instant is in this time window

invalid(ValidationId, String, Instant) - Method in class com.yahoo.config.application.api.ValidationOverrides

Throws a ValidationException unless this validation is overridden at this time

isDirectory() - Method in class com.yahoo.config.application.api.ApplicationFile

Check whether or not this file is a directory.

isInternalRedeploy() - Method in class com.yahoo.config.application.api.ApplicationMetaData

Returns whether this application generation was produced by a system internal redeployment, not an application package change

L

listFiles() - Method in class com.yahoo.config.application.api.ApplicationFile

List the files under this directory.

listFiles(ApplicationFile.PathFilter) - Method in class com.yahoo.config.application.api.ApplicationFile

List the files under this directory.

listFiles(boolean) - Method in class com.yahoo.config.application.api.ApplicationFile

List the files in this directory, optionally list files for subdirectories recursively as well.

log(Level, String) - Method in interface com.yahoo.config.application.api.DeployLogger

M

main(String[]) - Static method in class com.yahoo.config.application.api.DeploymentSpec

This may be invoked by a continuous build

md5 - Variable in class com.yahoo.config.application.api.ApplicationFile.MetaData

MetaData() - Constructor for class com.yahoo.config.application.api.ApplicationFile.MetaData

MetaData(String, String) - Constructor for class com.yahoo.config.application.api.ApplicationFile.MetaData

MODELS_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

Machine-learned models - only present in user-uploaded package instances

MODELS_GENERATED_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

Files generated from machine-learned models

MODELS_GENERATED_REPLICATED_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

Files generated from machine-learned models which should be replicated in ZooKeeper

P

PAGE_TEMPLATES_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

ParallelZones(List<DeploymentSpec.DeclaredZone>) - Constructor for class com.yahoo.config.application.api.DeploymentSpec.ParallelZones

parse() - Method in interface com.yahoo.config.application.api.UnparsedConfigDefinition

path - Variable in class com.yahoo.config.application.api.ApplicationFile

PERMANENT_SERVICES - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

preprocess(Zone, DeployLogger) - Method in interface com.yahoo.config.application.api.ApplicationPackage

Preprocess an application for a given zone and return a new application package pointing to the preprocessed application package.

PROCESSORCHAINS_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

Q

QUERY_PROFILE_TYPES_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

QUERY_PROFILES_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

R

RANKEXPRESSION_NAME_SUFFIX - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

reference - Variable in class com.yahoo.config.application.api.FileRegistry.Entry

region() - Method in class com.yahoo.config.application.api.DeploymentSpec.DeclaredZone

The region name, or empty if not declared

relativePath - Variable in class com.yahoo.config.application.api.FileRegistry.Entry

ROUTINGTABLES_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

RULES_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

RULES_NAME_SUFFIX - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

S

SD_NAME_SUFFIX - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

SEARCH_DEFINITIONS_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

SEARCHCHAINS_DIR - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

searchDefinitionContents() - Method in interface com.yahoo.config.application.api.ApplicationPackage

Readers for all the search definition files for this.

SERVICES - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

status - Variable in class com.yahoo.config.application.api.ApplicationFile.MetaData

Step() - Constructor for class com.yahoo.config.application.api.DeploymentSpec.Step

steps() - Method in class com.yahoo.config.application.api.DeploymentSpec

Returns the deployment steps of this in the order they will be performed

T

TimeWindow - Class in com.yahoo.config.application.api

This class represents a window of time for selected hours on selected days.

toAllowMessage(ValidationId) - Static method in class com.yahoo.config.application.api.ValidationOverrides

toMessageString(Throwable) - Static method in class com.yahoo.config.application.api.DeploymentSpec

toString() - Method in class com.yahoo.config.application.api.ApplicationFile

toString() - Method in class com.yahoo.config.application.api.ApplicationMetaData

toString() - Method in class com.yahoo.config.application.api.ComponentInfo

toString() - Method in class com.yahoo.config.application.api.DeploymentSpec.DeclaredZone

toString() - Method in class com.yahoo.config.application.api.TimeWindow

toString() - Method in enum com.yahoo.config.application.api.ValidationId

toString() - Method in class com.yahoo.config.application.api.ValidationOverrides.Allow

U

UnparsedConfigDefinition - Interface in com.yahoo.config.application.api

A config definition that has not been parsed.

upgradePolicy() - Method in class com.yahoo.config.application.api.DeploymentSpec

Returns the upgrade policy of this, which is defaultPolicy if none is specified

V

validateIncludeDir(String) - Method in interface com.yahoo.config.application.api.ApplicationPackage

validateXML() - Method in interface com.yahoo.config.application.api.ApplicationPackage

validateXML(Optional<Version>) - Method in interface com.yahoo.config.application.api.ApplicationPackage

VALIDATION_OVERRIDES - Static variable in interface com.yahoo.config.application.api.ApplicationPackage

ValidationId - Enum in com.yahoo.config.application.api

Ids of validations that can be overridden

validationId() - Method in exception com.yahoo.config.application.api.ValidationOverrides.ValidationException

Returns the unique id of this validation, which can be used to override it

ValidationOverrides - Class in com.yahoo.config.application.api

A set of allows which suppresses specific validations in limited time periods.

ValidationOverrides(List<ValidationOverrides.Allow>) - Constructor for class com.yahoo.config.application.api.ValidationOverrides

Creates a validation overrides which does not have an xml form

ValidationOverrides.Allow - Class in com.yahoo.config.application.api

A validation override which allows a particular change.

ValidationOverrides.ValidationException - Exception in com.yahoo.config.application.api

A deployment validation exception.

value() - Method in enum com.yahoo.config.application.api.ValidationId

valueOf(String) - Static method in enum com.yahoo.config.application.api.DeploymentSpec.UpgradePolicy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.yahoo.config.application.api.ValidationId

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.yahoo.config.application.api.DeploymentSpec.UpgradePolicy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.yahoo.config.application.api.ValidationId

Returns an array containing the constants of this enum type, in the order they are declared.

W

window() - Method in class com.yahoo.config.application.api.DeploymentSpec.ChangeBlocker

writeFile(Reader) - Method in class com.yahoo.config.application.api.ApplicationFile

Write the contents from this reader to this file.

writeMetaData() - Method in interface com.yahoo.config.application.api.ApplicationPackage

X

xmlForm() - Method in class com.yahoo.config.application.api.DeploymentSpec

Returns the XML form of this spec, or null if it was not created by fromXml, nor is empty

xmlForm() - Method in class com.yahoo.config.application.api.ValidationOverrides

Returns the XML form of this, or null if it was not created by fromXml, nor is empty

Z

zone() - Method in class com.yahoo.config.application.api.TimeWindow

Returns the time zone of this time window

zones() - Method in class com.yahoo.config.application.api.DeploymentSpec.DeclaredZone

zones() - Method in class com.yahoo.config.application.api.DeploymentSpec.ParallelZones

zones() - Method in class com.yahoo.config.application.api.DeploymentSpec.Step

Returns the zones deployed to in this step

zones() - Method in class com.yahoo.config.application.api.DeploymentSpec

Returns all the DeclaredZone deployment steps in the order they are declared

A B C D E F G H I L M P Q R S T U V W X Z