Class ServicesSchema
java.lang.Object
co.yellowdog.platform.model.ServicesSchema
Defines a set of URLs and request retry settings to be used to connect to YellowDog Platform Services.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classA builder that can be used to build a new ServicesSchema that is automatically validated on build. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic ServicesSchema.Builderbuilder()protected booleanstatic ServicesSchemadefaultSchema(@NonNull String defaultUrl) Builds and returns a ServicesSchema instance with the specified default URL leaving other connection details as their defaults.booleanThe base URL where the Account service is located.The base URL where the Cloud Info service is located.The base URL where the Compute service is located.The timeout for establishing a TCP connection to a YellowDog Platform service.The default base URL where services are located.The base URL where the Images service is located.The base URL where the Log service is located.The base URL where the Metrics service is located.getOrDefaultUrl(Function<ServicesSchema, String> getUrl) The maximum time to wait for a response from a YellowDog Platform service.getRetry()The base URL where the Scheduler service is located.The base URL where the Usage service is located.inthashCode()voidsetAccountServiceUrl(String accountServiceUrl) The base URL where the Account service is located.voidsetCloudInfoServiceUrl(String cloudInfoServiceUrl) The base URL where the Cloud Info service is located.voidsetComputeServiceUrl(String computeServiceUrl) The base URL where the Compute service is located.voidsetConnectionTimeout(Duration connectionTimeout) The timeout for establishing a TCP connection to a YellowDog Platform service.voidsetDefaultUrl(String defaultUrl) The default base URL where services are located.voidsetImagesServiceUrl(String imagesServiceUrl) The base URL where the Images service is located.voidsetLogServiceUrl(String logServiceUrl) The base URL where the Log service is located.voidsetMetricsServiceUrl(String metricsServiceUrl) The base URL where the Metrics service is located.voidsetRequestTimeout(Duration requestTimeout) The maximum time to wait for a response from a YellowDog Platform service.voidsetRetry(RetryProperties retry) voidsetSchedulerServiceUrl(String schedulerServiceUrl) The base URL where the Scheduler service is located.voidsetUsageServiceUrl(String usageServiceUrl) The base URL where the Usage service is located.toString()
-
Field Details
-
DEFAULT_CONNECTION_TIMEOUT
The default connection timeout. -
DEFAULT_REQUEST_TIMEOUT
The default request timeout.
-
-
Method Details
-
defaultSchema
Builds and returns a ServicesSchema instance with the specified default URL leaving other connection details as their defaults.- Parameters:
defaultUrl- the default base URL- Returns:
- a new ServicesSchema instance
-
getOrDefaultUrl
-
builder
-
toBuilder
-
getRetry
-
getDefaultUrl
The default base URL where services are located. This is the YellowDog Cell URL rather than a service specific path.- Returns:
- the base URL where services are located
-
getAccountServiceUrl
The base URL where the Account service is located. This is the YellowDog Cell URL rather than a service specific path.- Returns:
- the base URL where the Account service is located
-
getComputeServiceUrl
The base URL where the Compute service is located. This is the YellowDog Cell URL rather than a service specific path.- Returns:
- the base URL where the Compute service is located
-
getLogServiceUrl
The base URL where the Log service is located. This is the YellowDog Cell URL rather than a service specific path.- Returns:
- the base URL where the Log service is located
-
getImagesServiceUrl
The base URL where the Images service is located. This is the YellowDog Cell URL rather than a service specific path.- Returns:
- the base URL where the Images service is located
-
getSchedulerServiceUrl
The base URL where the Scheduler service is located. This is the YellowDog Cell URL rather than a service specific path.- Returns:
- the base URL where the Scheduler service is located
-
getUsageServiceUrl
The base URL where the Usage service is located. This is the YellowDog Cell URL rather than a service specific path.- Returns:
- the base URL where the Usage service is located
-
getCloudInfoServiceUrl
The base URL where the Cloud Info service is located. This is the YellowDog Cell URL rather than a service specific path.- Returns:
- the base URL where the Cloud Info service is located
-
getMetricsServiceUrl
The base URL where the Metrics service is located. This is the YellowDog Cell URL rather than a service specific path.- Returns:
- the base URL where the Metrics service is located
-
getConnectionTimeout
The timeout for establishing a TCP connection to a YellowDog Platform service. Defaults toDEFAULT_CONNECTION_TIMEOUT. Set tonullto disable the connection timeout.- Returns:
- the connection timeout, or
nullif disabled
-
getRequestTimeout
The maximum time to wait for a response from a YellowDog Platform service. Before Java 26, this covers only the wait for the response to start. Subscriptions to updates are not subject to this timeout. Defaults toDEFAULT_REQUEST_TIMEOUT. Set tonullto disable the request timeout.- Returns:
- the request timeout, or
nullif disabled
-
setRetry
-
setDefaultUrl
The default base URL where services are located. This is the YellowDog Cell URL rather than a service specific path.- Parameters:
defaultUrl- the base URL where services are located
-
setAccountServiceUrl
The base URL where the Account service is located. This is the YellowDog Cell URL rather than a service specific path.- Parameters:
accountServiceUrl- the base URL where the Account service is located
-
setComputeServiceUrl
The base URL where the Compute service is located. This is the YellowDog Cell URL rather than a service specific path.- Parameters:
computeServiceUrl- the base URL where the Compute service is located
-
setLogServiceUrl
The base URL where the Log service is located. This is the YellowDog Cell URL rather than a service specific path.- Parameters:
logServiceUrl- the base URL where the Log service is located
-
setImagesServiceUrl
The base URL where the Images service is located. This is the YellowDog Cell URL rather than a service specific path.- Parameters:
imagesServiceUrl- the base URL where the Images service is located
-
setSchedulerServiceUrl
The base URL where the Scheduler service is located. This is the YellowDog Cell URL rather than a service specific path.- Parameters:
schedulerServiceUrl- the base URL where the Scheduler service is located
-
setUsageServiceUrl
The base URL where the Usage service is located. This is the YellowDog Cell URL rather than a service specific path.- Parameters:
usageServiceUrl- the base URL where the Usage service is located
-
setCloudInfoServiceUrl
The base URL where the Cloud Info service is located. This is the YellowDog Cell URL rather than a service specific path.- Parameters:
cloudInfoServiceUrl- the base URL where the Cloud Info service is located
-
setMetricsServiceUrl
The base URL where the Metrics service is located. This is the YellowDog Cell URL rather than a service specific path.- Parameters:
metricsServiceUrl- the base URL where the Metrics service is located
-
setConnectionTimeout
The timeout for establishing a TCP connection to a YellowDog Platform service. Defaults toDEFAULT_CONNECTION_TIMEOUT. Set tonullto disable the connection timeout.- Parameters:
connectionTimeout- the connection timeout duration
-
setRequestTimeout
The maximum time to wait for a response from a YellowDog Platform service. Before Java 26, this covers only the wait for the response to start. Subscriptions to updates are not subject to this timeout. Defaults toDEFAULT_REQUEST_TIMEOUT. Set tonullto disable the request timeout.- Parameters:
requestTimeout- the request timeout duration
-
equals
-
canEqual
-
hashCode
-
toString
-