Algorithm (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.personalize.model.Algorithm

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Algorithm
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes a custom algorithm.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Algorithm()

Constructors
Constructor and Description
`Algorithm()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Algorithm`	`addDefaultHyperParametersEntry(String key, String value)` Add a single DefaultHyperParameters entry
`Algorithm`	`addDefaultResourceConfigEntry(String key, String value)` Add a single DefaultResourceConfig entry
`Algorithm`	`clearDefaultHyperParametersEntries()` Removes all the entries added into DefaultHyperParameters.
`Algorithm`	`clearDefaultResourceConfigEntries()` Removes all the entries added into DefaultResourceConfig.
`Algorithm`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAlgorithmArn()` The Amazon Resource Name (ARN) of the algorithm.
`AlgorithmImage`	`getAlgorithmImage()` The URI of the Docker container for the algorithm image.
`Date`	`getCreationDateTime()` The date and time (in Unix time) that the algorithm was created.
`DefaultHyperParameterRanges`	`getDefaultHyperParameterRanges()` Specifies the default hyperparameters, their ranges, and whether they are tunable.
`Map<String,String>`	`getDefaultHyperParameters()` Specifies the default hyperparameters.
`Map<String,String>`	`getDefaultResourceConfig()` Specifies the default maximum number of training jobs and parallel training jobs.
`Date`	`getLastUpdatedDateTime()` The date and time (in Unix time) that the algorithm was last updated.
`String`	`getName()` The name of the algorithm.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the role.
`String`	`getTrainingInputMode()` The training input mode.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAlgorithmArn(String algorithmArn)` The Amazon Resource Name (ARN) of the algorithm.
`void`	`setAlgorithmImage(AlgorithmImage algorithmImage)` The URI of the Docker container for the algorithm image.
`void`	`setCreationDateTime(Date creationDateTime)` The date and time (in Unix time) that the algorithm was created.
`void`	`setDefaultHyperParameterRanges(DefaultHyperParameterRanges defaultHyperParameterRanges)` Specifies the default hyperparameters, their ranges, and whether they are tunable.
`void`	`setDefaultHyperParameters(Map<String,String> defaultHyperParameters)` Specifies the default hyperparameters.
`void`	`setDefaultResourceConfig(Map<String,String> defaultResourceConfig)` Specifies the default maximum number of training jobs and parallel training jobs.
`void`	`setLastUpdatedDateTime(Date lastUpdatedDateTime)` The date and time (in Unix time) that the algorithm was last updated.
`void`	`setName(String name)` The name of the algorithm.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role.
`void`	`setTrainingInputMode(String trainingInputMode)` The training input mode.
`String`	`toString()` Returns a string representation of this object.
`Algorithm`	`withAlgorithmArn(String algorithmArn)` The Amazon Resource Name (ARN) of the algorithm.
`Algorithm`	`withAlgorithmImage(AlgorithmImage algorithmImage)` The URI of the Docker container for the algorithm image.
`Algorithm`	`withCreationDateTime(Date creationDateTime)` The date and time (in Unix time) that the algorithm was created.
`Algorithm`	`withDefaultHyperParameterRanges(DefaultHyperParameterRanges defaultHyperParameterRanges)` Specifies the default hyperparameters, their ranges, and whether they are tunable.
`Algorithm`	`withDefaultHyperParameters(Map<String,String> defaultHyperParameters)` Specifies the default hyperparameters.
`Algorithm`	`withDefaultResourceConfig(Map<String,String> defaultResourceConfig)` Specifies the default maximum number of training jobs and parallel training jobs.
`Algorithm`	`withLastUpdatedDateTime(Date lastUpdatedDateTime)` The date and time (in Unix time) that the algorithm was last updated.
`Algorithm`	`withName(String name)` The name of the algorithm.
`Algorithm`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role.
`Algorithm`	`withTrainingInputMode(String trainingInputMode)` The training input mode.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Algorithm
```
public Algorithm()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the algorithm.
    
    Parameters:
    
    name - The name of the algorithm.
  - getName
```
public String getName()
```
    The name of the algorithm.
    
    Returns:
    
    The name of the algorithm.
  - withName
```
public Algorithm withName(String name)
```
    The name of the algorithm.
    
    Parameters:
    
    name - The name of the algorithm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAlgorithmArn
```
public void setAlgorithmArn(String algorithmArn)
```
    The Amazon Resource Name (ARN) of the algorithm.
    
    Parameters:
    
    algorithmArn - The Amazon Resource Name (ARN) of the algorithm.
  - getAlgorithmArn
```
public String getAlgorithmArn()
```
    The Amazon Resource Name (ARN) of the algorithm.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the algorithm.
  - withAlgorithmArn
```
public Algorithm withAlgorithmArn(String algorithmArn)
```
    The Amazon Resource Name (ARN) of the algorithm.
    
    Parameters:
    
    algorithmArn - The Amazon Resource Name (ARN) of the algorithm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAlgorithmImage
```
public void setAlgorithmImage(AlgorithmImage algorithmImage)
```
    The URI of the Docker container for the algorithm image.
    
    Parameters:
    
    algorithmImage - The URI of the Docker container for the algorithm image.
  - getAlgorithmImage
```
public AlgorithmImage getAlgorithmImage()
```
    The URI of the Docker container for the algorithm image.
    
    Returns:
    
    The URI of the Docker container for the algorithm image.
  - withAlgorithmImage
```
public Algorithm withAlgorithmImage(AlgorithmImage algorithmImage)
```
    The URI of the Docker container for the algorithm image.
    
    Parameters:
    
    algorithmImage - The URI of the Docker container for the algorithm image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDefaultHyperParameters
```
public Map<String,String> getDefaultHyperParameters()
```
    Specifies the default hyperparameters.
    
    Returns:
    
    Specifies the default hyperparameters.
  - setDefaultHyperParameters
```
public void setDefaultHyperParameters(Map<String,String> defaultHyperParameters)
```
    Specifies the default hyperparameters.
    
    Parameters:
    
    defaultHyperParameters - Specifies the default hyperparameters.
  - withDefaultHyperParameters
```
public Algorithm withDefaultHyperParameters(Map<String,String> defaultHyperParameters)
```
    Specifies the default hyperparameters.
    
    Parameters:
    
    defaultHyperParameters - Specifies the default hyperparameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addDefaultHyperParametersEntry
```
public Algorithm addDefaultHyperParametersEntry(String key,
                                                String value)
```
    Add a single DefaultHyperParameters entry
    
    See Also:
    
    withDefaultHyperParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearDefaultHyperParametersEntries
```
public Algorithm clearDefaultHyperParametersEntries()
```
    Removes all the entries added into DefaultHyperParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultHyperParameterRanges
```
public void setDefaultHyperParameterRanges(DefaultHyperParameterRanges defaultHyperParameterRanges)
```
    Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
    
    Parameters:
    
    defaultHyperParameterRanges - Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
  - getDefaultHyperParameterRanges
```
public DefaultHyperParameterRanges getDefaultHyperParameterRanges()
```
    Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
    
    Returns:
    
    Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
  - withDefaultHyperParameterRanges
```
public Algorithm withDefaultHyperParameterRanges(DefaultHyperParameterRanges defaultHyperParameterRanges)
```
    Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
    
    Parameters:
    
    defaultHyperParameterRanges - Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDefaultResourceConfig
```
public Map<String,String> getDefaultResourceConfig()
```
    Specifies the default maximum number of training jobs and parallel training jobs.
    
    Returns:
    
    Specifies the default maximum number of training jobs and parallel training jobs.
  - setDefaultResourceConfig
```
public void setDefaultResourceConfig(Map<String,String> defaultResourceConfig)
```
    Specifies the default maximum number of training jobs and parallel training jobs.
    
    Parameters:
    
    defaultResourceConfig - Specifies the default maximum number of training jobs and parallel training jobs.
  - withDefaultResourceConfig
```
public Algorithm withDefaultResourceConfig(Map<String,String> defaultResourceConfig)
```
    Specifies the default maximum number of training jobs and parallel training jobs.
    
    Parameters:
    
    defaultResourceConfig - Specifies the default maximum number of training jobs and parallel training jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addDefaultResourceConfigEntry
```
public Algorithm addDefaultResourceConfigEntry(String key,
                                               String value)
```
    Add a single DefaultResourceConfig entry
    
    See Also:
    
    withDefaultResourceConfig(java.util.Map<java.lang.String, java.lang.String>)
  - clearDefaultResourceConfigEntries
```
public Algorithm clearDefaultResourceConfigEntries()
```
    Removes all the entries added into DefaultResourceConfig.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrainingInputMode
```
public void setTrainingInputMode(String trainingInputMode)
```
    The training input mode.
    
    Parameters:
    
    trainingInputMode - The training input mode.
  - getTrainingInputMode
```
public String getTrainingInputMode()
```
    The training input mode.
    
    Returns:
    
    The training input mode.
  - withTrainingInputMode
```
public Algorithm withTrainingInputMode(String trainingInputMode)
```
    The training input mode.
    
    Parameters:
    
    trainingInputMode - The training input mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the role.
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of the role.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the role.
  - withRoleArn
```
public Algorithm withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the role.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDateTime
```
public void setCreationDateTime(Date creationDateTime)
```
    The date and time (in Unix time) that the algorithm was created.
    
    Parameters:
    
    creationDateTime - The date and time (in Unix time) that the algorithm was created.
  - getCreationDateTime
```
public Date getCreationDateTime()
```
    The date and time (in Unix time) that the algorithm was created.
    
    Returns:
    
    The date and time (in Unix time) that the algorithm was created.
  - withCreationDateTime
```
public Algorithm withCreationDateTime(Date creationDateTime)
```
    The date and time (in Unix time) that the algorithm was created.
    
    Parameters:
    
    creationDateTime - The date and time (in Unix time) that the algorithm was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedDateTime
```
public void setLastUpdatedDateTime(Date lastUpdatedDateTime)
```
    The date and time (in Unix time) that the algorithm was last updated.
    
    Parameters:
    
    lastUpdatedDateTime - The date and time (in Unix time) that the algorithm was last updated.
  - getLastUpdatedDateTime
```
public Date getLastUpdatedDateTime()
```
    The date and time (in Unix time) that the algorithm was last updated.
    
    Returns:
    
    The date and time (in Unix time) that the algorithm was last updated.
  - withLastUpdatedDateTime
```
public Algorithm withLastUpdatedDateTime(Date lastUpdatedDateTime)
```
    The date and time (in Unix time) that the algorithm was last updated.
    
    Parameters:
    
    lastUpdatedDateTime - The date and time (in Unix time) that the algorithm was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Algorithm clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.628

Class Algorithm

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Algorithm

Method Detail

setName

getName

withName

setAlgorithmArn

getAlgorithmArn

withAlgorithmArn

setAlgorithmImage

getAlgorithmImage

withAlgorithmImage

getDefaultHyperParameters

setDefaultHyperParameters

withDefaultHyperParameters

addDefaultHyperParametersEntry

clearDefaultHyperParametersEntries

setDefaultHyperParameterRanges

getDefaultHyperParameterRanges

withDefaultHyperParameterRanges

getDefaultResourceConfig

setDefaultResourceConfig

withDefaultResourceConfig

addDefaultResourceConfigEntry

clearDefaultResourceConfigEntries

setTrainingInputMode

getTrainingInputMode

withTrainingInputMode

setRoleArn

getRoleArn

withRoleArn

setCreationDateTime

getCreationDateTime

withCreationDateTime

setLastUpdatedDateTime

getLastUpdatedDateTime

withLastUpdatedDateTime

toString

equals

hashCode

clone

marshall