Documentation
¶
Overview ¶
Package imaging provides access to the Akamai Image & Video Manager APIs
Index ¶
- Constants
- Variables
- type Append
- type AppendGravityPriority
- type AppendGravityPriorityVariableInline
- type AppendTransformation
- type AspectCrop
- type AspectCropTransformation
- type BackgroundColor
- type BackgroundColorTransformation
- type Blur
- type BlurTransformation
- type BooleanVariableInline
- type BoxImageType
- type BoxImageTypePost
- type BoxImageTypePostType
- type BoxImageTypeType
- type Breakpoints
- type ChromaKey
- type ChromaKeyTransformation
- type CircleImageType
- type CircleImageTypePost
- type CircleImageTypePostType
- type CircleImageTypeType
- type CircleShapeType
- type ClientFunc
- type Composite
- type CompositePlacement
- type CompositePlacementVariableInline
- type CompositePost
- type CompositePostPlacement
- type CompositePostPlacementVariableInline
- type CompositePostScaleDimension
- type CompositePostScaleDimensionVariableInline
- type CompositePostTransformation
- type CompositeScaleDimension
- type CompositeScaleDimensionVariableInline
- type CompositeTransformation
- type Compound
- type CompoundPost
- type CompoundPostTransformation
- type CompoundTransformation
- type Contrast
- type ContrastTransformation
- type CreatePolicySet
- type CreatePolicySetRequest
- type Crop
- type CropTransformation
- type DeletePolicyRequest
- type DeletePolicySetRequest
- type EnumOptions
- type Error
- type FaceCrop
- type FaceCropAlgorithm
- type FaceCropAlgorithmVariableInline
- type FaceCropFocus
- type FaceCropFocusVariableInline
- type FaceCropStyle
- type FaceCropStyleVariableInline
- type FaceCropTransformation
- type FeatureCrop
- type FeatureCropStyle
- type FeatureCropStyleVariableInline
- type FeatureCropTransformation
- type FitAndFill
- type FitAndFillTransformation
- type GetPolicyHistoryRequest
- type GetPolicyHistoryResponse
- type GetPolicyRequest
- type GetPolicySetRequest
- type Goop
- type GoopTransformation
- type Gravity
- type GravityPost
- type GravityPostVariableInline
- type GravityVariableInline
- type Grayscale
- type GrayscaleTransformation
- type GrayscaleType
- type GrayscaleTypeVariableInline
- type HSL
- type HSLTransformation
- type HSV
- type HSVTransformation
- type IfDimension
- type IfDimensionDimension
- type IfDimensionDimensionVariableInline
- type IfDimensionPost
- type IfDimensionPostDimension
- type IfDimensionPostDimensionVariableInline
- type IfDimensionPostTransformation
- type IfDimensionTransformation
- type IfOrientation
- type IfOrientationPost
- type IfOrientationPostTransformation
- type IfOrientationTransformation
- type ImQuery
- type ImQueryAllowedTransformations
- type ImQueryTransformation
- type ImageType
- type ImageTypePost
- type Imaging
- type InlineVariable
- type IntegerVariableInline
- type ListPoliciesRequest
- type ListPoliciesResponse
- type ListPolicySetsRequest
- type MaxColors
- type MaxColorsTransformation
- type MediaType
- type Mirror
- type MirrorTransformation
- type Mock
- func (m *Mock) CreatePolicySet(ctx context.Context, req CreatePolicySetRequest) (*PolicySet, error)
- func (m *Mock) DeletePolicy(ctx context.Context, req DeletePolicyRequest) (*PolicyResponse, error)
- func (m *Mock) DeletePolicySet(ctx context.Context, req DeletePolicySetRequest) error
- func (m *Mock) GetPolicy(ctx context.Context, req GetPolicyRequest) (PolicyOutput, error)
- func (m *Mock) GetPolicyHistory(ctx context.Context, req GetPolicyHistoryRequest) (*GetPolicyHistoryResponse, error)
- func (m *Mock) GetPolicySet(ctx context.Context, req GetPolicySetRequest) (*PolicySet, error)
- func (m *Mock) ListPolicies(ctx context.Context, req ListPoliciesRequest) (*ListPoliciesResponse, error)
- func (m *Mock) ListPolicySets(ctx context.Context, req ListPolicySetsRequest) ([]PolicySet, error)
- func (m *Mock) RollbackPolicy(ctx context.Context, req RollbackPolicyRequest) (*PolicyResponse, error)
- func (m *Mock) UpdatePolicySet(ctx context.Context, req UpdatePolicySetRequest) (*PolicySet, error)
- func (m *Mock) UpsertPolicy(ctx context.Context, req UpsertPolicyRequest) (*PolicyResponse, error)
- type MonoHue
- type MonoHueTransformation
- type Network
- type NumberVariableInline
- type Opacity
- type OpacityTransformation
- type Option
- type OutputImage
- type OutputImageAllowedFormats
- type OutputImageForcedFormats
- type OutputImagePerceptualQuality
- type OutputImagePerceptualQualityVariableInline
- type OutputVideo
- type OutputVideoPerceptualQuality
- type OutputVideoPerceptualQualityVariableInline
- type OutputVideoVideoAdaptiveQuality
- type OutputVideoVideoAdaptiveQualityVariableInline
- type PointShapeType
- type PolicyHistoryItem
- type PolicyInput
- type PolicyInputImage
- type PolicyInputVideo
- type PolicyNetwork
- type PolicyOutput
- type PolicyOutputImage
- type PolicyOutputImageVideo
- type PolicyOutputVideo
- type PolicyOutputVideoVideo
- type PolicyOutputs
- type PolicyResponse
- type PolicySet
- type PolygonShapeType
- type PostBreakpointTransformations
- type QueryVariableInline
- type RectangleShapeType
- type Region
- type RegionOfInterestCrop
- type RegionOfInterestCropStyle
- type RegionOfInterestCropStyleVariableInline
- type RegionOfInterestCropTransformation
- type RelativeCrop
- type RelativeCropTransformation
- type RemoveColor
- type RemoveColorTransformation
- type Resize
- type ResizeAspect
- type ResizeAspectVariableInline
- type ResizeTransformation
- type ResizeType
- type ResizeTypeVariableInline
- type RollbackPolicyRequest
- type RolloutInfo
- type Rotate
- type RotateTransformation
- type Scale
- type ScaleTransformation
- type ShapeType
- type Shear
- type ShearTransformation
- type SmartCrop
- type SmartCropStyle
- type SmartCropStyleVariableInline
- type SmartCropTransformation
- type StringVariableInline
- type TextImageType
- type TextImageTypePost
- type TextImageTypePostType
- type TextImageTypeType
- type TransformationType
- type TransformationTypePost
- type Transformations
- type Trim
- type TrimTransformation
- type URLImageType
- type URLImageTypePost
- type URLImageTypePostType
- type URLImageTypeType
- type UnionShapeType
- type UnsharpMask
- type UnsharpMaskTransformation
- type UpdatePolicySet
- type UpdatePolicySetRequest
- type UpsertPolicyRequest
- type Variable
- type VariableInline
- type VariableType
Constants ¶
View Source
const ( // AppendGravityPriorityHorizontal const AppendGravityPriorityHorizontal AppendGravityPriority = "horizontal" // AppendGravityPriorityVertical const AppendGravityPriorityVertical AppendGravityPriority = "vertical" // AppendTransformationAppend const AppendTransformationAppend AppendTransformation = "Append" // AspectCropTransformationAspectCrop const AspectCropTransformationAspectCrop AspectCropTransformation = "AspectCrop" // BackgroundColorTransformationBackgroundColor const BackgroundColorTransformationBackgroundColor BackgroundColorTransformation = "BackgroundColor" // BlurTransformationBlur const BlurTransformationBlur BlurTransformation = "Blur" // BoxImageTypePostTypeBox const BoxImageTypePostTypeBox BoxImageTypePostType = "Box" // BoxImageTypeTypeBox const BoxImageTypeTypeBox BoxImageTypeType = "Box" // ChromaKeyTransformationChromaKey const ChromaKeyTransformationChromaKey ChromaKeyTransformation = "ChromaKey" // CircleImageTypePostTypeCircle const CircleImageTypePostTypeCircle CircleImageTypePostType = "Circle" // CircleImageTypeTypeCircle const CircleImageTypeTypeCircle CircleImageTypeType = "Circle" // CompositePlacementOver const CompositePlacementOver CompositePlacement = "Over" // CompositePlacementUnder const CompositePlacementUnder CompositePlacement = "Under" // CompositePlacementMask const CompositePlacementMask CompositePlacement = "Mask" // CompositePlacementStencil const CompositePlacementStencil CompositePlacement = "Stencil" // CompositePostPlacementOver const CompositePostPlacementOver CompositePostPlacement = "Over" // CompositePostPlacementUnder const CompositePostPlacementUnder CompositePostPlacement = "Under" // CompositePostPlacementMask const CompositePostPlacementMask CompositePostPlacement = "Mask" // CompositePostPlacementStencil const CompositePostPlacementStencil CompositePostPlacement = "Stencil" // CompositePostScaleDimensionWidth const CompositePostScaleDimensionWidth CompositePostScaleDimension = "width" // CompositePostScaleDimensionHeight const CompositePostScaleDimensionHeight CompositePostScaleDimension = "height" // CompositePostTransformationComposite const CompositePostTransformationComposite CompositePostTransformation = "Composite" // CompositeScaleDimensionWidth const CompositeScaleDimensionWidth CompositeScaleDimension = "width" // CompositeScaleDimensionHeight const CompositeScaleDimensionHeight CompositeScaleDimension = "height" // CompositeTransformationComposite const CompositeTransformationComposite CompositeTransformation = "Composite" // CompoundPostTransformationCompound const CompoundPostTransformationCompound CompoundPostTransformation = "Compound" // CompoundTransformationCompound const CompoundTransformationCompound CompoundTransformation = "Compound" // ContrastTransformationContrast const ContrastTransformationContrast ContrastTransformation = "Contrast" // CropTransformationCrop const CropTransformationCrop CropTransformation = "Crop" // FaceCropAlgorithmCascade const FaceCropAlgorithmCascade FaceCropAlgorithm = "cascade" // FaceCropAlgorithmDnn const FaceCropAlgorithmDnn FaceCropAlgorithm = "dnn" // FaceCropFocusAllFaces const FaceCropFocusAllFaces FaceCropFocus = "allFaces" // FaceCropFocusBiggestFace const FaceCropFocusBiggestFace FaceCropFocus = "biggestFace" // FaceCropStyleCrop const FaceCropStyleCrop FaceCropStyle = "crop" // FaceCropStyleFill const FaceCropStyleFill FaceCropStyle = "fill" // FaceCropStyleZoom const FaceCropStyleZoom FaceCropStyle = "zoom" // FaceCropTransformationFaceCrop const FaceCropTransformationFaceCrop FaceCropTransformation = "FaceCrop" // FeatureCropStyleCrop const FeatureCropStyleCrop FeatureCropStyle = "crop" // FeatureCropStyleFill const FeatureCropStyleFill FeatureCropStyle = "fill" // FeatureCropStyleZoom const FeatureCropStyleZoom FeatureCropStyle = "zoom" // FeatureCropTransformationFeatureCrop const FeatureCropTransformationFeatureCrop FeatureCropTransformation = "FeatureCrop" // FitAndFillTransformationFitAndFill const FitAndFillTransformationFitAndFill FitAndFillTransformation = "FitAndFill" // GoopTransformationGoop const GoopTransformationGoop GoopTransformation = "Goop" // GravityNorth const GravityNorth Gravity = "North" // GravityNorthEast const GravityNorthEast Gravity = "NorthEast" // GravityNorthWest const GravityNorthWest Gravity = "NorthWest" // GravitySouth const GravitySouth Gravity = "South" // GravitySouthEast const GravitySouthEast Gravity = "SouthEast" // GravitySouthWest const GravitySouthWest Gravity = "SouthWest" // GravityCenter const GravityCenter Gravity = "Center" // GravityEast const GravityEast Gravity = "East" // GravityWest const GravityWest Gravity = "West" // GravityPostNorth const GravityPostNorth GravityPost = "North" // GravityPostNorthEast const GravityPostNorthEast GravityPost = "NorthEast" // GravityPostNorthWest const GravityPostNorthWest GravityPost = "NorthWest" // GravityPostSouth const GravityPostSouth GravityPost = "South" // GravityPostSouthEast const GravityPostSouthEast GravityPost = "SouthEast" // GravityPostSouthWest const GravityPostSouthWest GravityPost = "SouthWest" // GravityPostCenter const GravityPostCenter GravityPost = "Center" // GravityPostEast const GravityPostEast GravityPost = "East" // GravityPostWest const GravityPostWest GravityPost = "West" // GrayscaleTransformationGrayscale const GrayscaleTransformationGrayscale GrayscaleTransformation = "Grayscale" // GrayscaleTypeRec601 const GrayscaleTypeRec601 GrayscaleType = "Rec601" // GrayscaleTypeRec709 const GrayscaleTypeRec709 GrayscaleType = "Rec709" // GrayscaleTypeBrightness const GrayscaleTypeBrightness GrayscaleType = "Brightness" // GrayscaleTypeLightness const GrayscaleTypeLightness GrayscaleType = "Lightness" // HSLTransformationHSL const HSLTransformationHSL HSLTransformation = "HSL" // HSVTransformationHSV const HSVTransformationHSV HSVTransformation = "HSV" // IfDimensionDimensionWidth const IfDimensionDimensionWidth IfDimensionDimension = "width" // IfDimensionDimensionHeight const IfDimensionDimensionHeight IfDimensionDimension = "height" // IfDimensionDimensionBoth const IfDimensionDimensionBoth IfDimensionDimension = "both" // IfDimensionPostDimensionWidth const IfDimensionPostDimensionWidth IfDimensionPostDimension = "width" // IfDimensionPostDimensionHeight const IfDimensionPostDimensionHeight IfDimensionPostDimension = "height" // IfDimensionPostDimensionBoth const IfDimensionPostDimensionBoth IfDimensionPostDimension = "both" // IfDimensionPostTransformationIfDimension const IfDimensionPostTransformationIfDimension IfDimensionPostTransformation = "IfDimension" // IfDimensionTransformationIfDimension const IfDimensionTransformationIfDimension IfDimensionTransformation = "IfDimension" // IfOrientationPostTransformationIfOrientation const IfOrientationPostTransformationIfOrientation IfOrientationPostTransformation = "IfOrientation" // IfOrientationTransformationIfOrientation const IfOrientationTransformationIfOrientation IfOrientationTransformation = "IfOrientation" // ImQueryAllowedTransformationsAppend const ImQueryAllowedTransformationsAppend ImQueryAllowedTransformations = "Append" // ImQueryAllowedTransformationsAspectCrop const ImQueryAllowedTransformationsAspectCrop ImQueryAllowedTransformations = "AspectCrop" // ImQueryAllowedTransformationsBackgroundColor const ImQueryAllowedTransformationsBackgroundColor ImQueryAllowedTransformations = "BackgroundColor" // ImQueryAllowedTransformationsBlur const ImQueryAllowedTransformationsBlur ImQueryAllowedTransformations = "Blur" // ImQueryAllowedTransformationsComposite const ImQueryAllowedTransformationsComposite ImQueryAllowedTransformations = "Composite" // ImQueryAllowedTransformationsContrast const ImQueryAllowedTransformationsContrast ImQueryAllowedTransformations = "Contrast" // ImQueryAllowedTransformationsCrop const ImQueryAllowedTransformationsCrop ImQueryAllowedTransformations = "Crop" // ImQueryAllowedTransformationsChromaKey const ImQueryAllowedTransformationsChromaKey ImQueryAllowedTransformations = "ChromaKey" // ImQueryAllowedTransformationsFaceCrop const ImQueryAllowedTransformationsFaceCrop ImQueryAllowedTransformations = "FaceCrop" // ImQueryAllowedTransformationsFeatureCrop const ImQueryAllowedTransformationsFeatureCrop ImQueryAllowedTransformations = "FeatureCrop" // ImQueryAllowedTransformationsFitAndFill const ImQueryAllowedTransformationsFitAndFill ImQueryAllowedTransformations = "FitAndFill" // ImQueryAllowedTransformationsGoop const ImQueryAllowedTransformationsGoop ImQueryAllowedTransformations = "Goop" // ImQueryAllowedTransformationsGrayscale const ImQueryAllowedTransformationsGrayscale ImQueryAllowedTransformations = "Grayscale" // ImQueryAllowedTransformationsHSL const ImQueryAllowedTransformationsHSL ImQueryAllowedTransformations = "HSL" // ImQueryAllowedTransformationsHSV const ImQueryAllowedTransformationsHSV ImQueryAllowedTransformations = "HSV" // ImQueryAllowedTransformationsMaxColors const ImQueryAllowedTransformationsMaxColors ImQueryAllowedTransformations = "MaxColors" // ImQueryAllowedTransformationsMirror const ImQueryAllowedTransformationsMirror ImQueryAllowedTransformations = "Mirror" // ImQueryAllowedTransformationsMonoHue const ImQueryAllowedTransformationsMonoHue ImQueryAllowedTransformations = "MonoHue" // ImQueryAllowedTransformationsOpacity const ImQueryAllowedTransformationsOpacity ImQueryAllowedTransformations = "Opacity" // ImQueryAllowedTransformationsRegionOfInterestCrop const ImQueryAllowedTransformationsRegionOfInterestCrop ImQueryAllowedTransformations = "RegionOfInterestCrop" // ImQueryAllowedTransformationsRelativeCrop const ImQueryAllowedTransformationsRelativeCrop ImQueryAllowedTransformations = "RelativeCrop" // ImQueryAllowedTransformationsRemoveColor const ImQueryAllowedTransformationsRemoveColor ImQueryAllowedTransformations = "RemoveColor" // ImQueryAllowedTransformationsResize const ImQueryAllowedTransformationsResize ImQueryAllowedTransformations = "Resize" // ImQueryAllowedTransformationsRotate const ImQueryAllowedTransformationsRotate ImQueryAllowedTransformations = "Rotate" // ImQueryAllowedTransformationsScale const ImQueryAllowedTransformationsScale ImQueryAllowedTransformations = "Scale" // ImQueryAllowedTransformationsShear const ImQueryAllowedTransformationsShear ImQueryAllowedTransformations = "Shear" // ImQueryAllowedTransformationsTrim const ImQueryAllowedTransformationsTrim ImQueryAllowedTransformations = "Trim" // ImQueryAllowedTransformationsUnsharpMask const ImQueryAllowedTransformationsUnsharpMask ImQueryAllowedTransformations = "UnsharpMask" // ImQueryAllowedTransformationsIfDimension const ImQueryAllowedTransformationsIfDimension ImQueryAllowedTransformations = "IfDimension" // ImQueryAllowedTransformationsIfOrientation const ImQueryAllowedTransformationsIfOrientation ImQueryAllowedTransformations = "IfOrientation" // ImQueryTransformationImQuery const ImQueryTransformationImQuery ImQueryTransformation = "ImQuery" // MaxColorsTransformationMaxColors const MaxColorsTransformationMaxColors MaxColorsTransformation = "MaxColors" // MirrorTransformationMirror const MirrorTransformationMirror MirrorTransformation = "Mirror" // MonoHueTransformationMonoHue const MonoHueTransformationMonoHue MonoHueTransformation = "MonoHue" // OpacityTransformationOpacity const OpacityTransformationOpacity OpacityTransformation = "Opacity" // OutputImageAllowedFormatsGif const OutputImageAllowedFormatsGif OutputImageAllowedFormats = "gif" // OutputImageAllowedFormatsJpeg const OutputImageAllowedFormatsJpeg OutputImageAllowedFormats = "jpeg" // OutputImageAllowedFormatsPng const OutputImageAllowedFormatsPng OutputImageAllowedFormats = "png" // OutputImageAllowedFormatsWebp const OutputImageAllowedFormatsWebp OutputImageAllowedFormats = "webp" // OutputImageAllowedFormatsJpegxr const OutputImageAllowedFormatsJpegxr OutputImageAllowedFormats = "jpegxr" // OutputImageAllowedFormatsJpeg2000 const OutputImageAllowedFormatsJpeg2000 OutputImageAllowedFormats = "jpeg2000" // OutputImageAllowedFormatsAvif const OutputImageAllowedFormatsAvif OutputImageAllowedFormats = "avif" // OutputImageForcedFormatsGif const OutputImageForcedFormatsGif OutputImageForcedFormats = "gif" // OutputImageForcedFormatsJpeg const OutputImageForcedFormatsJpeg OutputImageForcedFormats = "jpeg" // OutputImageForcedFormatsPng const OutputImageForcedFormatsPng OutputImageForcedFormats = "png" // OutputImageForcedFormatsWebp const OutputImageForcedFormatsWebp OutputImageForcedFormats = "webp" // OutputImageForcedFormatsJpegxr const OutputImageForcedFormatsJpegxr OutputImageForcedFormats = "jpegxr" // OutputImageForcedFormatsJpeg2000 const OutputImageForcedFormatsJpeg2000 OutputImageForcedFormats = "jpeg2000" // OutputImageForcedFormatsAvif const OutputImageForcedFormatsAvif OutputImageForcedFormats = "avif" // OutputImagePerceptualQualityHigh const OutputImagePerceptualQualityHigh OutputImagePerceptualQuality = "high" // OutputImagePerceptualQualityMediumHigh const OutputImagePerceptualQualityMediumHigh OutputImagePerceptualQuality = "mediumHigh" // OutputImagePerceptualQualityMedium const OutputImagePerceptualQualityMedium OutputImagePerceptualQuality = "medium" // OutputImagePerceptualQualityMediumLow const OutputImagePerceptualQualityMediumLow OutputImagePerceptualQuality = "mediumLow" // OutputImagePerceptualQualityLow const OutputImagePerceptualQualityLow OutputImagePerceptualQuality = "low" // PolicyOutputImageVideoFalse const PolicyOutputImageVideoFalse PolicyOutputImageVideo = false // RegionOfInterestCropStyleCrop const RegionOfInterestCropStyleCrop RegionOfInterestCropStyle = "crop" // RegionOfInterestCropStyleFill const RegionOfInterestCropStyleFill RegionOfInterestCropStyle = "fill" // RegionOfInterestCropStyleZoom const RegionOfInterestCropStyleZoom RegionOfInterestCropStyle = "zoom" // RegionOfInterestCropTransformationRegionOfInterestCrop const RegionOfInterestCropTransformationRegionOfInterestCrop RegionOfInterestCropTransformation = "RegionOfInterestCrop" // RelativeCropTransformationRelativeCrop const RelativeCropTransformationRelativeCrop RelativeCropTransformation = "RelativeCrop" // RemoveColorTransformationRemoveColor const RemoveColorTransformationRemoveColor RemoveColorTransformation = "RemoveColor" // ResizeAspectFit const ResizeAspectFit ResizeAspect = "fit" // ResizeAspectFill const ResizeAspectFill ResizeAspect = "fill" // ResizeAspectIgnore const ResizeAspectIgnore ResizeAspect = "ignore" // ResizeTransformationResize const ResizeTransformationResize ResizeTransformation = "Resize" // ResizeTypeNormal const ResizeTypeNormal ResizeType = "normal" // ResizeTypeUpsize const ResizeTypeUpsize ResizeType = "upsize" // ResizeTypeDownsize const ResizeTypeDownsize ResizeType = "downsize" // RotateTransformationRotate const RotateTransformationRotate RotateTransformation = "Rotate" // ScaleTransformationScale const ScaleTransformationScale ScaleTransformation = "Scale" // ShearTransformationShear const ShearTransformationShear ShearTransformation = "Shear" // SmartCropStyleCrop const SmartCropStyleCrop SmartCropStyle = "crop" // SmartCropStyleFill const SmartCropStyleFill SmartCropStyle = "fill" // SmartCropStyleZoom const SmartCropStyleZoom SmartCropStyle = "zoom" // SmartCropTransformationSmartCrop const SmartCropTransformationSmartCrop SmartCropTransformation = "SmartCrop" // TextImageTypePostTypeText const TextImageTypePostTypeText TextImageTypePostType = "Text" // TextImageTypeTypeText const TextImageTypeTypeText TextImageTypeType = "Text" // TrimTransformationTrim const TrimTransformationTrim TrimTransformation = "Trim" // URLImageTypePostTypeURL const URLImageTypePostTypeURL URLImageTypePostType = "URL" // URLImageTypeTypeURL const URLImageTypeTypeURL URLImageTypeType = "URL" // UnsharpMaskTransformationUnsharpMask const UnsharpMaskTransformationUnsharpMask UnsharpMaskTransformation = "UnsharpMask" // VariableTypeBool const VariableTypeBool VariableType = "bool" // VariableTypeNumber const VariableTypeNumber VariableType = "number" // VariableTypeURL const VariableTypeURL VariableType = "url" // VariableTypeColor const VariableTypeColor VariableType = "color" // VariableTypeGravity const VariableTypeGravity VariableType = "gravity" // VariableTypePlacement const VariableTypePlacement VariableType = "placement" // VariableTypeScaleDimension const VariableTypeScaleDimension VariableType = "scaleDimension" // VariableTypeGrayscaleType const VariableTypeGrayscaleType VariableType = "grayscaleType" // VariableTypeAspect const VariableTypeAspect VariableType = "aspect" // VariableTypeResizeType const VariableTypeResizeType VariableType = "resizeType" // VariableTypeDimension const VariableTypeDimension VariableType = "dimension" // VariableTypePerceptualQuality const VariableTypePerceptualQuality VariableType = "perceptualQuality" // VariableTypeString const VariableTypeString VariableType = "string" // VariableTypeFocus const VariableTypeFocus VariableType = "focus" // OutputVideoPerceptualQualityHigh const OutputVideoPerceptualQualityHigh OutputVideoPerceptualQuality = "high" // OutputVideoPerceptualQualityMediumHigh const OutputVideoPerceptualQualityMediumHigh OutputVideoPerceptualQuality = "mediumHigh" // OutputVideoPerceptualQualityMedium const OutputVideoPerceptualQualityMedium OutputVideoPerceptualQuality = "medium" // OutputVideoPerceptualQualityMediumLow const OutputVideoPerceptualQualityMediumLow OutputVideoPerceptualQuality = "mediumLow" // OutputVideoPerceptualQualityLow const OutputVideoPerceptualQualityLow OutputVideoPerceptualQuality = "low" // OutputVideoVideoAdaptiveQualityHigh const OutputVideoVideoAdaptiveQualityHigh OutputVideoVideoAdaptiveQuality = "high" // OutputVideoVideoAdaptiveQualityMediumHigh const OutputVideoVideoAdaptiveQualityMediumHigh OutputVideoVideoAdaptiveQuality = "mediumHigh" // OutputVideoVideoAdaptiveQualityMedium const OutputVideoVideoAdaptiveQualityMedium OutputVideoVideoAdaptiveQuality = "medium" // OutputVideoVideoAdaptiveQualityMediumLow const OutputVideoVideoAdaptiveQualityMediumLow OutputVideoVideoAdaptiveQuality = "mediumLow" // OutputVideoVideoAdaptiveQualityLow const OutputVideoVideoAdaptiveQualityLow OutputVideoVideoAdaptiveQuality = "low" // PolicyOutputVideoVideoTrue const PolicyOutputVideoVideoTrue PolicyOutputVideoVideo = true )
----------------------------------------------- ///////////// Generated constants /////////////// -----------------------------------------------
Variables ¶
View Source
var ( // ErrUnmarshalVariableAppendGravityPriorityVariableInline represents an error while unmarshalling AppendGravityPriorityVariableInline ErrUnmarshalVariableAppendGravityPriorityVariableInline = errors.New("unmarshalling AppendGravityPriorityVariableInline") // ErrUnmarshalVariableBooleanVariableInline represents an error while unmarshalling BooleanVariableInline ErrUnmarshalVariableBooleanVariableInline = errors.New("unmarshalling BooleanVariableInline") // ErrUnmarshalVariableCompositePlacementVariableInline represents an error while unmarshalling CompositePlacementVariableInline ErrUnmarshalVariableCompositePlacementVariableInline = errors.New("unmarshalling CompositePlacementVariableInline") // ErrUnmarshalVariableCompositePostPlacementVariableInline represents an error while unmarshalling CompositePostPlacementVariableInline ErrUnmarshalVariableCompositePostPlacementVariableInline = errors.New("unmarshalling CompositePostPlacementVariableInline") // ErrUnmarshalVariableCompositePostScaleDimensionVariableInline represents an error while unmarshalling CompositePostScaleDimensionVariableInline ErrUnmarshalVariableCompositePostScaleDimensionVariableInline = errors.New("unmarshalling CompositePostScaleDimensionVariableInline") // ErrUnmarshalVariableCompositeScaleDimensionVariableInline represents an error while unmarshalling CompositeScaleDimensionVariableInline ErrUnmarshalVariableCompositeScaleDimensionVariableInline = errors.New("unmarshalling CompositeScaleDimensionVariableInline") // ErrUnmarshalVariableFaceCropAlgorithmVariableInline represents an error while unmarshalling FaceCropAlgorithmVariableInline ErrUnmarshalVariableFaceCropAlgorithmVariableInline = errors.New("unmarshalling FaceCropAlgorithmVariableInline") // ErrUnmarshalVariableFaceCropFocusVariableInline represents an error while unmarshalling FaceCropFocusVariableInline ErrUnmarshalVariableFaceCropFocusVariableInline = errors.New("unmarshalling FaceCropFocusVariableInline") // ErrUnmarshalVariableFaceCropStyleVariableInline represents an error while unmarshalling FaceCropStyleVariableInline ErrUnmarshalVariableFaceCropStyleVariableInline = errors.New("unmarshalling FaceCropStyleVariableInline") // ErrUnmarshalVariableFeatureCropStyleVariableInline represents an error while unmarshalling FeatureCropStyleVariableInline ErrUnmarshalVariableFeatureCropStyleVariableInline = errors.New("unmarshalling FeatureCropStyleVariableInline") // ErrUnmarshalVariableGravityPostVariableInline represents an error while unmarshalling GravityPostVariableInline ErrUnmarshalVariableGravityPostVariableInline = errors.New("unmarshalling GravityPostVariableInline") // ErrUnmarshalVariableGravityVariableInline represents an error while unmarshalling GravityVariableInline ErrUnmarshalVariableGravityVariableInline = errors.New("unmarshalling GravityVariableInline") // ErrUnmarshalVariableGrayscaleTypeVariableInline represents an error while unmarshalling GrayscaleTypeVariableInline ErrUnmarshalVariableGrayscaleTypeVariableInline = errors.New("unmarshalling GrayscaleTypeVariableInline") // ErrUnmarshalVariableIfDimensionDimensionVariableInline represents an error while unmarshalling IfDimensionDimensionVariableInline ErrUnmarshalVariableIfDimensionDimensionVariableInline = errors.New("unmarshalling IfDimensionDimensionVariableInline") // ErrUnmarshalVariableIfDimensionPostDimensionVariableInline represents an error while unmarshalling IfDimensionPostDimensionVariableInline ErrUnmarshalVariableIfDimensionPostDimensionVariableInline = errors.New("unmarshalling IfDimensionPostDimensionVariableInline") // ErrUnmarshalVariableIntegerVariableInline represents an error while unmarshalling IntegerVariableInline ErrUnmarshalVariableIntegerVariableInline = errors.New("unmarshalling IntegerVariableInline") // ErrUnmarshalVariableNumberVariableInline represents an error while unmarshalling NumberVariableInline ErrUnmarshalVariableNumberVariableInline = errors.New("unmarshalling NumberVariableInline") // ErrUnmarshalVariableOutputImagePerceptualQualityVariableInline represents an error while unmarshalling OutputImagePerceptualQualityVariableInline ErrUnmarshalVariableOutputImagePerceptualQualityVariableInline = errors.New("unmarshalling OutputImagePerceptualQualityVariableInline") // ErrUnmarshalVariableQueryVariableInline represents an error while unmarshalling QueryVariableInline ErrUnmarshalVariableQueryVariableInline = errors.New("unmarshalling QueryVariableInline") // ErrUnmarshalVariableRegionOfInterestCropStyleVariableInline represents an error while unmarshalling RegionOfInterestCropStyleVariableInline ErrUnmarshalVariableRegionOfInterestCropStyleVariableInline = errors.New("unmarshalling RegionOfInterestCropStyleVariableInline") // ErrUnmarshalVariableResizeAspectVariableInline represents an error while unmarshalling ResizeAspectVariableInline ErrUnmarshalVariableResizeAspectVariableInline = errors.New("unmarshalling ResizeAspectVariableInline") // ErrUnmarshalVariableResizeTypeVariableInline represents an error while unmarshalling ResizeTypeVariableInline ErrUnmarshalVariableResizeTypeVariableInline = errors.New("unmarshalling ResizeTypeVariableInline") // ErrUnmarshalVariableSmartCropStyleVariableInline represents an error while unmarshalling SmartCropStyleVariableInline ErrUnmarshalVariableSmartCropStyleVariableInline = errors.New("unmarshalling SmartCropStyleVariableInline") // ErrUnmarshalVariableStringVariableInline represents an error while unmarshalling StringVariableInline ErrUnmarshalVariableStringVariableInline = errors.New("unmarshalling StringVariableInline") // ErrUnmarshalVariableOutputVideoPerceptualQualityVariableInline represents an error while unmarshalling OutputVideoPerceptualQualityVariableInline ErrUnmarshalVariableOutputVideoPerceptualQualityVariableInline = errors.New("unmarshalling OutputVideoPerceptualQualityVariableInline") // ErrUnmarshalVariableOutputVideoVideoAdaptiveQualityVariableInline represents an error while unmarshalling OutputVideoVideoAdaptiveQualityVariableInline ErrUnmarshalVariableOutputVideoVideoAdaptiveQualityVariableInline = errors.New("unmarshalling OutputVideoVideoAdaptiveQualityVariableInline") )
----------------------------------------------- // Variable type marshalers and unmarshalers //// -----------------------------------------------
View Source
var ( // ErrUnmarshalImageTypeAppend represents an error while unmarshalling Append ErrUnmarshalImageTypeAppend = errors.New("unmarshalling Append") // ErrUnmarshalImageTypeComposite represents an error while unmarshalling Composite ErrUnmarshalImageTypeComposite = errors.New("unmarshalling Composite") )
View Source
var ( // ErrUnmarshalTransformationBoxImageType represents an error while unmarshalling {$compositeType}} ErrUnmarshalTransformationBoxImageType = errors.New("unmarshalling BoxImageType") // ErrUnmarshalTransformationCircleImageType represents an error while unmarshalling {$compositeType}} ErrUnmarshalTransformationCircleImageType = errors.New("unmarshalling CircleImageType") // ErrUnmarshalTransformationFitAndFill represents an error while unmarshalling {$compositeType}} ErrUnmarshalTransformationFitAndFill = errors.New("unmarshalling FitAndFill") // ErrUnmarshalTransformationIfDimension represents an error while unmarshalling {$compositeType}} ErrUnmarshalTransformationIfDimension = errors.New("unmarshalling IfDimension") // ErrUnmarshalTransformationIfOrientation represents an error while unmarshalling {$compositeType}} ErrUnmarshalTransformationIfOrientation = errors.New("unmarshalling IfOrientation") // ErrUnmarshalTransformationTextImageType represents an error while unmarshalling {$compositeType}} ErrUnmarshalTransformationTextImageType = errors.New("unmarshalling TextImageType") // ErrUnmarshalTransformationURLImageType represents an error while unmarshalling {$compositeType}} ErrUnmarshalTransformationURLImageType = errors.New("unmarshalling URLImageType") )
View Source
var ( // ErrUnmarshalPostBreakpointTransformationBoxImageTypePost represents an error while unmarshalling {$compositeType}} ErrUnmarshalPostBreakpointTransformationBoxImageTypePost = errors.New("unmarshalling BoxImageTypePost") // ErrUnmarshalPostBreakpointTransformationCircleImageTypePost represents an error while unmarshalling {$compositeType}} ErrUnmarshalPostBreakpointTransformationCircleImageTypePost = errors.New("unmarshalling CircleImageTypePost") // ErrUnmarshalPostBreakpointTransformationIfDimensionPost represents an error while unmarshalling {$compositeType}} ErrUnmarshalPostBreakpointTransformationIfDimensionPost = errors.New("unmarshalling IfDimensionPost") // ErrUnmarshalPostBreakpointTransformationIfOrientationPost represents an error while unmarshalling {$compositeType}} ErrUnmarshalPostBreakpointTransformationIfOrientationPost = errors.New("unmarshalling IfOrientationPost") // ErrUnmarshalPostBreakpointTransformationTextImageTypePost represents an error while unmarshalling {$compositeType}} ErrUnmarshalPostBreakpointTransformationTextImageTypePost = errors.New("unmarshalling TextImageTypePost") // ErrUnmarshalPostBreakpointTransformationURLImageTypePost represents an error while unmarshalling {$compositeType}} ErrUnmarshalPostBreakpointTransformationURLImageTypePost = errors.New("unmarshalling URLImageTypePost") )
View Source
var ( // ErrUnmarshalPolicyOutputList represents an error while unmarshalling transformation list ErrUnmarshalPolicyOutputList = errors.New("unmarshalling policy output list") // ErrListPolicies is returned when ListPolicies fails ErrListPolicies = errors.New("list policies") // ErrGetPolicy is returned when GetPolicy fails ErrGetPolicy = errors.New("get policy") // ErrUpsertPolicy is returned when UpsertPolicy fails ErrUpsertPolicy = errors.New("upsert policy") // ErrDeletePolicy is returned when DeletePolicy fails ErrDeletePolicy = errors.New("delete policy") // ErrGetPolicyHistory is returned when GetPolicyHistory fails ErrGetPolicyHistory = errors.New("get policy history") // ErrRollbackPolicy is returned when RollbackPolicy fails ErrRollbackPolicy = errors.New("rollback policy") )
View Source
var ( // ErrListPolicySets is returned when ListPolicySets fails ErrListPolicySets = errors.New("list policy sets") // ErrGetPolicySet is returned when GetPolicySet fails ErrGetPolicySet = errors.New("get policy set") // ErrCreatePolicySet is returned when CreatePolicySet fails ErrCreatePolicySet = errors.New("create policy set") // ErrUpdatePolicySet is returned when UpdatePolicySet fails ErrUpdatePolicySet = errors.New("update policy set") // ErrDeletePolicySet is returned when DeletePolicySet fails ErrDeletePolicySet = errors.New("delete policy set") )
View Source
var ( // ErrStructValidation is returned when given struct validation failed ErrStructValidation = errors.New("struct validation") )
View Source
var ( // ErrUnmarshalImageTypeCompositePost represents an error while unmarshalling CompositePost ErrUnmarshalImageTypeCompositePost = errors.New("unmarshalling CompositePost") )
View Source
var ErrUnmarshalPostBreakpointTransformationList = errors.New("unmarshalling post breakpoint transformation list")
ErrUnmarshalPostBreakpointTransformationList represents an error while unmarshalling post breakpoint transformation list
View Source
var ( // ErrUnmarshalShapeTypeRegionOfInterestCrop represents an error while unmarshalling {$compositeType}} ErrUnmarshalShapeTypeRegionOfInterestCrop = errors.New("unmarshalling RegionOfInterestCrop") )
View Source
var ErrUnmarshalTransformationList = errors.New("unmarshalling transformation list")
ErrUnmarshalTransformationList represents an error while unmarshalling transformation list
View Source
var ImageTypePostValueHandlers = map[string]func() ImageTypePost{ "box": func() ImageTypePost { return &BoxImageTypePost{} }, "text": func() ImageTypePost { return &TextImageTypePost{} }, "url": func() ImageTypePost { return &URLImageTypePost{} }, "circle": func() ImageTypePost { return &CircleImageTypePost{} }, }
ImageTypePostValueHandlers is a map of available image post types
View Source
var ImageTypeValueHandlers = map[string]func() ImageType{ "box": func() ImageType { return &BoxImageType{} }, "text": func() ImageType { return &TextImageType{} }, "url": func() ImageType { return &URLImageType{} }, "circle": func() ImageType { return &CircleImageType{} }, }
ImageTypeValueHandlers is a map of available image types
View Source
var PostBreakpointTransformationHandlers = map[string]func() TransformationTypePost{ "BackgroundColor": func() TransformationTypePost { return &BackgroundColor{} }, "Blur": func() TransformationTypePost { return &Blur{} }, "ChromaKey": func() TransformationTypePost { return &ChromaKey{} }, "Compound": func() TransformationTypePost { return &CompoundPost{} }, "Composite": func() TransformationTypePost { return &CompositePost{} }, "Contrast": func() TransformationTypePost { return &Contrast{} }, "Goop": func() TransformationTypePost { return &Goop{} }, "Grayscale": func() TransformationTypePost { return &Grayscale{} }, "HSL": func() TransformationTypePost { return &HSL{} }, "HSV": func() TransformationTypePost { return &HSV{} }, "IfDimension": func() TransformationTypePost { return &IfDimensionPost{} }, "IfOrientation": func() TransformationTypePost { return &IfOrientationPost{} }, "MaxColors": func() TransformationTypePost { return &MaxColors{} }, "Mirror": func() TransformationTypePost { return &Mirror{} }, "MonoHue": func() TransformationTypePost { return &MonoHue{} }, "Opacity": func() TransformationTypePost { return &Opacity{} }, "RemoveColor": func() TransformationTypePost { return &RemoveColor{} }, "UnsharpMask": func() TransformationTypePost { return &UnsharpMask{} }, }
PostBreakpointTransformationHandlers is a map of available PostBreakpointTransformations
View Source
var ShapeTypeValueHandlers = func(m map[string]interface{}) ShapeType { if _, ok := m["radius"]; ok { return ShapeTypes["circle"]() } if _, ok := m["x"]; ok { return ShapeTypes["point"]() } if _, ok := m["points"]; ok { return ShapeTypes["polygon"]() } if _, ok := m["anchor"]; ok { return ShapeTypes["rectangle"]() } if _, ok := m["shapes"]; ok { return ShapeTypes["union"]() } return nil }
ShapeTypeValueHandlers returns a ShapeType based on fields specific for a concrete ShapeType
View Source
var ShapeTypes = map[string]func() ShapeType{ "circle": func() ShapeType { return &CircleShapeType{} }, "point": func() ShapeType { return &PointShapeType{} }, "polygon": func() ShapeType { return &PolygonShapeType{} }, "rectangle": func() ShapeType { return &RectangleShapeType{} }, "union": func() ShapeType { return &UnionShapeType{} }, }
ShapeTypes is a map of available shape types
View Source
var TransformationHandlers = map[string]func() TransformationType{ "Append": func() TransformationType { return &Append{} }, "AspectCrop": func() TransformationType { return &AspectCrop{} }, "BackgroundColor": func() TransformationType { return &BackgroundColor{} }, "Blur": func() TransformationType { return &Blur{} }, "ChromaKey": func() TransformationType { return &ChromaKey{} }, "Composite": func() TransformationType { return &Composite{} }, "Compound": func() TransformationType { return &Compound{} }, "Contrast": func() TransformationType { return &Contrast{} }, "Crop": func() TransformationType { return &Crop{} }, "FaceCrop": func() TransformationType { return &FaceCrop{} }, "FeatureCrop": func() TransformationType { return &FeatureCrop{} }, "FitAndFill": func() TransformationType { return &FitAndFill{} }, "Goop": func() TransformationType { return &Goop{} }, "Grayscale": func() TransformationType { return &Grayscale{} }, "HSL": func() TransformationType { return &HSL{} }, "HSV": func() TransformationType { return &HSV{} }, "IfDimension": func() TransformationType { return &IfDimension{} }, "IfOrientation": func() TransformationType { return &IfOrientation{} }, "ImQuery": func() TransformationType { return &ImQuery{} }, "MaxColors": func() TransformationType { return &MaxColors{} }, "Mirror": func() TransformationType { return &Mirror{} }, "MonoHue": func() TransformationType { return &MonoHue{} }, "Opacity": func() TransformationType { return &Opacity{} }, "RegionOfInterestCrop": func() TransformationType { return &RegionOfInterestCrop{} }, "RelativeCrop": func() TransformationType { return &RelativeCrop{} }, "RemoveColor": func() TransformationType { return &RemoveColor{} }, "Resize": func() TransformationType { return &Resize{} }, "Rotate": func() TransformationType { return &Rotate{} }, "Scale": func() TransformationType { return &Scale{} }, "Shear": func() TransformationType { return &Shear{} }, "SmartCrop": func() TransformationType { return &SmartCrop{} }, "Trim": func() TransformationType { return &Trim{} }, "UnsharpMask": func() TransformationType { return &UnsharpMask{} }, }
TransformationHandlers is a map of available transformations
Functions ¶
This section is empty.
Types ¶
type Append ¶
type Append struct {
// Gravity Specifies where to place the `image` relative to the source image. The available values represent the eight cardinal directions (`North`, `South`, `East`, `West`, `NorthEast`, `NorthWest`, `SouthEast`, `SouthWest`) and a `Center` by default.
Gravity *GravityVariableInline `json:"gravity,omitempty"`
// GravityPriority Determines the exact placement of the `image` when `gravity` is `Center` or a diagonal. The value is either `horizontal` or `vertical`. Use `horizontal` to append an `image` east or west of the source image. This aligns the `image` on the vertical gravity component, placing `Center` gravity east. Use `vertical` to append an `image` north or south of the source image. This aligns the `image` on the horizontal gravity component, placing `Center` gravity south.
GravityPriority *AppendGravityPriorityVariableInline `json:"gravityPriority,omitempty"`
Image ImageType `json:"image"`
// PreserveMinorDimension Whether to preserve the source image's minor dimension, `false` by default. The minor dimension is the dimension opposite the dimension that the appending `image` is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appending `image` are 50 × 150 pixels. The `gravity` is set to `East`. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, the `preserveMinorDimension` is set to `true`. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.
PreserveMinorDimension *BooleanVariableInline `json:"preserveMinorDimension,omitempty"`
// Transformation Identifies this type of transformation, `Append` in this case.
Transformation AppendTransformation `json:"transformation"`
}
Append Places a specified `image` beside the source image. The API places the `image` on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image.
func (*Append) UnmarshalJSON ¶
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to ImageType interface
type AppendGravityPriority ¶
type AppendGravityPriority string
AppendGravityPriority ...
func AppendGravityPriorityPtr ¶
func AppendGravityPriorityPtr(v AppendGravityPriority) *AppendGravityPriority
AppendGravityPriorityPtr returns pointer of AppendGravityPriority
type AppendGravityPriorityVariableInline ¶
type AppendGravityPriorityVariableInline struct {
Name *string
Value *AppendGravityPriority
}
AppendGravityPriorityVariableInline represents a type which stores either a value or a variable name
func (*AppendGravityPriorityVariableInline) MarshalJSON ¶
func (a *AppendGravityPriorityVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*AppendGravityPriorityVariableInline) UnmarshalJSON ¶
func (a *AppendGravityPriorityVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (AppendGravityPriorityVariableInline) Validate ¶
func (a AppendGravityPriorityVariableInline) Validate() error
Validate validates AppendGravityPriorityVariableInline
type AppendTransformation ¶
type AppendTransformation string
AppendTransformation ...
func AppendTransformationPtr ¶
func AppendTransformationPtr(v AppendTransformation) *AppendTransformation
AppendTransformationPtr returns pointer of AppendTransformation
type AspectCrop ¶
type AspectCrop struct {
// AllowExpansion Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.
AllowExpansion *BooleanVariableInline `json:"allowExpansion,omitempty"`
// Height The height term of the aspect ratio to crop.
Height *NumberVariableInline `json:"height,omitempty"`
// Transformation Identifies this type of transformation, `AspectCrop` in this case.
Transformation AspectCropTransformation `json:"transformation"`
// Width The width term of the aspect ratio to crop.
Width *NumberVariableInline `json:"width,omitempty"`
// XPosition Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
XPosition *NumberVariableInline `json:"xPosition,omitempty"`
// YPosition Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.
YPosition *NumberVariableInline `json:"yPosition,omitempty"`
}
AspectCrop Lets you change the height or width of an image (either by cropping or expanding the area) to an aspect ratio of your choosing.
type AspectCropTransformation ¶
type AspectCropTransformation string
AspectCropTransformation ...
func AspectCropTransformationPtr ¶
func AspectCropTransformationPtr(v AspectCropTransformation) *AspectCropTransformation
AspectCropTransformationPtr returns pointer of AspectCropTransformation
type BackgroundColor ¶
type BackgroundColor struct {
// Color The hexadecimal CSS color value for the background.
Color *StringVariableInline `json:"color"`
// Transformation Identifies this type of transformation, `BackgroundColor` in this case.
Transformation BackgroundColorTransformation `json:"transformation"`
}
BackgroundColor Places a transparent image on a set background color. Color is specified in the typical CSS hexadecimal format.
func (BackgroundColor) Validate ¶
func (b BackgroundColor) Validate() error
Validate validates BackgroundColor
type BackgroundColorTransformation ¶
type BackgroundColorTransformation string
BackgroundColorTransformation ...
func BackgroundColorTransformationPtr ¶
func BackgroundColorTransformationPtr(v BackgroundColorTransformation) *BackgroundColorTransformation
BackgroundColorTransformationPtr returns pointer of BackgroundColorTransformation
type Blur ¶
type Blur struct {
// Sigma The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.
Sigma *NumberVariableInline `json:"sigma,omitempty"`
// Transformation Identifies this type of transformation, `Blur` in this case.
Transformation BlurTransformation `json:"transformation"`
}
Blur Applies a Gaussian blur to the image.
type BlurTransformation ¶
type BlurTransformation string
BlurTransformation ...
func BlurTransformationPtr ¶
func BlurTransformationPtr(v BlurTransformation) *BlurTransformation
BlurTransformationPtr returns pointer of BlurTransformation
type BooleanVariableInline ¶
BooleanVariableInline represents a type which stores either a value or a variable name
func (*BooleanVariableInline) MarshalJSON ¶
func (b *BooleanVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*BooleanVariableInline) UnmarshalJSON ¶
func (b *BooleanVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (BooleanVariableInline) Validate ¶
func (b BooleanVariableInline) Validate() error
Validate validates BooleanVariableInline
type BoxImageType ¶
type BoxImageType struct {
// Color The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
Color *StringVariableInline `json:"color,omitempty"`
// Height The height of the box in pixels.
Height *IntegerVariableInline `json:"height,omitempty"`
Transformation TransformationType `json:"transformation,omitempty"`
// Type Identifies the type of image, `Box` in this case.
Type BoxImageTypeType `json:"type"`
// Width The width of the box in pixels.
Width *IntegerVariableInline `json:"width,omitempty"`
}
BoxImageType A rectangular box, with a specified color and applied transformation.
func (*BoxImageType) UnmarshalJSON ¶
func (b *BoxImageType) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to Transformation interface
func (BoxImageType) Validate ¶
func (b BoxImageType) Validate() error
Validate validates BoxImageType
type BoxImageTypePost ¶
type BoxImageTypePost struct {
// Color The fill color of the box, not the edge of the box. The API supports hexadecimal representation and CSS hexadecimal color values.
Color *StringVariableInline `json:"color,omitempty"`
// Height The height of the box in pixels.
Height *IntegerVariableInline `json:"height,omitempty"`
Transformation TransformationTypePost `json:"transformation,omitempty"`
// Type Identifies the type of image, `Box` in this case.
Type BoxImageTypePostType `json:"type"`
// Width The width of the box in pixels.
Width *IntegerVariableInline `json:"width,omitempty"`
}
BoxImageTypePost A rectangular box, with a specified color and applied transformation.
func (*BoxImageTypePost) UnmarshalJSON ¶
func (b *BoxImageTypePost) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to PostBreakpointTransformation interface
func (BoxImageTypePost) Validate ¶
func (b BoxImageTypePost) Validate() error
Validate validates BoxImageTypePost
type BoxImageTypePostType ¶
type BoxImageTypePostType string
BoxImageTypePostType ...
func BoxImageTypePostTypePtr ¶
func BoxImageTypePostTypePtr(v BoxImageTypePostType) *BoxImageTypePostType
BoxImageTypePostTypePtr returns pointer of BoxImageTypePostType
type BoxImageTypeType ¶
type BoxImageTypeType string
BoxImageTypeType ...
func BoxImageTypeTypePtr ¶
func BoxImageTypeTypePtr(v BoxImageTypeType) *BoxImageTypeType
BoxImageTypeTypePtr returns pointer of BoxImageTypeType
type Breakpoints ¶
type Breakpoints struct {
Widths []int `json:"widths,omitempty"`
}
Breakpoints The breakpoint widths (in pixels) to use to create derivative images/videos.
type ChromaKey ¶
type ChromaKey struct {
// Hue The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120° on the color wheel.
Hue *NumberVariableInline `json:"hue,omitempty"`
// HueFeather How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30° around the Hue Tolerance.
HueFeather *NumberVariableInline `json:"hueFeather,omitempty"`
// HueTolerance How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30° around the specified hue.
HueTolerance *NumberVariableInline `json:"hueTolerance,omitempty"`
// LightnessFeather How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.
LightnessFeather *NumberVariableInline `json:"lightnessFeather,omitempty"`
// LightnessTolerance How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a colour must be within 75% of the full color to full white or full black for full removal.
LightnessTolerance *NumberVariableInline `json:"lightnessTolerance,omitempty"`
// SaturationFeather How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the saturationTolerance.
SaturationFeather *NumberVariableInline `json:"saturationFeather,omitempty"`
// SaturationTolerance How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.
SaturationTolerance *NumberVariableInline `json:"saturationTolerance,omitempty"`
// Transformation Identifies this type of transformation, `ChromaKey` in this case.
Transformation ChromaKeyTransformation `json:"transformation"`
}
ChromaKey Changes any color in an image within the specified volume of the HSL colorspace to transparent or semitransparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.
type ChromaKeyTransformation ¶
type ChromaKeyTransformation string
ChromaKeyTransformation ...
func ChromaKeyTransformationPtr ¶
func ChromaKeyTransformationPtr(v ChromaKeyTransformation) *ChromaKeyTransformation
ChromaKeyTransformationPtr returns pointer of ChromaKeyTransformation
type CircleImageType ¶
type CircleImageType struct {
// Color The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
Color *StringVariableInline `json:"color,omitempty"`
// Diameter The diameter of the circle. The diameter will be the width and the height of the image in pixels.
Diameter *IntegerVariableInline `json:"diameter,omitempty"`
Transformation TransformationType `json:"transformation,omitempty"`
// Type Identifies the type of image, `Circle` in this case.
Type CircleImageTypeType `json:"type"`
// Width The width of the box in pixels.
Width *IntegerVariableInline `json:"width,omitempty"`
}
CircleImageType A rectangular box, with a specified color and applied transformation.
func (*CircleImageType) UnmarshalJSON ¶
func (c *CircleImageType) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to Transformation interface
func (CircleImageType) Validate ¶
func (c CircleImageType) Validate() error
Validate validates CircleImageType
type CircleImageTypePost ¶
type CircleImageTypePost struct {
// Color The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.
Color *StringVariableInline `json:"color,omitempty"`
// Diameter The diameter of the circle. The diameter will be the width and the height of the image in pixels.
Diameter *IntegerVariableInline `json:"diameter,omitempty"`
Transformation TransformationTypePost `json:"transformation,omitempty"`
// Type Identifies the type of image, `Circle` in this case.
Type CircleImageTypePostType `json:"type"`
// Width The width of the box in pixels.
Width *IntegerVariableInline `json:"width,omitempty"`
}
CircleImageTypePost A rectangular box, with a specified color and applied transformation.
func (*CircleImageTypePost) UnmarshalJSON ¶
func (c *CircleImageTypePost) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to PostBreakpointTransformation interface
func (CircleImageTypePost) Validate ¶
func (c CircleImageTypePost) Validate() error
Validate validates CircleImageTypePost
type CircleImageTypePostType ¶
type CircleImageTypePostType string
CircleImageTypePostType ...
func CircleImageTypePostTypePtr ¶
func CircleImageTypePostTypePtr(v CircleImageTypePostType) *CircleImageTypePostType
CircleImageTypePostTypePtr returns pointer of CircleImageTypePostType
type CircleImageTypeType ¶
type CircleImageTypeType string
CircleImageTypeType ...
func CircleImageTypeTypePtr ¶
func CircleImageTypeTypePtr(v CircleImageTypeType) *CircleImageTypeType
CircleImageTypeTypePtr returns pointer of CircleImageTypeType
type CircleShapeType ¶
type CircleShapeType struct {
// Center Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x`and `y` members, or a two-element array.
Center *PointShapeType `json:"center"`
// Radius The radius of the circle measured in pixels.
Radius *NumberVariableInline `json:"radius"`
}
CircleShapeType Defines a circle with a specified `radius` from its `center` point.
func (CircleShapeType) Validate ¶
func (c CircleShapeType) Validate() error
Validate validates CircleShapeType
type ClientFunc ¶
ClientFunc is a Image and Video Manager client new method, this can be used for mocking
type Composite ¶
type Composite struct {
// Gravity Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
Gravity *GravityVariableInline `json:"gravity,omitempty"`
Image ImageType `json:"image"`
// Placement Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
Placement *CompositePlacementVariableInline `json:"placement,omitempty"`
// Scale A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the `scaleDimension` to calculate the `scale` from the source image's width or height.
Scale *NumberVariableInline `json:"scale,omitempty"`
// ScaleDimension The dimension, either `width` or `height`, of the source image to scale.
ScaleDimension *CompositeScaleDimensionVariableInline `json:"scaleDimension,omitempty"`
// Transformation Identifies this type of transformation, `Composite` in this case.
Transformation CompositeTransformation `json:"transformation"`
// XPosition The x-axis position of the image to apply.
XPosition *IntegerVariableInline `json:"xPosition,omitempty"`
// YPosition The y-axis position of the image to apply.
YPosition *IntegerVariableInline `json:"yPosition,omitempty"`
}
Composite Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.
func (*Composite) UnmarshalJSON ¶
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to ImageType interface
type CompositePlacement ¶
type CompositePlacement string
CompositePlacement ...
func CompositePlacementPtr ¶
func CompositePlacementPtr(v CompositePlacement) *CompositePlacement
CompositePlacementPtr returns pointer of CompositePlacement
type CompositePlacementVariableInline ¶
type CompositePlacementVariableInline struct {
Name *string
Value *CompositePlacement
}
CompositePlacementVariableInline represents a type which stores either a value or a variable name
func (*CompositePlacementVariableInline) MarshalJSON ¶
func (c *CompositePlacementVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*CompositePlacementVariableInline) UnmarshalJSON ¶
func (c *CompositePlacementVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (CompositePlacementVariableInline) Validate ¶
func (c CompositePlacementVariableInline) Validate() error
Validate validates CompositePlacementVariableInline
type CompositePost ¶
type CompositePost struct {
// Gravity Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position
Gravity *GravityPostVariableInline `json:"gravity,omitempty"`
Image ImageTypePost `json:"image"`
// Placement Place applied image on top of or underneath the base image. Watermarks are usually applied over. Backgrounds are usually applied under.
Placement *CompositePostPlacementVariableInline `json:"placement,omitempty"`
// Scale A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the `scaleDimension` to calculate the `scale` from the source image's width or height.
Scale *NumberVariableInline `json:"scale,omitempty"`
// ScaleDimension The dimension, either `width` or `height`, of the source image to scale.
ScaleDimension *CompositePostScaleDimensionVariableInline `json:"scaleDimension,omitempty"`
// Transformation Identifies this type of transformation, `Composite` in this case.
Transformation CompositePostTransformation `json:"transformation"`
// XPosition The x-axis position of the image to apply.
XPosition *IntegerVariableInline `json:"xPosition,omitempty"`
// YPosition The y-axis position of the image to apply.
YPosition *IntegerVariableInline `json:"yPosition,omitempty"`
}
CompositePost Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.
func (*CompositePost) UnmarshalJSON ¶
func (c *CompositePost) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to ImageType interface
func (CompositePost) Validate ¶
func (c CompositePost) Validate() error
Validate validates CompositePost
type CompositePostPlacement ¶
type CompositePostPlacement string
CompositePostPlacement ...
func CompositePostPlacementPtr ¶
func CompositePostPlacementPtr(v CompositePostPlacement) *CompositePostPlacement
CompositePostPlacementPtr returns pointer of CompositePostPlacement
type CompositePostPlacementVariableInline ¶
type CompositePostPlacementVariableInline struct {
Name *string
Value *CompositePostPlacement
}
CompositePostPlacementVariableInline represents a type which stores either a value or a variable name
func (*CompositePostPlacementVariableInline) MarshalJSON ¶
func (c *CompositePostPlacementVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*CompositePostPlacementVariableInline) UnmarshalJSON ¶
func (c *CompositePostPlacementVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (CompositePostPlacementVariableInline) Validate ¶
func (c CompositePostPlacementVariableInline) Validate() error
Validate validates CompositePostPlacementVariableInline
type CompositePostScaleDimension ¶
type CompositePostScaleDimension string
CompositePostScaleDimension ...
func CompositePostScaleDimensionPtr ¶
func CompositePostScaleDimensionPtr(v CompositePostScaleDimension) *CompositePostScaleDimension
CompositePostScaleDimensionPtr returns pointer of CompositePostScaleDimension
type CompositePostScaleDimensionVariableInline ¶
type CompositePostScaleDimensionVariableInline struct {
Name *string
Value *CompositePostScaleDimension
}
CompositePostScaleDimensionVariableInline represents a type which stores either a value or a variable name
func (*CompositePostScaleDimensionVariableInline) MarshalJSON ¶
func (c *CompositePostScaleDimensionVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*CompositePostScaleDimensionVariableInline) UnmarshalJSON ¶
func (c *CompositePostScaleDimensionVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (CompositePostScaleDimensionVariableInline) Validate ¶
func (c CompositePostScaleDimensionVariableInline) Validate() error
Validate validates CompositePostScaleDimensionVariableInline
type CompositePostTransformation ¶
type CompositePostTransformation string
CompositePostTransformation ...
func CompositePostTransformationPtr ¶
func CompositePostTransformationPtr(v CompositePostTransformation) *CompositePostTransformation
CompositePostTransformationPtr returns pointer of CompositePostTransformation
type CompositeScaleDimension ¶
type CompositeScaleDimension string
CompositeScaleDimension ...
func CompositeScaleDimensionPtr ¶
func CompositeScaleDimensionPtr(v CompositeScaleDimension) *CompositeScaleDimension
CompositeScaleDimensionPtr returns pointer of CompositeScaleDimension
type CompositeScaleDimensionVariableInline ¶
type CompositeScaleDimensionVariableInline struct {
Name *string
Value *CompositeScaleDimension
}
CompositeScaleDimensionVariableInline represents a type which stores either a value or a variable name
func (*CompositeScaleDimensionVariableInline) MarshalJSON ¶
func (c *CompositeScaleDimensionVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*CompositeScaleDimensionVariableInline) UnmarshalJSON ¶
func (c *CompositeScaleDimensionVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (CompositeScaleDimensionVariableInline) Validate ¶
func (c CompositeScaleDimensionVariableInline) Validate() error
Validate validates CompositeScaleDimensionVariableInline
type CompositeTransformation ¶
type CompositeTransformation string
CompositeTransformation ...
func CompositeTransformationPtr ¶
func CompositeTransformationPtr(v CompositeTransformation) *CompositeTransformation
CompositeTransformationPtr returns pointer of CompositeTransformation
type Compound ¶
type Compound struct {
// Transformation Identifies this type of transformation, `Compound` in this case.
Transformation CompoundTransformation `json:"transformation"`
Transformations Transformations `json:"transformations,omitempty"`
}
Compound ...
type CompoundPost ¶
type CompoundPost struct {
// Transformation Identifies this type of transformation, `Compound` in this case.
Transformation CompoundPostTransformation `json:"transformation"`
Transformations PostBreakpointTransformations `json:"transformations,omitempty"`
}
CompoundPost ...
func (CompoundPost) Validate ¶
func (c CompoundPost) Validate() error
Validate validates CompoundPost
type CompoundPostTransformation ¶
type CompoundPostTransformation string
CompoundPostTransformation ...
func CompoundPostTransformationPtr ¶
func CompoundPostTransformationPtr(v CompoundPostTransformation) *CompoundPostTransformation
CompoundPostTransformationPtr returns pointer of CompoundPostTransformation
type CompoundTransformation ¶
type CompoundTransformation string
CompoundTransformation ...
func CompoundTransformationPtr ¶
func CompoundTransformationPtr(v CompoundTransformation) *CompoundTransformation
CompoundTransformationPtr returns pointer of CompoundTransformation
type Contrast ¶
type Contrast struct {
// Brightness Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.
Brightness *NumberVariableInline `json:"brightness,omitempty"`
// Contrast Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.
Contrast *NumberVariableInline `json:"contrast,omitempty"`
// Transformation Identifies this type of transformation, `Contrast` in this case.
Transformation ContrastTransformation `json:"transformation"`
}
Contrast Adjusts both the contrast and brightness of an image.
type ContrastTransformation ¶
type ContrastTransformation string
ContrastTransformation ...
func ContrastTransformationPtr ¶
func ContrastTransformationPtr(v ContrastTransformation) *ContrastTransformation
ContrastTransformationPtr returns pointer of ContrastTransformation
type CreatePolicySet ¶
type CreatePolicySet struct {
Name string `json:"name"`
Region Region `json:"region"`
Type MediaType `json:"type"`
DefaultPolicy PolicyInput `json:"defaultPolicy,omitempty"`
}
CreatePolicySet describes the body of the CreatePolicySet request
type CreatePolicySetRequest ¶
type CreatePolicySetRequest struct {
ContractID string
CreatePolicySet
}
CreatePolicySetRequest describes the parameters of the CreatePolicySet request
func (CreatePolicySetRequest) Validate ¶
func (v CreatePolicySetRequest) Validate() error
Validate validates CreatePolicySetRequest
type Crop ¶
type Crop struct {
// AllowExpansion If cropping an area outside of the existing canvas, expands the image canvas.
AllowExpansion *BooleanVariableInline `json:"allowExpansion,omitempty"`
// Gravity Frame of reference for X and Y Positions.
Gravity *GravityVariableInline `json:"gravity,omitempty"`
// Height The number of pixels to crop along the y-axis.
Height *IntegerVariableInline `json:"height"`
// Transformation Identifies this type of transformation, `Crop` in this case.
Transformation CropTransformation `json:"transformation"`
// Width The number of pixels to crop along the x-axis.
Width *IntegerVariableInline `json:"width"`
// XPosition The x-axis position of the image to crop from.
XPosition *IntegerVariableInline `json:"xPosition,omitempty"`
// YPosition The y-axis position of the image to crop from.
YPosition *IntegerVariableInline `json:"yPosition,omitempty"`
}
Crop Crops an image.
type CropTransformation ¶
type CropTransformation string
CropTransformation ...
func CropTransformationPtr ¶
func CropTransformationPtr(v CropTransformation) *CropTransformation
CropTransformationPtr returns pointer of CropTransformation
type DeletePolicyRequest ¶
type DeletePolicyRequest policyRequest
DeletePolicyRequest describes the parameters of the DeletePolicy request
func (DeletePolicyRequest) Validate ¶
func (v DeletePolicyRequest) Validate() error
Validate validates DeletePolicyRequest
type DeletePolicySetRequest ¶
DeletePolicySetRequest describes the parameters of the delete PolicySet request
func (DeletePolicySetRequest) Validate ¶
func (v DeletePolicySetRequest) Validate() error
Validate validates DeletePolicySetRequest
type EnumOptions ¶
type EnumOptions struct {
// ID The unique identifier for each enum value, up to 50 alphanumeric characters.
ID string `json:"id"`
// Value The value of the variable when the `id` is provided.
Value string `json:"value"`
}
EnumOptions Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.
type Error ¶
type Error struct {
Type string `json:"type,omitempty"`
Title string `json:"title,omitempty"`
Detail string `json:"detail,omitempty"`
Instance string `json:"instance,omitempty"`
Status int `json:"status,omitempty"`
ProblemID string `json:"problemId,omitempty"`
RequestID string `json:"requestId,omitempty"`
IllegalValue string `json:"illegalValue,omitempty"`
ParameterName string `json:"parameterName,omitempty"`
ExtensionFields map[string]string `json:"extensionFields,omitempty"`
Method string `json:"method,omitempty"`
ServerIP string `json:"serverIp,omitempty"`
ClientIP string `json:"clientIp,omitempty"`
RequestTime string `json:"requestTime,omitempty"`
AuthzRealm string `json:"authzRealm,omitempty"`
}
Error is an Image and Video Manager error implementation
type FaceCrop ¶
type FaceCrop struct {
// Algorithm Specifies the type of algorithm used to detect faces in the image, either `cascade` for the cascade classifier algorithm or `dnn` for the deep neural network algorithm, `cascade` by default.
Algorithm *FaceCropAlgorithmVariableInline `json:"algorithm,omitempty"`
// Confidence With `algorithm` set to `dnn`, specifies the minimum confidence needed to detect faces in the image. Values range from `0` to `1` for increased confidence, and possibly fewer faces detected.
Confidence *NumberVariableInline `json:"confidence,omitempty"`
// FailGravity Controls placement of the crop if Image and Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.
FailGravity *GravityVariableInline `json:"failGravity,omitempty"`
// Focus Distinguishes the faces detected, either `biggestFace` or `allFaces` to place the crop rectangle around the full set of faces, `all` by default.
Focus *FaceCropFocusVariableInline `json:"focus,omitempty"`
// Gravity Controls placement of the crop. Directions are relative to the face(s) plus padding.
Gravity *GravityVariableInline `json:"gravity,omitempty"`
// Height The height of the output image in pixels relative to the specified `style` value.
Height *IntegerVariableInline `json:"height"`
// Padding The padding ratio based on the dimensions of the biggest face detected, `0.5` by default. Larger values increase padding.
Padding *NumberVariableInline `json:"padding,omitempty"`
// Style Specifies how to crop or scale a crop area for the faces detected in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places a raw crop around the faces, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and faces as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the faces, relative to the specified `width` and `height` values. Allows Variable substitution.
Style *FaceCropStyleVariableInline `json:"style,omitempty"`
// Transformation Identifies this type of transformation, `FaceCrop` in this case.
Transformation FaceCropTransformation `json:"transformation"`
// Width The width of the output image in pixels relative to the specified `style` value.
Width *IntegerVariableInline `json:"width"`
}
FaceCrop Applies a method to detect faces in the source image and applies the rectangular crop on either the `biggest` face or `all` of the faces detected. Image and Video Manager tries to preserve faces in the image instead of using specified crop coordinates.
type FaceCropAlgorithm ¶
type FaceCropAlgorithm string
FaceCropAlgorithm ...
func FaceCropAlgorithmPtr ¶
func FaceCropAlgorithmPtr(v FaceCropAlgorithm) *FaceCropAlgorithm
FaceCropAlgorithmPtr returns pointer of FaceCropAlgorithm
type FaceCropAlgorithmVariableInline ¶
type FaceCropAlgorithmVariableInline struct {
Name *string
Value *FaceCropAlgorithm
}
FaceCropAlgorithmVariableInline represents a type which stores either a value or a variable name
func (*FaceCropAlgorithmVariableInline) MarshalJSON ¶
func (f *FaceCropAlgorithmVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*FaceCropAlgorithmVariableInline) UnmarshalJSON ¶
func (f *FaceCropAlgorithmVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (FaceCropAlgorithmVariableInline) Validate ¶
func (f FaceCropAlgorithmVariableInline) Validate() error
Validate validates FaceCropAlgorithmVariableInline
type FaceCropFocus ¶
type FaceCropFocus string
FaceCropFocus ...
func FaceCropFocusPtr ¶
func FaceCropFocusPtr(v FaceCropFocus) *FaceCropFocus
FaceCropFocusPtr returns pointer of FaceCropFocus
type FaceCropFocusVariableInline ¶
type FaceCropFocusVariableInline struct {
Name *string
Value *FaceCropFocus
}
FaceCropFocusVariableInline represents a type which stores either a value or a variable name
func (*FaceCropFocusVariableInline) MarshalJSON ¶
func (f *FaceCropFocusVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*FaceCropFocusVariableInline) UnmarshalJSON ¶
func (f *FaceCropFocusVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (FaceCropFocusVariableInline) Validate ¶
func (f FaceCropFocusVariableInline) Validate() error
Validate validates FaceCropFocusVariableInline
type FaceCropStyle ¶
type FaceCropStyle string
FaceCropStyle ...
func FaceCropStylePtr ¶
func FaceCropStylePtr(v FaceCropStyle) *FaceCropStyle
FaceCropStylePtr returns pointer of FaceCropStyle
type FaceCropStyleVariableInline ¶
type FaceCropStyleVariableInline struct {
Name *string
Value *FaceCropStyle
}
FaceCropStyleVariableInline represents a type which stores either a value or a variable name
func (*FaceCropStyleVariableInline) MarshalJSON ¶
func (f *FaceCropStyleVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*FaceCropStyleVariableInline) UnmarshalJSON ¶
func (f *FaceCropStyleVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (FaceCropStyleVariableInline) Validate ¶
func (f FaceCropStyleVariableInline) Validate() error
Validate validates FaceCropStyleVariableInline
type FaceCropTransformation ¶
type FaceCropTransformation string
FaceCropTransformation ...
func FaceCropTransformationPtr ¶
func FaceCropTransformationPtr(v FaceCropTransformation) *FaceCropTransformation
FaceCropTransformationPtr returns pointer of FaceCropTransformation
type FeatureCrop ¶
type FeatureCrop struct {
// FailGravity Controls placement of the crop if Image and Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.
FailGravity *GravityVariableInline `json:"failGravity,omitempty"`
// FeatureRadius The size in pixels of the important features to search for. If identified, two features never appear closer together than this value, `8.0` by default.
FeatureRadius *NumberVariableInline `json:"featureRadius,omitempty"`
// Gravity Controls placement of the crop. Directions are relative to the region of interest plus padding.
Gravity *GravityVariableInline `json:"gravity,omitempty"`
// Height The height in pixels of the output image relative to the specified `style` value.
Height *IntegerVariableInline `json:"height"`
// MaxFeatures The maximum number of features to identify as important features, `32` by default. The strongest features are always chosen.
MaxFeatures *IntegerVariableInline `json:"maxFeatures,omitempty"`
// MinFeatureQuality Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image and Video Manager measures quality on a scale from `0` for the lowest quality to `1` for the highest quality, `.1` by default.
MinFeatureQuality *NumberVariableInline `json:"minFeatureQuality,omitempty"`
// Padding Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.
Padding *NumberVariableInline `json:"padding,omitempty"`
// Style Specifies how to crop or scale a crop area for the features identified in the source image, `fill` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` performs a raw crop around the features, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and features as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the features, relative to the specified `width` and `height` values. Allows Variable substitution.
Style *FeatureCropStyleVariableInline `json:"style,omitempty"`
// Transformation Identifies this type of transformation, `FeatureCrop` in this case.
Transformation FeatureCropTransformation `json:"transformation"`
// Width The width in pixels of the output image relative to the specified `style` value.
Width *IntegerVariableInline `json:"width"`
}
FeatureCrop Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified `width` and `height` values.
type FeatureCropStyle ¶
type FeatureCropStyle string
FeatureCropStyle ...
func FeatureCropStylePtr ¶
func FeatureCropStylePtr(v FeatureCropStyle) *FeatureCropStyle
FeatureCropStylePtr returns pointer of FeatureCropStyle
type FeatureCropStyleVariableInline ¶
type FeatureCropStyleVariableInline struct {
Name *string
Value *FeatureCropStyle
}
FeatureCropStyleVariableInline represents a type which stores either a value or a variable name
func (*FeatureCropStyleVariableInline) MarshalJSON ¶
func (f *FeatureCropStyleVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*FeatureCropStyleVariableInline) UnmarshalJSON ¶
func (f *FeatureCropStyleVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (FeatureCropStyleVariableInline) Validate ¶
func (f FeatureCropStyleVariableInline) Validate() error
Validate validates FeatureCropStyleVariableInline
type FeatureCropTransformation ¶
type FeatureCropTransformation string
FeatureCropTransformation ...
func FeatureCropTransformationPtr ¶
func FeatureCropTransformationPtr(v FeatureCropTransformation) *FeatureCropTransformation
FeatureCropTransformationPtr returns pointer of FeatureCropTransformation
type FitAndFill ¶
type FitAndFill struct {
FillTransformation TransformationType `json:"fillTransformation,omitempty"`
// Height The height value of the resized image.
Height *IntegerVariableInline `json:"height"`
// Transformation Identifies this type of transformation, `FitAndFill` in this case.
Transformation FitAndFillTransformation `json:"transformation"`
// Width The width value of the resized image.
Width *IntegerVariableInline `json:"width"`
}
FitAndFill Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied, but the transformation can be customized using the fillTransformation parameter.
func (*FitAndFill) UnmarshalJSON ¶
func (f *FitAndFill) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to Transformation interface
type FitAndFillTransformation ¶
type FitAndFillTransformation string
FitAndFillTransformation ...
func FitAndFillTransformationPtr ¶
func FitAndFillTransformationPtr(v FitAndFillTransformation) *FitAndFillTransformation
FitAndFillTransformationPtr returns pointer of FitAndFillTransformation
type GetPolicyHistoryRequest ¶
type GetPolicyHistoryRequest policyRequest
GetPolicyHistoryRequest describes the parameters of the GetHistoryPolicy request
func (GetPolicyHistoryRequest) Validate ¶
func (v GetPolicyHistoryRequest) Validate() error
Validate validates GetPolicyHistoryRequest
type GetPolicyHistoryResponse ¶
type GetPolicyHistoryResponse struct {
ItemKind string `json:"itemKind"`
TotalItems int `json:"totalItems"`
Items []PolicyHistoryItem `json:"items"`
}
GetPolicyHistoryResponse describes the parameters of the GetPolicyHistory response
type GetPolicyRequest ¶
type GetPolicyRequest policyRequest
GetPolicyRequest describes the parameters of the GetPolicy request
func (GetPolicyRequest) Validate ¶
func (v GetPolicyRequest) Validate() error
Validate validates GetPolicyRequest
type GetPolicySetRequest ¶
GetPolicySetRequest describes the parameters of the get GetPolicySet request
func (GetPolicySetRequest) Validate ¶
func (v GetPolicySetRequest) Validate() error
Validate validates GetPolicySetRequest
type Goop ¶
type Goop struct {
// Chaos Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.
Chaos *NumberVariableInline `json:"chaos,omitempty"`
// Density Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium to large size images.
Density *IntegerVariableInline `json:"density,omitempty"`
// Power By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldnt need to vary the default value of `2.0`.
Power *NumberVariableInline `json:"power,omitempty"`
// Seed Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.
Seed *IntegerVariableInline `json:"seed,omitempty"`
// Transformation Identifies this type of transformation, `Goop` in this case.
Transformation GoopTransformation `json:"transformation"`
}
Goop Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.
type GoopTransformation ¶
type GoopTransformation string
GoopTransformation ...
func GoopTransformationPtr ¶
func GoopTransformationPtr(v GoopTransformation) *GoopTransformation
GoopTransformationPtr returns pointer of GoopTransformation
type GravityPost ¶
type GravityPost string
GravityPost ...
func GravityPostPtr ¶
func GravityPostPtr(v GravityPost) *GravityPost
GravityPostPtr returns pointer of GravityPost
type GravityPostVariableInline ¶
type GravityPostVariableInline struct {
Name *string
Value *GravityPost
}
GravityPostVariableInline represents a type which stores either a value or a variable name
func (*GravityPostVariableInline) MarshalJSON ¶
func (g *GravityPostVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*GravityPostVariableInline) UnmarshalJSON ¶
func (g *GravityPostVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (GravityPostVariableInline) Validate ¶
func (g GravityPostVariableInline) Validate() error
Validate validates GravityPostVariableInline
type GravityVariableInline ¶
GravityVariableInline represents a type which stores either a value or a variable name
func (*GravityVariableInline) MarshalJSON ¶
func (g *GravityVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*GravityVariableInline) UnmarshalJSON ¶
func (g *GravityVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (GravityVariableInline) Validate ¶
func (g GravityVariableInline) Validate() error
Validate validates GravityVariableInline
type Grayscale ¶
type Grayscale struct {
// Transformation Identifies this type of transformation, `Grayscale` in this case.
Transformation GrayscaleTransformation `json:"transformation"`
// Type The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.
Type *GrayscaleTypeVariableInline `json:"type,omitempty"`
}
Grayscale Restricts image color to shades of gray only.
type GrayscaleTransformation ¶
type GrayscaleTransformation string
GrayscaleTransformation ...
func GrayscaleTransformationPtr ¶
func GrayscaleTransformationPtr(v GrayscaleTransformation) *GrayscaleTransformation
GrayscaleTransformationPtr returns pointer of GrayscaleTransformation
type GrayscaleType ¶
type GrayscaleType string
GrayscaleType ...
func GrayscaleTypePtr ¶
func GrayscaleTypePtr(v GrayscaleType) *GrayscaleType
GrayscaleTypePtr returns pointer of GrayscaleType
type GrayscaleTypeVariableInline ¶
type GrayscaleTypeVariableInline struct {
Name *string
Value *GrayscaleType
}
GrayscaleTypeVariableInline represents a type which stores either a value or a variable name
func (*GrayscaleTypeVariableInline) MarshalJSON ¶
func (g *GrayscaleTypeVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*GrayscaleTypeVariableInline) UnmarshalJSON ¶
func (g *GrayscaleTypeVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (GrayscaleTypeVariableInline) Validate ¶
func (g GrayscaleTypeVariableInline) Validate() error
Validate validates GrayscaleTypeVariableInline
type HSL ¶
type HSL struct {
// Hue The number of degrees to rotate colors around the color wheel, `0` by default.
Hue *NumberVariableInline `json:"hue,omitempty"`
// Lightness A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.
Lightness *NumberVariableInline `json:"lightness,omitempty"`
// Saturation A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.
Saturation *NumberVariableInline `json:"saturation,omitempty"`
// Transformation Identifies this type of transformation, `HSL` in this case.
Transformation HSLTransformation `json:"transformation"`
}
HSL Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If youre using more than one, consider the order to apply them for the desired results.
type HSLTransformation ¶
type HSLTransformation string
HSLTransformation ...
func HSLTransformationPtr ¶
func HSLTransformationPtr(v HSLTransformation) *HSLTransformation
HSLTransformationPtr returns pointer of HSLTransformation
type HSV ¶
type HSV struct {
// Hue The number of degrees to rotate colors around the color wheel, `0.0` by default.
Hue *NumberVariableInline `json:"hue,omitempty"`
// Saturation A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.
Saturation *NumberVariableInline `json:"saturation,omitempty"`
// Transformation Identifies this type of transformation, `HSV` in this case.
Transformation HSVTransformation `json:"transformation"`
// Value A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.
Value *NumberVariableInline `json:"value,omitempty"`
}
HSV Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to grey. This happens because the original image color is very close to white.
type HSVTransformation ¶
type HSVTransformation string
HSVTransformation ...
func HSVTransformationPtr ¶
func HSVTransformationPtr(v HSVTransformation) *HSVTransformation
HSVTransformationPtr returns pointer of HSVTransformation
type IfDimension ¶
type IfDimension struct {
Default TransformationType `json:"default,omitempty"`
// Dimension The dimension to use to select the transformation, either `height`, `width`, or `both`.
Dimension *IfDimensionDimensionVariableInline `json:"dimension,omitempty"`
Equal TransformationType `json:"equal,omitempty"`
GreaterThan TransformationType `json:"greaterThan,omitempty"`
LessThan TransformationType `json:"lessThan,omitempty"`
// Transformation Identifies this type of transformation, `IfDimension` in this case.
Transformation IfDimensionTransformation `json:"transformation"`
// Value The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
Value *IntegerVariableInline `json:"value"`
}
IfDimension ...
func (*IfDimension) UnmarshalJSON ¶
func (i *IfDimension) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to Transformation interface
type IfDimensionDimension ¶
type IfDimensionDimension string
IfDimensionDimension ...
func IfDimensionDimensionPtr ¶
func IfDimensionDimensionPtr(v IfDimensionDimension) *IfDimensionDimension
IfDimensionDimensionPtr returns pointer of IfDimensionDimension
type IfDimensionDimensionVariableInline ¶
type IfDimensionDimensionVariableInline struct {
Name *string
Value *IfDimensionDimension
}
IfDimensionDimensionVariableInline represents a type which stores either a value or a variable name
func (*IfDimensionDimensionVariableInline) MarshalJSON ¶
func (i *IfDimensionDimensionVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*IfDimensionDimensionVariableInline) UnmarshalJSON ¶
func (i *IfDimensionDimensionVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (IfDimensionDimensionVariableInline) Validate ¶
func (i IfDimensionDimensionVariableInline) Validate() error
Validate validates IfDimensionDimensionVariableInline
type IfDimensionPost ¶
type IfDimensionPost struct {
Default TransformationTypePost `json:"default,omitempty"`
// Dimension The dimension to use to select the transformation, either `height`, `width`, or `both`.
Dimension *IfDimensionPostDimensionVariableInline `json:"dimension,omitempty"`
Equal TransformationTypePost `json:"equal,omitempty"`
GreaterThan TransformationTypePost `json:"greaterThan,omitempty"`
LessThan TransformationTypePost `json:"lessThan,omitempty"`
// Transformation Identifies this type of transformation, `IfDimension` in this case.
Transformation IfDimensionPostTransformation `json:"transformation"`
// Value The value to compare against the source image dimension. For example, if the image dimension is less than the value the lessThan transformation is applied.
Value *IntegerVariableInline `json:"value"`
}
IfDimensionPost ...
func (*IfDimensionPost) UnmarshalJSON ¶
func (i *IfDimensionPost) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to PostBreakpointTransformation interface
func (IfDimensionPost) Validate ¶
func (i IfDimensionPost) Validate() error
Validate validates IfDimensionPost
type IfDimensionPostDimension ¶
type IfDimensionPostDimension string
IfDimensionPostDimension ...
func IfDimensionPostDimensionPtr ¶
func IfDimensionPostDimensionPtr(v IfDimensionPostDimension) *IfDimensionPostDimension
IfDimensionPostDimensionPtr returns pointer of IfDimensionPostDimension
type IfDimensionPostDimensionVariableInline ¶
type IfDimensionPostDimensionVariableInline struct {
Name *string
Value *IfDimensionPostDimension
}
IfDimensionPostDimensionVariableInline represents a type which stores either a value or a variable name
func (*IfDimensionPostDimensionVariableInline) MarshalJSON ¶
func (i *IfDimensionPostDimensionVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*IfDimensionPostDimensionVariableInline) UnmarshalJSON ¶
func (i *IfDimensionPostDimensionVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (IfDimensionPostDimensionVariableInline) Validate ¶
func (i IfDimensionPostDimensionVariableInline) Validate() error
Validate validates IfDimensionPostDimensionVariableInline
type IfDimensionPostTransformation ¶
type IfDimensionPostTransformation string
IfDimensionPostTransformation ...
func IfDimensionPostTransformationPtr ¶
func IfDimensionPostTransformationPtr(v IfDimensionPostTransformation) *IfDimensionPostTransformation
IfDimensionPostTransformationPtr returns pointer of IfDimensionPostTransformation
type IfDimensionTransformation ¶
type IfDimensionTransformation string
IfDimensionTransformation ...
func IfDimensionTransformationPtr ¶
func IfDimensionTransformationPtr(v IfDimensionTransformation) *IfDimensionTransformation
IfDimensionTransformationPtr returns pointer of IfDimensionTransformation
type IfOrientation ¶
type IfOrientation struct {
Default TransformationType `json:"default,omitempty"`
Landscape TransformationType `json:"landscape,omitempty"`
Portrait TransformationType `json:"portrait,omitempty"`
Square TransformationType `json:"square,omitempty"`
// Transformation Identifies this type of transformation, `IfOrientation` in this case.
Transformation IfOrientationTransformation `json:"transformation"`
}
IfOrientation ...
func (*IfOrientation) UnmarshalJSON ¶
func (i *IfOrientation) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to Transformation interface
func (IfOrientation) Validate ¶
func (i IfOrientation) Validate() error
Validate validates IfOrientation
type IfOrientationPost ¶
type IfOrientationPost struct {
Default TransformationTypePost `json:"default,omitempty"`
Landscape TransformationTypePost `json:"landscape,omitempty"`
Portrait TransformationTypePost `json:"portrait,omitempty"`
Square TransformationTypePost `json:"square,omitempty"`
// Transformation Identifies this type of transformation, `IfOrientation` in this case.
Transformation IfOrientationPostTransformation `json:"transformation"`
}
IfOrientationPost ...
func (*IfOrientationPost) UnmarshalJSON ¶
func (i *IfOrientationPost) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to PostBreakpointTransformation interface
func (IfOrientationPost) Validate ¶
func (i IfOrientationPost) Validate() error
Validate validates IfOrientationPost
type IfOrientationPostTransformation ¶
type IfOrientationPostTransformation string
IfOrientationPostTransformation ...
func IfOrientationPostTransformationPtr ¶
func IfOrientationPostTransformationPtr(v IfOrientationPostTransformation) *IfOrientationPostTransformation
IfOrientationPostTransformationPtr returns pointer of IfOrientationPostTransformation
type IfOrientationTransformation ¶
type IfOrientationTransformation string
IfOrientationTransformation ...
func IfOrientationTransformationPtr ¶
func IfOrientationTransformationPtr(v IfOrientationTransformation) *IfOrientationTransformation
IfOrientationTransformationPtr returns pointer of IfOrientationTransformation
type ImQuery ¶
type ImQuery struct {
// AllowedTransformations Specifies the transformations that can be applied using the query string parameter.
AllowedTransformations []ImQueryAllowedTransformations `json:"allowedTransformations"`
Query *QueryVariableInline `json:"query"`
// Transformation Identifies this type of transformation, `ImQuery` in this case.
Transformation ImQueryTransformation `json:"transformation"`
}
ImQuery Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appendedto the image URL.
type ImQueryAllowedTransformations ¶
type ImQueryAllowedTransformations string
ImQueryAllowedTransformations ...
func ImQueryAllowedTransformationsPtr ¶
func ImQueryAllowedTransformationsPtr(v ImQueryAllowedTransformations) *ImQueryAllowedTransformations
ImQueryAllowedTransformationsPtr returns pointer of ImQueryAllowedTransformations
type ImQueryTransformation ¶
type ImQueryTransformation string
ImQueryTransformation ...
func ImQueryTransformationPtr ¶
func ImQueryTransformationPtr(v ImQueryTransformation) *ImQueryTransformation
ImQueryTransformationPtr returns pointer of ImQueryTransformation
type ImageType ¶
type ImageType interface {
// contains filtered or unexported methods
}
ImageType is implemented by ImageType types
type ImageTypePost ¶
type ImageTypePost interface {
// contains filtered or unexported methods
}
ImageTypePost is implemented by ImageTypePost types
type Imaging ¶
type Imaging interface {
// ListPolicies lists all Policies for the given network and an account
// See: https://techdocs.akamai.com/ivm/reference/get-policies
ListPolicies(context.Context, ListPoliciesRequest) (*ListPoliciesResponse, error)
// GetPolicy gets specific policy by PolicyID
GetPolicy(context.Context, GetPolicyRequest) (PolicyOutput, error)
// UpsertPolicy creates or updates the configuration for a policy
UpsertPolicy(context.Context, UpsertPolicyRequest) (*PolicyResponse, error)
// DeletePolicy deletes a policy
DeletePolicy(context.Context, DeletePolicyRequest) (*PolicyResponse, error)
// GetPolicyHistory retrieves history of changes for a policy
GetPolicyHistory(context.Context, GetPolicyHistoryRequest) (*GetPolicyHistoryResponse, error)
// RollbackPolicy reverts a policy to its previous version and deploys it to the network
RollbackPolicy(ctx context.Context, request RollbackPolicyRequest) (*PolicyResponse, error)
// ListPolicySets lists all PolicySets of specified type for the current account
ListPolicySets(context.Context, ListPolicySetsRequest) ([]PolicySet, error)
// GetPolicySet gets specific PolicySet by PolicySetID
GetPolicySet(context.Context, GetPolicySetRequest) (*PolicySet, error)
// CreatePolicySet creates configuration for an PolicySet
CreatePolicySet(context.Context, CreatePolicySetRequest) (*PolicySet, error)
// UpdatePolicySet creates configuration for an PolicySet
UpdatePolicySet(context.Context, UpdatePolicySetRequest) (*PolicySet, error)
// DeletePolicySet deletes configuration for an PolicySet
DeletePolicySet(context.Context, DeletePolicySetRequest) error
}
Imaging is the api interface for Image and Video Manager
type InlineVariable ¶
type InlineVariable struct {
Var string `json:"var"`
}
InlineVariable represents an inline variable
type IntegerVariableInline ¶
IntegerVariableInline represents a type which stores either a value or a variable name
func (*IntegerVariableInline) MarshalJSON ¶
func (i *IntegerVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*IntegerVariableInline) UnmarshalJSON ¶
func (i *IntegerVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (IntegerVariableInline) Validate ¶
func (i IntegerVariableInline) Validate() error
Validate validates IntegerVariableInline
type ListPoliciesRequest ¶
type ListPoliciesRequest struct {
Network PolicyNetwork
ContractID string
PolicySetID string
}
ListPoliciesRequest describes the parameters of the ListPolicies request
func (ListPoliciesRequest) Validate ¶
func (v ListPoliciesRequest) Validate() error
Validate validates ListPoliciesRequest
type ListPoliciesResponse ¶
type ListPoliciesResponse struct {
ItemKind string `json:"itemKind"`
Items PolicyOutputs `json:"items"`
TotalItems int `json:"totalItems"`
}
ListPoliciesResponse is a response returned by ListPolicies operations
type ListPolicySetsRequest ¶
ListPolicySetsRequest describes the parameters of the ListPolicySets request
func (ListPolicySetsRequest) Validate ¶
func (v ListPolicySetsRequest) Validate() error
Validate validates ListPolicySetsRequest
type MaxColors ¶
type MaxColors struct {
// Colors The value representing the maximum number of colors to use with the source image.
Colors *IntegerVariableInline `json:"colors"`
// Transformation Identifies this type of transformation, `MaxColors` in this case.
Transformation MaxColorsTransformation `json:"transformation"`
}
MaxColors Set the maximum number of colors in the images palette. Reducing the number of colors in an image can help to reduce file size.
type MaxColorsTransformation ¶
type MaxColorsTransformation string
MaxColorsTransformation ...
func MaxColorsTransformationPtr ¶
func MaxColorsTransformationPtr(v MaxColorsTransformation) *MaxColorsTransformation
MaxColorsTransformationPtr returns pointer of MaxColorsTransformation
type Mirror ¶
type Mirror struct {
// Horizontal Flips the image horizontally.
Horizontal *BooleanVariableInline `json:"horizontal,omitempty"`
// Transformation Identifies this type of transformation, `Mirror` in this case.
Transformation MirrorTransformation `json:"transformation"`
// Vertical Flips the image vertically.
Vertical *BooleanVariableInline `json:"vertical,omitempty"`
}
Mirror Flips an image horizontally, vertically, or both.
type MirrorTransformation ¶
type MirrorTransformation string
MirrorTransformation ...
func MirrorTransformationPtr ¶
func MirrorTransformationPtr(v MirrorTransformation) *MirrorTransformation
MirrorTransformationPtr returns pointer of MirrorTransformation
type Mock ¶
func (*Mock) CreatePolicySet ¶
func (*Mock) DeletePolicy ¶
func (m *Mock) DeletePolicy(ctx context.Context, req DeletePolicyRequest) (*PolicyResponse, error)
func (*Mock) DeletePolicySet ¶
func (m *Mock) DeletePolicySet(ctx context.Context, req DeletePolicySetRequest) error
func (*Mock) GetPolicy ¶
func (m *Mock) GetPolicy(ctx context.Context, req GetPolicyRequest) (PolicyOutput, error)
func (*Mock) GetPolicyHistory ¶
func (m *Mock) GetPolicyHistory(ctx context.Context, req GetPolicyHistoryRequest) (*GetPolicyHistoryResponse, error)
func (*Mock) GetPolicySet ¶
func (*Mock) ListPolicies ¶
func (m *Mock) ListPolicies(ctx context.Context, req ListPoliciesRequest) (*ListPoliciesResponse, error)
func (*Mock) ListPolicySets ¶
func (*Mock) RollbackPolicy ¶
func (m *Mock) RollbackPolicy(ctx context.Context, req RollbackPolicyRequest) (*PolicyResponse, error)
func (*Mock) UpdatePolicySet ¶
func (*Mock) UpsertPolicy ¶
func (m *Mock) UpsertPolicy(ctx context.Context, req UpsertPolicyRequest) (*PolicyResponse, error)
type MonoHue ¶
type MonoHue struct {
// Hue Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.
Hue *NumberVariableInline `json:"hue,omitempty"`
// Transformation Identifies this type of transformation, `MonoHue` in this case.
Transformation MonoHueTransformation `json:"transformation"`
}
MonoHue Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color’s lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.
type MonoHueTransformation ¶
type MonoHueTransformation string
MonoHueTransformation ...
func MonoHueTransformationPtr ¶
func MonoHueTransformationPtr(v MonoHueTransformation) *MonoHueTransformation
MonoHueTransformationPtr returns pointer of MonoHueTransformation
type NumberVariableInline ¶
NumberVariableInline represents a type which stores either a value or a variable name
func (*NumberVariableInline) MarshalJSON ¶
func (n *NumberVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*NumberVariableInline) UnmarshalJSON ¶
func (n *NumberVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (NumberVariableInline) Validate ¶
func (n NumberVariableInline) Validate() error
Validate validates NumberVariableInline
type Opacity ¶
type Opacity struct {
// Opacity Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.
Opacity *NumberVariableInline `json:"opacity"`
// Transformation Identifies this type of transformation, `Opacity` in this case.
Transformation OpacityTransformation `json:"transformation"`
}
Opacity Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.
type OpacityTransformation ¶
type OpacityTransformation string
OpacityTransformation ...
func OpacityTransformationPtr ¶
func OpacityTransformationPtr(v OpacityTransformation) *OpacityTransformation
OpacityTransformationPtr returns pointer of OpacityTransformation
type OutputImage ¶
type OutputImage struct {
// AdaptiveQuality Override the quality of image to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with faster connections.
AdaptiveQuality *int `json:"adaptiveQuality,omitempty"`
// AllowPristineOnDownsize Whether a pristine image wider than the requested breakpoint is allowed as a derivative image if it has the fewest bytes. This will not have an affect if transformations are present.
AllowPristineOnDownsize *bool `json:"allowPristineOnDownsize,omitempty"`
// AllowedFormats The graphics file formats allowed for browser specific results.
AllowedFormats []OutputImageAllowedFormats `json:"allowedFormats,omitempty"`
// ForcedFormats The forced extra formats for the `imFormat` query parameter, which requests a specific browser type. By default, Image and Video Manager detects the browser and returns the appropriate image.
ForcedFormats []OutputImageForcedFormats `json:"forcedFormats,omitempty"`
// PerceptualQuality Mutually exclusive with quality. The perceptual quality to use when comparing resulting images, which overrides the `quality` setting. Perceptual quality tunes each image format's quality parameter dynamically based on the human-perceived quality of the output image. This can result in better byte savings (as compared to using regular quality) as many images can be encoded at a much lower quality without compromising perception of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Values are tiered `high`, `mediumHigh`, `medium`, `mediumLow`, or `low`.
PerceptualQuality *OutputImagePerceptualQualityVariableInline `json:"perceptualQuality,omitempty"`
// PerceptualQualityFloor Only applies with perceptualQuality set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality will not reduce the quality below this value even if it determines the compressed image to be acceptably visually similar.
PerceptualQualityFloor *int `json:"perceptualQualityFloor,omitempty"`
// PreferModernFormats Whether derivative image formats should be selected with a preference for modern formats (such as WebP and Avif) instead the format that results in the fewest bytes.
PreferModernFormats *bool `json:"preferModernFormats,omitempty"`
// Quality Mutually exclusive with perceptualQuality, used by default if neither is specified. The chosen quality of the output images. Using a quality value from 1-100 resembles JPEG quality across output formats.
Quality *IntegerVariableInline `json:"quality,omitempty"`
}
OutputImage Dictates the output quality (either `quality` or `perceptualQuality`) and formats that are created for each resized image. If unspecified, image formats are created to support all browsers at the default quality level (`85`), which includes formats such as WEBP, JPEG2000 and JPEG-XR for specific browsers.
type OutputImageAllowedFormats ¶
type OutputImageAllowedFormats string
OutputImageAllowedFormats ...
func OutputImageAllowedFormatsPtr ¶
func OutputImageAllowedFormatsPtr(v OutputImageAllowedFormats) *OutputImageAllowedFormats
OutputImageAllowedFormatsPtr returns pointer of OutputImageAllowedFormats
type OutputImageForcedFormats ¶
type OutputImageForcedFormats string
OutputImageForcedFormats ...
func OutputImageForcedFormatsPtr ¶
func OutputImageForcedFormatsPtr(v OutputImageForcedFormats) *OutputImageForcedFormats
OutputImageForcedFormatsPtr returns pointer of OutputImageForcedFormats
type OutputImagePerceptualQuality ¶
type OutputImagePerceptualQuality string
OutputImagePerceptualQuality ...
func OutputImagePerceptualQualityPtr ¶
func OutputImagePerceptualQualityPtr(v OutputImagePerceptualQuality) *OutputImagePerceptualQuality
OutputImagePerceptualQualityPtr returns pointer of OutputImagePerceptualQuality
type OutputImagePerceptualQualityVariableInline ¶
type OutputImagePerceptualQualityVariableInline struct {
Name *string
Value *OutputImagePerceptualQuality
}
OutputImagePerceptualQualityVariableInline represents a type which stores either a value or a variable name
func (*OutputImagePerceptualQualityVariableInline) MarshalJSON ¶
func (o *OutputImagePerceptualQualityVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*OutputImagePerceptualQualityVariableInline) UnmarshalJSON ¶
func (o *OutputImagePerceptualQualityVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (OutputImagePerceptualQualityVariableInline) Validate ¶
func (o OutputImagePerceptualQualityVariableInline) Validate() error
Validate validates OutputImagePerceptualQualityVariableInline
type OutputVideo ¶
type OutputVideo struct {
// PerceptualQuality The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.
PerceptualQuality *OutputVideoPerceptualQualityVariableInline `json:"perceptualQuality,omitempty"`
// PlaceholderVideoURL Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.
PlaceholderVideoURL *StringVariableInline `json:"placeholderVideoUrl,omitempty"`
// VideoAdaptiveQuality Override the quality of video to serve when Image & Video Manager detects a slow connection. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.
VideoAdaptiveQuality *OutputVideoVideoAdaptiveQualityVariableInline `json:"videoAdaptiveQuality,omitempty"`
}
OutputVideo Dictates the output quality that are created for each resized video.
type OutputVideoPerceptualQuality ¶
type OutputVideoPerceptualQuality string
OutputVideoPerceptualQuality ...
func OutputVideoPerceptualQualityPtr ¶
func OutputVideoPerceptualQualityPtr(v OutputVideoPerceptualQuality) *OutputVideoPerceptualQuality
OutputVideoPerceptualQualityPtr returns pointer of OutputVideoPerceptualQuality
type OutputVideoPerceptualQualityVariableInline ¶
type OutputVideoPerceptualQualityVariableInline struct {
Name *string
Value *OutputVideoPerceptualQuality
}
OutputVideoPerceptualQualityVariableInline represents a type which stores either a value or a variable name
func (*OutputVideoPerceptualQualityVariableInline) MarshalJSON ¶
func (o *OutputVideoPerceptualQualityVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*OutputVideoPerceptualQualityVariableInline) UnmarshalJSON ¶
func (o *OutputVideoPerceptualQualityVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (OutputVideoPerceptualQualityVariableInline) Validate ¶
func (o OutputVideoPerceptualQualityVariableInline) Validate() error
Validate validates OutputVideoPerceptualQualityVariableInline
type OutputVideoVideoAdaptiveQuality ¶
type OutputVideoVideoAdaptiveQuality string
OutputVideoVideoAdaptiveQuality ...
func OutputVideoVideoAdaptiveQualityPtr ¶
func OutputVideoVideoAdaptiveQualityPtr(v OutputVideoVideoAdaptiveQuality) *OutputVideoVideoAdaptiveQuality
OutputVideoVideoAdaptiveQualityPtr returns pointer of OutputVideoVideoAdaptiveQuality
type OutputVideoVideoAdaptiveQualityVariableInline ¶
type OutputVideoVideoAdaptiveQualityVariableInline struct {
Name *string
Value *OutputVideoVideoAdaptiveQuality
}
OutputVideoVideoAdaptiveQualityVariableInline represents a type which stores either a value or a variable name
func (*OutputVideoVideoAdaptiveQualityVariableInline) MarshalJSON ¶
func (o *OutputVideoVideoAdaptiveQualityVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*OutputVideoVideoAdaptiveQualityVariableInline) UnmarshalJSON ¶
func (o *OutputVideoVideoAdaptiveQualityVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (OutputVideoVideoAdaptiveQualityVariableInline) Validate ¶
func (o OutputVideoVideoAdaptiveQualityVariableInline) Validate() error
Validate validates OutputVideoVideoAdaptiveQualityVariableInline
type PointShapeType ¶
type PointShapeType struct {
// X The horizontal position of the point, measured in pixels.
X *NumberVariableInline `json:"x"`
// Y The vertical position of the point, measured in pixels.
Y *NumberVariableInline `json:"y"`
}
PointShapeType Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x`and `y` members, or a two-element array.
func (PointShapeType) Validate ¶
func (p PointShapeType) Validate() error
Validate validates PointShapeType
type PolicyHistoryItem ¶
type PolicyHistoryItem struct {
ID string `json:"id"`
DateCreated string `json:"dateCreated"`
Policy string `json:"policy"`
Action string `json:"action"`
User string `json:"user"`
Version int `json:"version"`
}
PolicyHistoryItem describes items of the history for policy
type PolicyInput ¶
type PolicyInput interface {
// contains filtered or unexported methods
}
PolicyInput is implemented by PolicyInput types (image and video)
type PolicyInputImage ¶
type PolicyInputImage struct {
// Breakpoints The breakpoint widths (in pixels) to use to create derivative images/videos
Breakpoints *Breakpoints `json:"breakpoints,omitempty"`
// Hosts Hosts that are allowed for image/video URLs within transformations or variables
Hosts []string `json:"hosts,omitempty"`
// Output Dictates the output quality (either `quality` or `perceptualQuality`) and formats that are created for each resized image If unspecified, image formats are created to support all browsers at the default quality level (`85`), which includes formats such as WEBP, JPEG2000 and JPEG-XR for specific browsers
Output *OutputImage `json:"output,omitempty"`
// PostBreakpointTransformations Post-processing Transformations are applied to the image after image and quality settings have been applied
PostBreakpointTransformations PostBreakpointTransformations `json:"postBreakpointTransformations,omitempty"`
// RolloutDuration The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version
RolloutDuration *int `json:"rolloutDuration,omitempty"`
// ServeStaleDuration The amount of time in seconds that the policy will serve stale images. During the serve stale period realtime images will attempt to use the offline image from the previous policy version first if possible.
ServeStaleDuration *int `json:"serveStaleDuration,omitempty"`
// Transformations Set of image transformations to apply to the source image. If unspecified, no operations are performed
Transformations Transformations `json:"transformations,omitempty"`
// Variables Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a [Variable](#variable) object, so that you don't have to specify values separately You can also pass in these variable names and values dynamically as query parameters in the image's request URL
Variables []Variable `json:"variables,omitempty"`
}
PolicyInputImage Specifies details for each policy, such as transformations to apply and variations in image size and formats
func (*PolicyInputImage) Validate ¶
func (p *PolicyInputImage) Validate() error
Validate validates PolicyInputImage
type PolicyInputVideo ¶
type PolicyInputVideo struct {
// Breakpoints The breakpoint widths (in pixels) to use to create derivative images/videos
Breakpoints *Breakpoints `json:"breakpoints,omitempty"`
// Hosts Hosts that are allowed for image/video URLs within transformations or variables
Hosts []string `json:"hosts,omitempty"`
// Output Dictates the output quality that are created for each resized video
Output *OutputVideo `json:"output,omitempty"`
// RolloutDuration The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version
RolloutDuration *int `json:"rolloutDuration,omitempty"`
// Variables Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a [Variable](#variable) object, so that you don't have to specify values separately You can also pass in these variable names and values dynamically as query parameters in the image's request URL
Variables []Variable `json:"variables,omitempty"`
}
PolicyInputVideo Specifies details for each policy such as video size
func (*PolicyInputVideo) Validate ¶
func (p *PolicyInputVideo) Validate() error
Validate validates PolicyInputVideo
type PolicyNetwork ¶
type PolicyNetwork string
PolicyNetwork represents the network where policy set is stored
const ( // PolicyNetworkStaging represents staging network PolicyNetworkStaging PolicyNetwork = "staging" // PolicyNetworkProduction represents production network PolicyNetworkProduction PolicyNetwork = "production" )
type PolicyOutput ¶
type PolicyOutput interface {
// contains filtered or unexported methods
}
PolicyOutput is implemented by PolicyOutput types (image and video)
type PolicyOutputImage ¶
type PolicyOutputImage struct {
// Breakpoints The breakpoint widths (in pixels) to use to create derivative images/videos.
Breakpoints *Breakpoints `json:"breakpoints,omitempty"`
// DateCreated Date this policy version was created in ISO 8601 extended notation format.
DateCreated string `json:"dateCreated"`
// Hosts Hosts that are allowed for image/video URLs within transformations or variables.
Hosts []string `json:"hosts,omitempty"`
// ID Unique identifier for a policy, up to 64 alphanumeric characters including underscores or dashes.
ID string `json:"id"`
// Output Dictates the output quality (either `quality` or `perceptualQuality`) and formats that are created for each resized image. If unspecified, image formats are created to support all browsers at the default quality level (`85`), which includes formats such as WEBP, JPEG2000 and JPEG-XR for specific browsers.
Output *OutputImage `json:"output,omitempty"`
// PostBreakpointTransformations Post-processing Transformations are applied to the image after image and quality settings have been applied.
PostBreakpointTransformations PostBreakpointTransformations `json:"postBreakpointTransformations,omitempty"`
// PreviousVersion The previous version number of this policy version
PreviousVersion int `json:"previousVersion"`
// RolloutInfo Contains information about policy rollout start and completion times.
RolloutInfo *RolloutInfo `json:"rolloutInfo"`
// Transformations Set of image transformations to apply to the source image. If unspecified, no operations are performed.
Transformations Transformations `json:"transformations,omitempty"`
// User The user who created this policy version
User string `json:"user"`
// Variables Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a [Variable](#variable) object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.
Variables []Variable `json:"variables,omitempty"`
// Version The version number of this policy version
Version int `json:"version"`
// Video Identifies this as an image policy.
Video *bool `json:"video,omitempty"`
}
PolicyOutputImage Specifies details for each policy, such as transformations to apply and variations in image size and formats.
func (PolicyOutputImage) Validate ¶
func (p PolicyOutputImage) Validate() error
Validate validates PolicyOutputImage
type PolicyOutputVideo ¶
type PolicyOutputVideo struct {
// Breakpoints The breakpoint widths (in pixels) to use to create derivative images/videos.
Breakpoints *Breakpoints `json:"breakpoints,omitempty"`
// DateCreated Date this policy version was created in ISO 8601 extended notation format.
DateCreated string `json:"dateCreated"`
// Hosts Hosts that are allowed for image/video URLs within transformations or variables.
Hosts []string `json:"hosts,omitempty"`
// ID Unique identifier for a policy, up to 64 alphanumeric characters including underscores or dashes.
ID string `json:"id"`
// Output Dictates the output quality that are created for each resized video.
Output *OutputVideo `json:"output,omitempty"`
// PreviousVersion The previous version number of this policy version
PreviousVersion int `json:"previousVersion"`
// RolloutInfo Contains information about policy rollout start and completion times.
RolloutInfo *RolloutInfo `json:"rolloutInfo"`
// User The user who created this policy version
User string `json:"user"`
// Variables Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as a [Variable](#variable) object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.
Variables []Variable `json:"variables,omitempty"`
// Version The version number of this policy version
Version int `json:"version"`
// Video Identifies this as a video policy.
Video *bool `json:"video,omitempty"`
}
PolicyOutputVideo Specifies details for each policy such as video size.
func (PolicyOutputVideo) Validate ¶
func (p PolicyOutputVideo) Validate() error
Validate validates PolicyOutputVideo
type PolicyOutputs ¶
type PolicyOutputs []PolicyOutput
PolicyOutputs is an array of PolicyOutput types (image and video)
func (*PolicyOutputs) UnmarshalJSON ¶
func (po *PolicyOutputs) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a slice of PolicyOutput interfaces
type PolicyResponse ¶
type PolicyResponse struct {
Description string `json:"description"`
ID string `json:"id"`
OperationPerformed string `json:"operationPerformed"`
}
PolicyResponse describes response of the UpsertPolicy, DeletePolicy and RollbackPolicy responses
type PolicySet ¶
type PolicySet struct {
ID string `json:"id"`
Name string `json:"name"`
Region Region `json:"region"`
Type string `json:"type"`
User string `json:"user"`
Properties []string `json:"properties"`
LastModified string `json:"lastModified"`
}
PolicySet is a response returned by CRU operations
type PolygonShapeType ¶
type PolygonShapeType struct {
// Points Series of [PointShapeType](#pointshapetype) objects. The last and first points connect to close the shape automatically.
Points []PointShapeType `json:"points"`
}
PolygonShapeType Defines a polygon from a series of connected points.
func (PolygonShapeType) Validate ¶
func (p PolygonShapeType) Validate() error
Validate validates PolygonShapeType
type PostBreakpointTransformations ¶
type PostBreakpointTransformations []TransformationTypePost
PostBreakpointTransformations represents an array of PostBreakPointTransformations
func (*PostBreakpointTransformations) UnmarshalJSON ¶
func (t *PostBreakpointTransformations) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a slice of PostBreakpointTransformation interfaces
type QueryVariableInline ¶
type QueryVariableInline struct {
Name *string
}
QueryVariableInline represents a type which stores either a value or a variable name
func (*QueryVariableInline) MarshalJSON ¶
func (q *QueryVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*QueryVariableInline) UnmarshalJSON ¶
func (q *QueryVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (QueryVariableInline) Validate ¶
func (q QueryVariableInline) Validate() error
Validate validates QueryVariableInline
type RectangleShapeType ¶
type RectangleShapeType struct {
Anchor *PointShapeType `json:"anchor"`
// Height Extends the rectangle down from the `anchor` point.
Height *NumberVariableInline `json:"height"`
// Width Extends the rectangle right from the `anchor` point.
Width *NumberVariableInline `json:"width"`
}
RectangleShapeType Defines a rectangle's `width` and `height` relative to an `anchor` point at the top left corner.
func (RectangleShapeType) Validate ¶
func (r RectangleShapeType) Validate() error
Validate validates RectangleShapeType
type Region ¶
type Region string
Region represents the geographic region which media using this Policy Set is optimized for
const ( // RegionUS represents US region RegionUS Region = "US" // RegionEMEA represents EMEA region RegionEMEA Region = "EMEA" // RegionAsia represents Asia region RegionAsia Region = "ASIA" // RegionAustralia represents Australia region RegionAustralia Region = "AUSTRALIA" // RegionJapan represents Japan region RegionJapan Region = "JAPAN" // RegionChina represents China region RegionChina Region = "CHINA" )
type RegionOfInterestCrop ¶
type RegionOfInterestCrop struct {
// Gravity The placement of the crop area relative to the specified area of interest.
Gravity *GravityVariableInline `json:"gravity,omitempty"`
// Height The height in pixels of the output image relative to the specified `style` value.
Height *IntegerVariableInline `json:"height"`
RegionOfInterest ShapeType `json:"regionOfInterest"`
// Style Specifies how to crop or scale a crop area for the specified area of interest in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places raw crop around the point of interest, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and point of interest as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the point of interest, relative to the specified `width` and `height` values.
Style *RegionOfInterestCropStyleVariableInline `json:"style,omitempty"`
// Transformation Identifies this type of transformation, `RegionOfInterestCrop` in this case.
Transformation RegionOfInterestCropTransformation `json:"transformation"`
// Width The width in pixels of the output image relative to the specified `style` value.
Width *IntegerVariableInline `json:"width"`
}
RegionOfInterestCrop Crops to a region around a specified area of interest relative to the specified `width` and `height` values.
func (*RegionOfInterestCrop) UnmarshalJSON ¶
func (r *RegionOfInterestCrop) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to ShapeType interface
func (RegionOfInterestCrop) Validate ¶
func (r RegionOfInterestCrop) Validate() error
Validate validates RegionOfInterestCrop
type RegionOfInterestCropStyle ¶
type RegionOfInterestCropStyle string
RegionOfInterestCropStyle ...
func RegionOfInterestCropStylePtr ¶
func RegionOfInterestCropStylePtr(v RegionOfInterestCropStyle) *RegionOfInterestCropStyle
RegionOfInterestCropStylePtr returns pointer of RegionOfInterestCropStyle
type RegionOfInterestCropStyleVariableInline ¶
type RegionOfInterestCropStyleVariableInline struct {
Name *string
Value *RegionOfInterestCropStyle
}
RegionOfInterestCropStyleVariableInline represents a type which stores either a value or a variable name
func (*RegionOfInterestCropStyleVariableInline) MarshalJSON ¶
func (r *RegionOfInterestCropStyleVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*RegionOfInterestCropStyleVariableInline) UnmarshalJSON ¶
func (r *RegionOfInterestCropStyleVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (RegionOfInterestCropStyleVariableInline) Validate ¶
func (r RegionOfInterestCropStyleVariableInline) Validate() error
Validate validates RegionOfInterestCropStyleVariableInline
type RegionOfInterestCropTransformation ¶
type RegionOfInterestCropTransformation string
RegionOfInterestCropTransformation ...
func RegionOfInterestCropTransformationPtr ¶
func RegionOfInterestCropTransformationPtr(v RegionOfInterestCropTransformation) *RegionOfInterestCropTransformation
RegionOfInterestCropTransformationPtr returns pointer of RegionOfInterestCropTransformation
type RelativeCrop ¶
type RelativeCrop struct {
// East The number of pixels to shrink or expand the right side of the image.
East *IntegerVariableInline `json:"east,omitempty"`
// North The number of pixels to shrink or expand the top side of the image.
North *IntegerVariableInline `json:"north,omitempty"`
// South The number of pixels to shrink or expand the bottom side of the image.
South *IntegerVariableInline `json:"south,omitempty"`
// Transformation Identifies this type of transformation, `RelativeCrop` in this case.
Transformation RelativeCropTransformation `json:"transformation"`
// West The number of pixels to shrink or expand the left side of the image.
West *IntegerVariableInline `json:"west,omitempty"`
}
RelativeCrop Shrinks or expands an image relative to the image's specified dimensions. Image and Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.
func (RelativeCrop) Validate ¶
func (r RelativeCrop) Validate() error
Validate validates RelativeCrop
type RelativeCropTransformation ¶
type RelativeCropTransformation string
RelativeCropTransformation ...
func RelativeCropTransformationPtr ¶
func RelativeCropTransformationPtr(v RelativeCropTransformation) *RelativeCropTransformation
RelativeCropTransformationPtr returns pointer of RelativeCropTransformation
type RemoveColor ¶
type RemoveColor struct {
// Color The hexadecimal CSS color value to remove.
Color *StringVariableInline `json:"color"`
// Feather The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent - creating a softer edge. The first realtime request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.
Feather *NumberVariableInline `json:"feather,omitempty"`
// Tolerance The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.
Tolerance *NumberVariableInline `json:"tolerance,omitempty"`
// Transformation Identifies this type of transformation, `RemoveColor` in this case.
Transformation RemoveColorTransformation `json:"transformation"`
}
RemoveColor Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.
type RemoveColorTransformation ¶
type RemoveColorTransformation string
RemoveColorTransformation ...
func RemoveColorTransformationPtr ¶
func RemoveColorTransformationPtr(v RemoveColorTransformation) *RemoveColorTransformation
RemoveColorTransformationPtr returns pointer of RemoveColorTransformation
type Resize ¶
type Resize struct {
// Aspect Preserves the aspect ratio. Select `fit` to make the image fit entirely within the selected width and height. When using `fit`, the resulting image has the largest possible size for the specified dimensions. Select `fill` to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwise `ignore` changes the original aspect ratio to fit within an arbitrarily shaped rectangle.
Aspect *ResizeAspectVariableInline `json:"aspect,omitempty"`
// Height The height to resize the source image to. Must be set if height is not specified.
Height *IntegerVariableInline `json:"height,omitempty"`
// Transformation Identifies this type of transformation, `Resize` in this case.
Transformation ResizeTransformation `json:"transformation"`
// Type Sets constraints for the image resize. Select `normal` to resize in all cases, either increasing or decreasing the dimensions. Select `downsize` to ignore this transformation if the result would be larger than the original. Select `upsize` to ignore this transformation if the result would be smaller.
Type *ResizeTypeVariableInline `json:"type,omitempty"`
// Width The width to resize the source image to. Must be set if width is not specified.
Width *IntegerVariableInline `json:"width,omitempty"`
}
Resize Resizes an image to a particular, absolute dimension. If you don't enter a `width` or a `height`, the image is resized with the `fit` aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect.
type ResizeAspect ¶
type ResizeAspect string
ResizeAspect ...
func ResizeAspectPtr ¶
func ResizeAspectPtr(v ResizeAspect) *ResizeAspect
ResizeAspectPtr returns pointer of ResizeAspect
type ResizeAspectVariableInline ¶
type ResizeAspectVariableInline struct {
Name *string
Value *ResizeAspect
}
ResizeAspectVariableInline represents a type which stores either a value or a variable name
func (*ResizeAspectVariableInline) MarshalJSON ¶
func (r *ResizeAspectVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*ResizeAspectVariableInline) UnmarshalJSON ¶
func (r *ResizeAspectVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (ResizeAspectVariableInline) Validate ¶
func (r ResizeAspectVariableInline) Validate() error
Validate validates ResizeAspectVariableInline
type ResizeTransformation ¶
type ResizeTransformation string
ResizeTransformation ...
func ResizeTransformationPtr ¶
func ResizeTransformationPtr(v ResizeTransformation) *ResizeTransformation
ResizeTransformationPtr returns pointer of ResizeTransformation
type ResizeType ¶
type ResizeType string
ResizeType ...
func ResizeTypePtr ¶
func ResizeTypePtr(v ResizeType) *ResizeType
ResizeTypePtr returns pointer of ResizeType
type ResizeTypeVariableInline ¶
type ResizeTypeVariableInline struct {
Name *string
Value *ResizeType
}
ResizeTypeVariableInline represents a type which stores either a value or a variable name
func (*ResizeTypeVariableInline) MarshalJSON ¶
func (r *ResizeTypeVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*ResizeTypeVariableInline) UnmarshalJSON ¶
func (r *ResizeTypeVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (ResizeTypeVariableInline) Validate ¶
func (r ResizeTypeVariableInline) Validate() error
Validate validates ResizeTypeVariableInline
type RollbackPolicyRequest ¶
type RollbackPolicyRequest policyRequest
RollbackPolicyRequest describes the parameters of the RollbackPolicy request
func (RollbackPolicyRequest) Validate ¶
func (v RollbackPolicyRequest) Validate() error
Validate validates RollbackPolicyRequest
type RolloutInfo ¶
type RolloutInfo struct {
// EndTime The estimated time that rollout for this policy will end. Value is a unix timestamp.
EndTime int `json:"endTime"`
// RolloutDuration The amount of time in seconds that the policy takes to rollout. During the rollout an increasing proportion of images/videos will begin to use the new policy instead of the cached images/videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.
RolloutDuration int `json:"rolloutDuration"`
// ServeStaleEndTime The estimated time that serving stale for this policy will end. Value is a unix timestamp.
ServeStaleEndTime *int `json:"serveStaleEndTime,omitempty"`
// StartTime The estimated time that rollout for this policy will begin. Value is a unix timestamp.
StartTime int `json:"startTime"`
}
RolloutInfo Contains information about policy rollout start and completion times.
type Rotate ¶
type Rotate struct {
// Degrees The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.
Degrees *NumberVariableInline `json:"degrees"`
// Transformation Identifies this type of transformation, `Rotate` in this case.
Transformation RotateTransformation `json:"transformation"`
}
Rotate Rotate the image around its center by indicating the degrees of rotation.
type RotateTransformation ¶
type RotateTransformation string
RotateTransformation ...
func RotateTransformationPtr ¶
func RotateTransformationPtr(v RotateTransformation) *RotateTransformation
RotateTransformationPtr returns pointer of RotateTransformation
type Scale ¶
type Scale struct {
// Height Scaling factor for the input height to determine the output height of the image, where values between `0` and `1` decrease size. Image dimensions need to be non-zero positive numbers.
Height *NumberVariableInline `json:"height"`
// Transformation Identifies this type of transformation, `Scale` in this case.
Transformation ScaleTransformation `json:"transformation"`
// Width Scaling factor for the input width to determine the output width of the image, where `1` leaves the width unchanged. Values greater than `1` increase the image size. Image dimensions need to be non-zero positive numbers.
Width *NumberVariableInline `json:"width"`
}
Scale Changes the image's size to different dimensions relative to its starting size.
type ScaleTransformation ¶
type ScaleTransformation string
ScaleTransformation ...
func ScaleTransformationPtr ¶
func ScaleTransformationPtr(v ScaleTransformation) *ScaleTransformation
ScaleTransformationPtr returns pointer of ScaleTransformation
type ShapeType ¶
type ShapeType interface {
// contains filtered or unexported methods
}
ShapeType is implemented by ImageType types
type Shear ¶
type Shear struct {
// Transformation Identifies this type of transformation, `Shear` in this case.
Transformation ShearTransformation `json:"transformation"`
// XShear The amount to shear along the x-axis, measured in multiples of the image's width. Must be set if yShear is not specified.
XShear *NumberVariableInline `json:"xShear,omitempty"`
// YShear The amount to shear along the y-axis, measured in multiples of the image's height. Must be set if xShear is not specified.
YShear *NumberVariableInline `json:"yShear,omitempty"`
}
Shear Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a `BackgroundColor` transformation for these areas.
type ShearTransformation ¶
type ShearTransformation string
ShearTransformation ...
func ShearTransformationPtr ¶
func ShearTransformationPtr(v ShearTransformation) *ShearTransformation
ShearTransformationPtr returns pointer of ShearTransformation
type SmartCrop ¶
type SmartCrop struct {
// Debug When enabled, the SmartCrop transformation doesn't actually execute. Instead, it outlines found faces or features, the region of interest, and the crop area.
Debug *BooleanVariableInline `json:"debug,omitempty"`
// Height The height in pixels of the output image relative to the specified `style` value.
Height *IntegerVariableInline `json:"height,omitempty"`
// Sloppy Whether to sacrifice any image fidelity for transformation performance.
Sloppy *BooleanVariableInline `json:"sloppy,omitempty"`
// Style Specifies how to crop or scale a crop area for the specified area of interest in the source image, `fill` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places raw crop around the point of interest. A value of `fill` scales the crop area to include as much of the image and point of interest as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the point of interest, relative to the specified `width` and `height` values.
Style *SmartCropStyleVariableInline `json:"style,omitempty"`
// Transformation Identifies this type of transformation, `SmartCrop` in this case.
Transformation SmartCropTransformation `json:"transformation"`
// Width The width in pixels of the output image relative to the specified `style` value.
Width *IntegerVariableInline `json:"width,omitempty"`
}
SmartCrop Crops around whatever is most important in the image, to a region around a specified area of interest relative to the specified `width` and `height` values. The crop detects any faces present, otherwise features.
type SmartCropStyle ¶
type SmartCropStyle string
SmartCropStyle ...
func SmartCropStylePtr ¶
func SmartCropStylePtr(v SmartCropStyle) *SmartCropStyle
SmartCropStylePtr returns pointer of SmartCropStyle
type SmartCropStyleVariableInline ¶
type SmartCropStyleVariableInline struct {
Name *string
Value *SmartCropStyle
}
SmartCropStyleVariableInline represents a type which stores either a value or a variable name
func (*SmartCropStyleVariableInline) MarshalJSON ¶
func (s *SmartCropStyleVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*SmartCropStyleVariableInline) UnmarshalJSON ¶
func (s *SmartCropStyleVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (SmartCropStyleVariableInline) Validate ¶
func (s SmartCropStyleVariableInline) Validate() error
Validate validates SmartCropStyleVariableInline
type SmartCropTransformation ¶
type SmartCropTransformation string
SmartCropTransformation ...
func SmartCropTransformationPtr ¶
func SmartCropTransformationPtr(v SmartCropTransformation) *SmartCropTransformation
SmartCropTransformationPtr returns pointer of SmartCropTransformation
type StringVariableInline ¶
StringVariableInline represents a type which stores either a value or a variable name
func (*StringVariableInline) MarshalJSON ¶
func (s *StringVariableInline) MarshalJSON() ([]byte, error)
MarshalJSON is a custom marshaler used to encode a variable which can be either a value or a variable object
func (*StringVariableInline) UnmarshalJSON ¶
func (s *StringVariableInline) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a variable which can be either a value or a variable object
func (StringVariableInline) Validate ¶
func (s StringVariableInline) Validate() error
Validate validates StringVariableInline
type TextImageType ¶
type TextImageType struct {
// Fill The main fill color of the text.
Fill *StringVariableInline `json:"fill,omitempty"`
// Size The size in pixels to render the text.
Size *NumberVariableInline `json:"size,omitempty"`
// Stroke The color for the outline of the text.
Stroke *StringVariableInline `json:"stroke,omitempty"`
// StrokeSize The thickness in points for the outline of the text.
StrokeSize *NumberVariableInline `json:"strokeSize,omitempty"`
// Text The line of text to render.
Text *StringVariableInline `json:"text"`
Transformation TransformationType `json:"transformation,omitempty"`
// Type Identifies the type of image, `Text` in this case.
Type TextImageTypeType `json:"type"`
// Typeface The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
Typeface *StringVariableInline `json:"typeface,omitempty"`
}
TextImageType A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
func (*TextImageType) UnmarshalJSON ¶
func (t *TextImageType) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to Transformation interface
func (TextImageType) Validate ¶
func (t TextImageType) Validate() error
Validate validates TextImageType
type TextImageTypePost ¶
type TextImageTypePost struct {
// Fill The main fill color of the text.
Fill *StringVariableInline `json:"fill,omitempty"`
// Size The size in pixels to render the text.
Size *NumberVariableInline `json:"size,omitempty"`
// Stroke The color for the outline of the text.
Stroke *StringVariableInline `json:"stroke,omitempty"`
// StrokeSize The thickness in points for the outline of the text.
StrokeSize *NumberVariableInline `json:"strokeSize,omitempty"`
// Text The line of text to render.
Text *StringVariableInline `json:"text"`
Transformation TransformationTypePost `json:"transformation,omitempty"`
// Type Identifies the type of image, `Text` in this case.
Type TextImageTypePostType `json:"type"`
// Typeface The font family to apply to the text image. This may be a URL to a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.
Typeface *StringVariableInline `json:"typeface,omitempty"`
}
TextImageTypePost A snippet of text. Defines font family and size, fill color, and outline stroke width and color.
func (*TextImageTypePost) UnmarshalJSON ¶
func (t *TextImageTypePost) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to PostBreakpointTransformation interface
func (TextImageTypePost) Validate ¶
func (t TextImageTypePost) Validate() error
Validate validates TextImageTypePost
type TextImageTypePostType ¶
type TextImageTypePostType string
TextImageTypePostType ...
func TextImageTypePostTypePtr ¶
func TextImageTypePostTypePtr(v TextImageTypePostType) *TextImageTypePostType
TextImageTypePostTypePtr returns pointer of TextImageTypePostType
type TextImageTypeType ¶
type TextImageTypeType string
TextImageTypeType ...
func TextImageTypeTypePtr ¶
func TextImageTypeTypePtr(v TextImageTypeType) *TextImageTypeType
TextImageTypeTypePtr returns pointer of TextImageTypeType
type TransformationType ¶
type TransformationType interface {
// contains filtered or unexported methods
}
TransformationType is implemented by Transformation types
type TransformationTypePost ¶
type TransformationTypePost interface {
// contains filtered or unexported methods
}
TransformationTypePost is implemented by PostBreakpointTransformations types
type Transformations ¶
type Transformations []TransformationType
Transformations represents an array of Transformations
func (*Transformations) UnmarshalJSON ¶
func (t *Transformations) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a slice of Transformation interfaces
type Trim ¶
type Trim struct {
// Fuzz The fuzz tolerance of the trim, a value between `0` and `1` that determines the acceptable amount of background variation before trimming stops.
Fuzz *NumberVariableInline `json:"fuzz,omitempty"`
// Padding The amount of padding in pixels to add to the trimmed image.
Padding *IntegerVariableInline `json:"padding,omitempty"`
// Transformation Identifies this type of transformation, `Trim` in this case.
Transformation TrimTransformation `json:"transformation"`
}
Trim Automatically crops uniform backgrounds from the edges of an image.
type TrimTransformation ¶
type TrimTransformation string
TrimTransformation ...
func TrimTransformationPtr ¶
func TrimTransformationPtr(v TrimTransformation) *TrimTransformation
TrimTransformationPtr returns pointer of TrimTransformation
type URLImageType ¶
type URLImageType struct {
Transformation TransformationType `json:"transformation,omitempty"`
// Type Identifies the type of image, `URL` in this case.
Type URLImageTypeType `json:"type,omitempty"`
// URL The URL of the image.
URL *StringVariableInline `json:"url"`
}
URLImageType An image loaded from a URL.
func (*URLImageType) UnmarshalJSON ¶
func (u *URLImageType) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to Transformation interface
func (URLImageType) Validate ¶
func (u URLImageType) Validate() error
Validate validates URLImageType
type URLImageTypePost ¶
type URLImageTypePost struct {
Transformation TransformationTypePost `json:"transformation,omitempty"`
// Type Identifies the type of image, `URL` in this case.
Type URLImageTypePostType `json:"type,omitempty"`
// URL The URL of the image.
URL *StringVariableInline `json:"url"`
}
URLImageTypePost An image loaded from a URL.
func (*URLImageTypePost) UnmarshalJSON ¶
func (u *URLImageTypePost) UnmarshalJSON(in []byte) error
UnmarshalJSON is a custom unmarshaler used to decode a type containing a reference to PostBreakpointTransformation interface
func (URLImageTypePost) Validate ¶
func (u URLImageTypePost) Validate() error
Validate validates URLImageTypePost
type URLImageTypePostType ¶
type URLImageTypePostType string
URLImageTypePostType ...
func URLImageTypePostTypePtr ¶
func URLImageTypePostTypePtr(v URLImageTypePostType) *URLImageTypePostType
URLImageTypePostTypePtr returns pointer of URLImageTypePostType
type URLImageTypeType ¶
type URLImageTypeType string
URLImageTypeType ...
func URLImageTypeTypePtr ¶
func URLImageTypeTypePtr(v URLImageTypeType) *URLImageTypeType
URLImageTypeTypePtr returns pointer of URLImageTypeType
type UnionShapeType ¶
type UnionShapeType struct {
Shapes []ShapeType `json:"shapes"`
}
UnionShapeType Identifies a combined shape based on a set of other shapes. You can use a full JSON object to represent a union or an array of shapes that describe it.
func (UnionShapeType) Validate ¶
func (u UnionShapeType) Validate() error
Validate validates UnionShapeType
type UnsharpMask ¶
type UnsharpMask struct {
// Gain Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.
Gain *NumberVariableInline `json:"gain,omitempty"`
// Sigma The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.
Sigma *NumberVariableInline `json:"sigma,omitempty"`
// Threshold Set the minimum change required to include a detail in the filter. Higher values discard more changes.
Threshold *NumberVariableInline `json:"threshold,omitempty"`
// Transformation Identifies this type of transformation, `UnsharpMask` in this case.
Transformation UnsharpMaskTransformation `json:"transformation"`
}
UnsharpMask Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image and Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.
type UnsharpMaskTransformation ¶
type UnsharpMaskTransformation string
UnsharpMaskTransformation ...
func UnsharpMaskTransformationPtr ¶
func UnsharpMaskTransformationPtr(v UnsharpMaskTransformation) *UnsharpMaskTransformation
UnsharpMaskTransformationPtr returns pointer of UnsharpMaskTransformation
type UpdatePolicySet ¶
UpdatePolicySet describes the body of the UpdatePolicySet request
type UpdatePolicySetRequest ¶
type UpdatePolicySetRequest struct {
PolicySetID string
ContractID string
UpdatePolicySet
}
UpdatePolicySetRequest describes the parameters of the UpdatePolicySet request
func (UpdatePolicySetRequest) Validate ¶
func (v UpdatePolicySetRequest) Validate() error
Validate validates UpdatePolicySetRequest
type UpsertPolicyRequest ¶
type UpsertPolicyRequest struct {
PolicyID string
Network PolicyNetwork
ContractID string
PolicySetID string
PolicyInput
}
UpsertPolicyRequest describes the parameters of the UpsertPolicy request
func (UpsertPolicyRequest) Validate ¶
func (v UpsertPolicyRequest) Validate() error
Validate validates UpsertPolicyRequest
type Variable ¶
type Variable struct {
// DefaultValue The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.
DefaultValue string `json:"defaultValue"`
EnumOptions []*EnumOptions `json:"enumOptions,omitempty"`
// Name The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.
Name string `json:"name"`
// Postfix A postfix added to the value provided for the variable, or to the default value.
Postfix *string `json:"postfix,omitempty"`
// Prefix A prefix added to the value provided for the variable, or to the default value.
Prefix *string `json:"prefix,omitempty"`
// Type The type of value for the variable.
Type VariableType `json:"type"`
}
Variable ...
type VariableInline ¶
type VariableInline struct {
// Var Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.
Var string `json:"var"`
}
VariableInline References the name of a variable defined [by the policy](#63c7bea4). Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.
func (VariableInline) Validate ¶
func (v VariableInline) Validate() error
Validate validates VariableInline
type VariableType ¶
type VariableType string
VariableType ...
func VariableTypePtr ¶
func VariableTypePtr(v VariableType) *VariableType
VariableTypePtr returns pointer of VariableType
Source Files
Click to show internal directories.
Click to hide internal directories.