Interface PolytronObjectInfo

The PolytronObjectInfo interface represents a Polytron object.

interface PolytronObjectInfo {
    Author: string;
    Category: string;
    Documentation?: string;
    ExecutionSizeInferrableParameters?: string[];
    FriendlyName?: string;
    ID: string;
    Identifier: string;
    InputParameters: PolytronInputParameter[];
    IsExecutionFormatRelevant?: boolean;
    IsExecutionSizeRelevant?: boolean;
    IsGrayscalePermutable?: boolean;
    IsSeedRelevant?: boolean;
    IsUserFavorite?: boolean;
    Name: string;
    OutputParameters: PolytronOutputParameter[];
    PreviewURL?: string;
    Version: string;
}

Properties

Author Category Documentation? ExecutionSizeInferrableParameters? FriendlyName? ID Identifier InputParameters IsExecutionFormatRelevant? IsExecutionSizeRelevant? IsGrayscalePermutable? IsSeedRelevant? IsUserFavorite? Name OutputParameters PreviewURL? Version

Properties

Author

Author: string

Category

Category: string

OptionalDocumentation

Documentation?: string

OptionalExecutionSizeInferrableParameters

ExecutionSizeInferrableParameters?: string[]

A list of parameters that can be used to infer the size of an execution.

OptionalFriendlyName

FriendlyName?: string

The friendly name used for display.

ID

ID: string

The unique object ID. No other Polytron with the same Identifier may have the same ID.

Identifier

Identifier: string

The Polytron backend identifier. This represents the backend that executes the Polytron.

InputParameters

InputParameters: PolytronInputParameter[]

OptionalIsExecutionFormatRelevant

IsExecutionFormatRelevant?: boolean

OptionalIsExecutionSizeRelevant

IsExecutionSizeRelevant?: boolean

OptionalIsGrayscalePermutable

IsGrayscalePermutable?: boolean

OptionalIsSeedRelevant

IsSeedRelevant?: boolean

OptionalIsUserFavorite

IsUserFavorite?: boolean

Name

Name: string

The name.

OutputParameters

OutputParameters: PolytronOutputParameter[]

OptionalPreviewURL

PreviewURL?: string

Version

Version: string

Settings

Member Visibility

On This Page

Properties