Input Types¶

The gpp_client.generated.input_types module contains Pydantic models used to construct typed GraphQL inputs.

Use these models when calling domain methods or generated GraphQL operations that require structured input.

Example¶

from gpp_client.generated.input_types import CreateObservationInput

API Reference¶

class gpp_client.generated.input_types.AddDatasetEventInput(*, datasetId: Any, datasetStage: DatasetStage, idempotencyKey: Any | None = None)[source]¶

Bases: BaseModel

DatasetEvent creation parameters.

dataset_id: Any¶: Dataset id

dataset_stage: DatasetStage¶: Dataset execution stage.

idempotency_key: Any | None¶: Idempotency key, if any. The IdempotencyKey may be provided by clients when the event is created and is used to enable problem-free retry in the case of failure.

class gpp_client.generated.input_types.AddProgramUserInput(*, programId: Any, role: ProgramUserRole, SET: ProgramUserPropertiesInput | None = None)[source]¶

Bases: BaseModel

program_id: Any¶

role: ProgramUserRole¶

set_: ProgramUserPropertiesInput | None¶

class gpp_client.generated.input_types.AddSequenceEventInput(*, visitId: Any, command: SequenceCommand, idempotencyKey: Any | None = None)[source]¶

Bases: BaseModel

SequenceEvent creation parameters.

command: SequenceCommand¶

idempotency_key: Any | None¶: Idempotency key, if any. The IdempotencyKey may be provided by clients when the event is created and is used to enable problem-free retry in the case of failure.

visit_id: Any¶

class gpp_client.generated.input_types.AddSlewEventInput(*, observationId: Any, slewStage: SlewStage, idempotencyKey: Any | None = None)[source]¶

Bases: BaseModel

SlewEvent creation parameters.

idempotency_key: Any | None¶: Idempotency key, if any. The IdempotencyKey may be provided by clients when the event is created and is used to enable problem-free retry in the case of failure.

observation_id: Any¶

slew_stage: SlewStage¶

class gpp_client.generated.input_types.AddStepEventInput(*, stepId: Any, visitId: Any, stepStage: StepStage, idempotencyKey: Any | None = None)[source]¶

Bases: BaseModel

StepEvent creation parameters.

idempotency_key: Any | None¶: Idempotency key, if any. The IdempotencyKey may be provided by clients when the event is created and is used to enable problem-free retry in the case of failure.

step_id: Any¶

step_stage: StepStage¶

visit_id: Any¶

class gpp_client.generated.input_types.AddTimeChargeCorrectionInput(*, visitId: Any, correction: TimeChargeCorrectionInput)[source]¶

Bases: BaseModel

Input to the ‘addTimeChargeCorrection’ mutation. Identifies the visit that will be corrected and describes the correction itself.

correction: TimeChargeCorrectionInput¶

visit_id: Any¶

class gpp_client.generated.input_types.AirMassRangeInput(*, min: Any | None = None, max: Any | None = None)[source]¶

Bases: BaseModel

Air mass range creation and edit parameters

max: Any | None¶

min: Any | None¶

class gpp_client.generated.input_types.AllocationInput(*, category: TimeAccountingCategory, scienceBand: ScienceBand, duration: TimeSpanInput)[source]¶

Bases: BaseModel

An individual time allocation input.

category: TimeAccountingCategory¶

duration: TimeSpanInput¶

science_band: ScienceBand¶

Bases: BaseModel

Create an angle from a signed value. Choose exactly one of the available units.

arcminutes: Any | None¶

arcseconds: Any | None¶

degrees: Any | None¶

dms: str | None¶

hms: str | None¶

hours: Any | None¶

microarcseconds: Any | None¶

microseconds: Any | None¶

milliarcseconds: Any | None¶

milliseconds: Any | None¶

minutes: Any | None¶

seconds: Any | None¶

class gpp_client.generated.input_types.AttachmentPropertiesInput(*, description: Any | None = None, checked: bool | None = None)[source]¶

Bases: BaseModel

checked: bool | None¶: The checked status can be set, or ignored by skipping it altogether

description: Any | None¶: The description field may be unset by assigning a null value, or ignored by skipping it altogether

class gpp_client.generated.input_types.BandBrightnessIntegratedInput(*, band: Band, value: Any | None = None, units: BrightnessIntegratedUnits | None = None, error: Any | None = None)[source]¶

Bases: BaseModel

Create or edit a band brightness value with integrated magnitude units. When creating a new value, all fields except “error” are required.

band: Band¶

error: Any | None¶: Error values are optional

units: BrightnessIntegratedUnits | None¶: The units field is required when creating a new instance of BandBrightnessIntegrated, but optional when editing

value: Any | None¶: The value field is required when creating a new instance of BandBrightnessIntegrated, but optional when editing

class gpp_client.generated.input_types.BandBrightnessSurfaceInput(*, band: Band, value: Any | None = None, units: BrightnessSurfaceUnits | None = None, error: Any | None = None)[source]¶

Bases: BaseModel

Create or edit a band brightness value with surface magnitude units. When creating a new value, all fields except “error” are required.

band: Band¶

error: Any | None¶: Error values are optional

units: BrightnessSurfaceUnits | None¶: The units field is required when creating a new instance of BandBrightnessSurface, but optional when editing

value: Any | None¶: The value field is required when creating a new instance of BandBrightnessSurface, but optional when editing

class gpp_client.generated.input_types.BandNormalizedIntegratedInput(*, sed: UnnormalizedSedInput | None = None, brightnesses: list[BandBrightnessIntegratedInput] | None = None)[source]¶

Bases: BaseModel

Create or edit a band normalized value with integrated magnitude units. Specify at least “brightnesses” when creating a new BandNormalizedIntegrated.

brightnesses: list[BandBrightnessIntegratedInput] | None¶: The brightnesses field is required when creating a new instance of BandNormalizedIntegrated, but optional when editing

sed: UnnormalizedSedInput | None¶: The sed field is optional and nullable

class gpp_client.generated.input_types.BandNormalizedSurfaceInput(*, sed: UnnormalizedSedInput | None = None, brightnesses: list[BandBrightnessSurfaceInput] | None = None)[source]¶

Bases: BaseModel

Create or edit a band normalized value with surface magnitude units. Specify at least “brightnesses” when creating a new BandNormalizedSurface.

brightnesses: list[BandBrightnessSurfaceInput] | None¶: The brightnesses field is required when creating a new instance of BandNormalizedSurface, but optional when editing

sed: UnnormalizedSedInput | None¶: The sed field is optional and nullable

class gpp_client.generated.input_types.CallForProposalsPartnerInput(*, partner: Partner, submissionDeadlineOverride: Any | None = None)[source]¶

Bases: BaseModel

partner: Partner¶

submission_deadline_override: Any | None¶: If this partner has an explicit submission deadline that overrides the Call for Proposals ‘defaultSubmissionDeadine’ then it is specified here. Otherwise, the partner deadline is the default deadline for the call.

class gpp_client.generated.input_types.CallForProposalsPropertiesInput(*, type: CallForProposalsType | None = None, semester: Any | None = None, title: Any | None = None, coordinateLimits: SiteCoordinateLimitsInput | None = None, activeStart: Any | None = None, activeEnd: Any | None = None, submissionDeadlineDefault: Any | None = None, partners: list[CallForProposalsPartnerInput] | None = None, instruments: list[Instrument] | None = None, proprietaryMonths: Any | None = None, existence: Existence | None = None)[source]¶

Bases: BaseModel

The properties of a Call for Proposal in an input for creation and editing.

active_end: Any | None¶

Active period end date (exclusive) for this call. The date is considered to be the local date at each observation site. Observations may end the morning of the indicated date at the site of the observation.

The end date is required on create and must be after the activeStart date. Not nullable. Limited to dates between 1900 and 2100 (exclusive).

active_start: Any | None¶

Active period start date (inclusive) for this call. The date is considered to be the local date at each observation site. Observations may begin the evening of the indicated date at the site of the observation.

The start date is required on create and must be before the activeEnd date. Not nullable. Limited to dates between 1900 and 2100 (exclusive).

coordinate_limits: SiteCoordinateLimitsInput | None¶: Coordinate limits. If not specified, they will default according to the coordinates that are safely visible during the active period of the call.

existence: Existence | None¶: DELETED or PRESENT. On create defaults to PRESENT.

instruments: list[Instrument] | None¶: When specified, the call is limited to the listed instruments. When not specified, all otherwise available instruments may be used. When editing, supply the entire list of instruments to set. Nullable on edit.

partners: list[CallForProposalsPartnerInput] | None¶: Partners that may participate in the call along with their respective deadlines. When editing, supply the entire list of all partners. Defaults to all partners.

proprietary_months: Any | None¶: The default proprietary period for proposals linked to this call. If not specified, the default period for the call type will be used.

semester: Any | None¶: Semester associated with the call. Required on create.

submission_deadline_default: Any | None¶: Specifies a submission deadline to use for any partners without an explicit partner deadline.

title: Any | None¶: The CfP title. If not set then a title will be determined from the CfP properties. This property is not required on create and may be assigned a null value to return to the default.

type_: CallForProposalsType | None¶: Type of the call. Required on create.

class gpp_client.generated.input_types.CatalogInfoInput(*, name: CatalogName | None = None, id: Any | None = None, objectType: Any | None = None)[source]¶

Bases: BaseModel

Catalog id consisting of catalog name, string identifier and an optional object type

id: Any | None¶: The id field must be either specified or skipped altogether. It cannot be unset with a null value.

name: CatalogName | None¶: The name field must be either specified or skipped altogether. It cannot be unset with a null value.

object_type: Any | None¶: The objectType field may be unset by assigning a null value, or ignored by skipping it altogether

class gpp_client.generated.input_types.ChangeProgramUserRoleInput(*, programUserId: Any, newRole: ProgramUserRole)[source]¶

Bases: BaseModel

Input used to change the role of a program user.

new_role: ProgramUserRole¶: New role they should assume.

program_user_id: Any¶: Program user to update.

class gpp_client.generated.input_types.ClassicalInput(*, minPercentTime: Any | None = None, partnerSplits: list[PartnerSplitInput] | None = None, aeonMultiFacility: bool | None = None, jwstSynergy: bool | None = None, usLongTerm: bool | None = None, considerForBand3: ConsiderForBand3 | None = None)[source]¶

Bases: BaseModel

aeon_multi_facility: bool | None¶: Whether this proposal is part of the AEON/Multi-facility program.

consider_for_band_3: ConsiderForBand3 | None¶: Whether this proposal should be considered for Band 3.

jwst_synergy: bool | None¶: Whether this proposal has JWST synergy.

min_percent_time: Any | None¶: The minimum percentage of time required to consider this proposal a success. If not set, 100% is assumed.

partner_splits: list[PartnerSplitInput] | None¶: The partnerSplits field specifies how time is apportioned over partners. This will default to empty but if specified, the partner percents must sum to 100. By submission time, it must be specified.

us_long_term: bool | None¶: Whether this is a US Long Term proposal.

class gpp_client.generated.input_types.CloneGroupInput(*, groupId: Any, SET: GroupPropertiesInput | None = None)[source]¶

Bases: BaseModel

group_id: Any¶

set_: GroupPropertiesInput | None¶

class gpp_client.generated.input_types.CloneObservationInput(*, observationId: Any | None = None, observationReference: Any | None = None, SET: ObservationPropertiesInput | None = None)[source]¶

Bases: BaseModel

Describes an observation clone operation, making any edits in the SET parameter. The observation status in the cloned observation defaults to NEW. Identify the observation to clone by specifying either its id or reference. If both are specified, they must refer to the same observation. If neither is specified, nothing will be cloned.

observation_id: Any | None¶

observation_reference: Any | None¶

set_: ObservationPropertiesInput | None¶

class gpp_client.generated.input_types.CloneTargetInput(*, targetId: Any, SET: TargetPropertiesInput | None = None, REPLACE_IN: list[Any] | None = None)[source]¶

Bases: BaseModel

Describes a target clone operation, making any edits in the SET parameter and replacing the target in the selected REPLACE_IN observations

replace_in: list[Any] | None¶

set_: TargetPropertiesInput | None¶

target_id: Any¶

class gpp_client.generated.input_types.ConditionsEntryInput(*, measurement: ConditionsMeasurementInput | None = None, intuition: ConditionsIntuitionInput | None = None)[source]¶

Bases: BaseModel

intuition: ConditionsIntuitionInput | None¶

measurement: ConditionsMeasurementInput | None¶

class gpp_client.generated.input_types.ConditionsExpectationInput(*, type: ConditionsExpectationType, timeframe: TimeSpanInput)[source]¶

Bases: BaseModel

timeframe: TimeSpanInput¶

type_: ConditionsExpectationType¶

class gpp_client.generated.input_types.ConditionsIntuitionInput(*, expectation: ConditionsExpectationInput | None = None, seeingTrend: SeeingTrend | None = None)[source]¶

Bases: BaseModel

expectation: ConditionsExpectationInput | None¶

seeing_trend: SeeingTrend | None¶

class gpp_client.generated.input_types.ConditionsMeasurementInput(*, source: ConditionsMeasurementSource, seeing: AngleInput | None = None, extinction: Any | None = None, wavelength: WavelengthInput | None = None, azimuth: AngleInput | None = None, elevation: AngleInput | None = None)[source]¶

Bases: BaseModel

azimuth: AngleInput | None¶

elevation: AngleInput | None¶

extinction: Any | None¶

seeing: AngleInput | None¶

source: ConditionsMeasurementSource¶

wavelength: WavelengthInput | None¶

class gpp_client.generated.input_types.ConfigurationRequestEditInput(*, programId: Any | None = None)[source]¶

Bases: BaseModel

program_id: Any | None¶: Program ID

class gpp_client.generated.input_types.ConfigurationRequestProperties(*, status: ConfigurationRequestStatus | None = None, justification: Any | None = None)[source]¶

Bases: BaseModel

Configuration request properties.

justification: Any | None¶

status: ConfigurationRequestStatus | None¶

class gpp_client.generated.input_types.ConstraintSetInput(*, imageQuality: ImageQualityPreset | None = None, cloudExtinction: CloudExtinctionPreset | None = None, skyBackground: SkyBackground | None = None, waterVapor: WaterVapor | None = None, elevationRange: ElevationRangeInput | None = None)[source]¶

Bases: BaseModel

Constraint set creation and editing parameters

cloud_extinction: CloudExtinctionPreset | None¶: The cloudExtinction field is required when creating a new instance of ConstraintSet, but optional when editing

elevation_range: ElevationRangeInput | None¶: The elevationRange field is required when creating a new instance of ConstraintSet, but optional when editing

image_quality: ImageQualityPreset | None¶: The imageQuality field is required when creating a new instance of ConstraintSet, but optional when editing

sky_background: SkyBackground | None¶: The skyBackground field is required when creating a new instance of ConstraintSet, but optional when editing

water_vapor: WaterVapor | None¶: The waterVapor field is required when creating a new instance of ConstraintSet, but optional when editing

class gpp_client.generated.input_types.CoordinateLimitsInput(*, raStart: RightAscensionInput | None = None, raEnd: RightAscensionInput | None = None, decStart: DeclinationInput | None = None, decEnd: DeclinationInput | None = None)[source]¶

Bases: BaseModel

dec_end: DeclinationInput | None¶: Optional declination limit end declination.

dec_start: DeclinationInput | None¶: Optional declination limit start declination.

ra_end: RightAscensionInput | None¶: Optional RA limit end RA.

ra_start: RightAscensionInput | None¶: Optional RA limit start RA.

class gpp_client.generated.input_types.CoordinatesInput(*, ra: RightAscensionInput | None = None, dec: DeclinationInput | None = None)[source]¶

Bases: BaseModel

Absolute coordinates relative base epoch

dec: DeclinationInput | None¶

ra: RightAscensionInput | None¶

class gpp_client.generated.input_types.CreateCallForProposalsInput(*, SET: CallForProposalsPropertiesInput | None = None)[source]¶

Bases: BaseModel

set_: CallForProposalsPropertiesInput | None¶

class gpp_client.generated.input_types.CreateConfigurationRequestInput(*, observationId: Any | None = None, SET: ConfigurationRequestProperties | None = None)[source]¶

Bases: BaseModel

observation_id: Any | None¶

set_: ConfigurationRequestProperties | None¶

Bases: BaseModel

Group creation parameters. One of programId, programReference or proposalReference is required. (If two or more are provided, they must refer to the same program.)

initial_contents: list[GroupElementInput | None] | None¶: Group elements specified here, if any, will be moved into the created group in the specified order.

program_id: Any | None¶

program_reference: Any | None¶

proposal_reference: Any | None¶

set_: GroupPropertiesInput | None¶

class gpp_client.generated.input_types.CreateObservationInput(*, programId: Any | None = None, proposalReference: Any | None = None, programReference: Any | None = None, SET: ObservationPropertiesInput | None = None)[source]¶

Bases: BaseModel

Observation creation parameters. One of programId or programReference is required. If both are provided, they must refer to the same program.

program_id: Any | None¶

program_reference: Any | None¶

proposal_reference: Any | None¶

set_: ObservationPropertiesInput | None¶

class gpp_client.generated.input_types.CreateProgramInput(*, SET: ProgramPropertiesInput | None = None)[source]¶

Bases: BaseModel

Program creation parameters

set_: ProgramPropertiesInput | None¶

class gpp_client.generated.input_types.CreateProgramNoteInput(*, programId: Any | None = None, proposalReference: Any | None = None, programReference: Any | None = None, SET: ProgramNotePropertiesInput)[source]¶

Bases: BaseModel

program_id: Any | None¶

program_reference: Any | None¶

proposal_reference: Any | None¶

set_: ProgramNotePropertiesInput¶

class gpp_client.generated.input_types.CreateProposalInput(*, programId: Any, SET: ProposalPropertiesInput)[source]¶

Bases: BaseModel

Input for creating a proposal.

program_id: Any¶

set_: ProposalPropertiesInput¶

class gpp_client.generated.input_types.CreateTargetInput(*, programId: Any | None = None, proposalReference: Any | None = None, programReference: Any | None = None, SET: TargetPropertiesInput)[source]¶

Bases: BaseModel

Target creation parameters. One of programId or programReference is required. If both are provided, they must refer to the same program.

program_id: Any | None¶

program_reference: Any | None¶

proposal_reference: Any | None¶

set_: TargetPropertiesInput¶

class gpp_client.generated.input_types.CreateUserInvitationInput(*, programUserId: Any, recipientEmail: Any)[source]¶

Bases: BaseModel

Creates an invitation, if none exists for the indicated ‘ProgramUser’, and sets it to ‘PENDING’ status. If there is an outstanding invitation, it must be declined or revoked before a new one may be issued.

program_user_id: Any¶: The associated program user.

recipient_email: Any¶: The recipient to whom the invitation should be sent.

class gpp_client.generated.input_types.DatasetEditInput(*, datasetId: Any | None = None, observationId: Any | None = None, programId: Any | None = None, isWritten: bool | None = None)[source]¶

Bases: BaseModel

Specifies filtering options for dataset edit events from the datasetEdit subscription.

dataset_id: Any | None¶: If set, only events for the associated dataset are sent.

is_written: bool | None¶: If set, only events for datasets that are written to disk are sent. (Note, datasets are considered to be written when an END_WRITE event is received by the database.)

observation_id: Any | None¶: If set, only events for datasets produced by the associated observation are sent.

program_id: Any | None¶: If set, only events for datasets produced by the associated program are sent.

class gpp_client.generated.input_types.DatasetPropertiesInput(*, qaState: DatasetQaState | None = None, comment: Any | None = None)[source]¶

Bases: BaseModel

Editable dataset properties

comment: Any | None¶

qa_state: DatasetQaState | None¶

class gpp_client.generated.input_types.DeclinationArcInput(*, type: ArcType, start: DeclinationInput | None = None, end: DeclinationInput | None = None)[source]¶

Bases: BaseModel

end: DeclinationInput | None¶

start: DeclinationInput | None¶

type_: ArcType¶

class gpp_client.generated.input_types.DeclinationInput(*, microarcseconds: Any | None = None, degrees: Any | None = None, dms: Any | None = None)[source]¶

Bases: BaseModel

Declination, choose one of the available units

degrees: Any | None¶

dms: Any | None¶

microarcseconds: Any | None¶

class gpp_client.generated.input_types.DeleteProgramUserInput(*, programUserId: Any)[source]¶

Bases: BaseModel

Input for deleting a program user.

program_user_id: Any¶

class gpp_client.generated.input_types.DeleteProposalInput(*, programId: Any)[source]¶

Bases: BaseModel

Input for deleting a proposal.

program_id: Any¶

class gpp_client.generated.input_types.DemoScienceInput(*, toOActivation: ToOActivation | None = None, minPercentTime: Any | None = None)[source]¶

Bases: BaseModel

min_percent_time: Any | None¶: The minimum percentage of time required to consider this proposal a success. If not set, 100% is assumed.

to_o_activation: ToOActivation | None¶: The toOActivation field is optional. If not specified when creating a proposal, it defaults to `NONE’.

class gpp_client.generated.input_types.DirectorsTimeInput(*, toOActivation: ToOActivation | None = None, minPercentTime: Any | None = None)[source]¶

Bases: BaseModel

min_percent_time: Any | None¶: The minimum percentage of time required to consider this proposal a success. If not set, 100% is assumed.

to_o_activation: ToOActivation | None¶: The toOActivation field is optional. If not specified when creating a proposal, it defaults to `NONE’.

class gpp_client.generated.input_types.EditAsterismsPatchInput(*, ADD: list[Any] | None = None, DELETE: list[Any] | None = None)[source]¶

Bases: BaseModel

Add or delete targets in an asterism

add: list[Any] | None¶

delete: list[Any] | None¶

class gpp_client.generated.input_types.ElevationRangeInput(*, airMass: AirMassRangeInput | None = None, hourAngle: HourAngleRangeInput | None = None)[source]¶

Bases: BaseModel

Elevation range creation and edit parameters. Choose one of airMass or hourAngle constraints.

air_mass: AirMassRangeInput | None¶

hour_angle: HourAngleRangeInput | None¶

class gpp_client.generated.input_types.EmissionLineIntegratedInput(*, wavelength: WavelengthInput, lineWidth: Any | None = None, lineFlux: LineFluxIntegratedInput | None = None)[source]¶

Bases: BaseModel

Create or edit an emission line with integrated line flux units. When creating a new value, all fields are required.

line_flux: LineFluxIntegratedInput | None¶: The lineFlux field is required when creating a new instance of EmissionLineIntegrated, but optional when editing

line_width: Any | None¶: The lineWidth field is required when creating a new instance of EmissionLineIntegrated, but optional when editing

wavelength: WavelengthInput¶

class gpp_client.generated.input_types.EmissionLineSurfaceInput(*, wavelength: WavelengthInput, lineWidth: Any | None = None, lineFlux: LineFluxSurfaceInput | None = None)[source]¶

Bases: BaseModel

Create or edit an emission line with surface line flux units. When creating a new value, all fields are required.

line_flux: LineFluxSurfaceInput | None¶: The lineFlux field is required when creating a new instance of EmissionLineSurface, but optional when editing

line_width: Any | None¶: The lineWidth field is required when creating a new instance of EmissionLineSurface, but optional when editing

wavelength: WavelengthInput¶

class gpp_client.generated.input_types.EmissionLinesIntegratedInput(*, lines: list[EmissionLineIntegratedInput] | None = None, fluxDensityContinuum: FluxDensityContinuumIntegratedInput | None = None)[source]¶

Bases: BaseModel

Create or edit emission lines with integrated line flux and flux density continuum units. Both “lines” and “fluxDensityContinuum” are required when creating a new EmissionLinesIntegrated.

flux_density_continuum: FluxDensityContinuumIntegratedInput | None¶: The fluxDensityContinuum field is required when creating a new instance of EmissionLinesIntegrated, but optional when editing

lines: list[EmissionLineIntegratedInput] | None¶: The lines field is required when creating a new instance of EmissionLinesIntegrated, but optional when editing

class gpp_client.generated.input_types.EmissionLinesSurfaceInput(*, lines: list[EmissionLineSurfaceInput] | None = None, fluxDensityContinuum: FluxDensityContinuumSurfaceInput | None = None)[source]¶

Bases: BaseModel

Create or edit emission lines with surface line flux and flux density continuum units. Both “lines” and “fluxDensityContinuum” are required when creating a new EmissionLinesSurface.

flux_density_continuum: FluxDensityContinuumSurfaceInput | None¶: The fluxDensityContinuum field is required when creating a new instance of EmissionLinesSurface, but optional when editing

lines: list[EmissionLineSurfaceInput] | None¶: The lines field is required when creating a new instance of EmissionLinesSurface, but optional when editing

class gpp_client.generated.input_types.EnumeratedTelescopeConfigGeneratorInput(*, values: list[TelescopeConfigInput])[source]¶

Bases: BaseModel

values: list[TelescopeConfigInput]¶

class gpp_client.generated.input_types.ExecutionEventAddedInput(*, programId: Any | None = None, observationId: Any | None = None, visitId: Any | None = None, eventType: WhereEqExecutionEventType | None = None)[source]¶

Bases: BaseModel

event_type: WhereEqExecutionEventType | None¶

observation_id: Any | None¶

program_id: Any | None¶

visit_id: Any | None¶

class gpp_client.generated.input_types.ExposureTimeModeInput(*, signalToNoise: SignalToNoiseExposureTimeModeInput | None = None, timeAndCount: TimeAndCountExposureTimeModeInput | None = None)[source]¶

Bases: BaseModel

Exposure time mode input. Specify fixed or signal to noise, but not both

signal_to_noise: SignalToNoiseExposureTimeModeInput | None¶: The signalToNoise field must be either specified or skipped altogether. It cannot be unset with a null value.

time_and_count: TimeAndCountExposureTimeModeInput | None¶: The timeAndCount field must be either specified or skipped altogether. It cannot be unset with a null value.

class gpp_client.generated.input_types.FastTurnaroundInput(*, toOActivation: ToOActivation | None = None, minPercentTime: Any | None = None, reviewerId: Any | None = None, mentorId: Any | None = None)[source]¶

Bases: BaseModel

mentor_id: Any | None¶: The program user ID to be designated as the mentor for this FT proposal. If not specified, no mentor will be assigned.

min_percent_time: Any | None¶: The minimum percentage of time required to consider this proposal a success. If not set, 100% is assumed.

reviewer_id: Any | None¶: The program user ID to be designated as the reviewer for this FT proposal. If not specified, the PI will be the default reviewer.

to_o_activation: ToOActivation | None¶: The toOActivation field is optional. If not specified when creating a proposal, it defaults to `NONE’.

class gpp_client.generated.input_types.Flamingos2AtomInput(*, description: Any | None = None, steps: list[Flamingos2StepInput])[source]¶

Bases: BaseModel

description: Any | None¶

steps: list[Flamingos2StepInput]¶

class gpp_client.generated.input_types.Flamingos2CustomMaskInput(*, filename: str, slitWidth: Flamingos2CustomSlitWidth)[source]¶

Bases: BaseModel

Flamingos 2 custom mask input parameters

filename: str¶: Custom mask file name

slit_width: Flamingos2CustomSlitWidth¶: Custom mask slit width

class gpp_client.generated.input_types.Flamingos2DynamicInput(*, exposure: TimeSpanInput, disperser: Flamingos2Disperser | None = None, filter: Flamingos2Filter, readMode: Flamingos2ReadMode, lyotWheel: Flamingos2LyotWheel, fpu: Flamingos2FpuMaskInput | None = None, decker: Flamingos2Decker, readoutMode: Flamingos2ReadoutMode, reads: Flamingos2Reads)[source]¶

Bases: BaseModel

Flamingos 2 instrument configuration input.

decker: Flamingos2Decker¶

disperser: Flamingos2Disperser | None¶

exposure: TimeSpanInput¶

filter_: Flamingos2Filter¶

fpu: Flamingos2FpuMaskInput | None¶

lyot_wheel: Flamingos2LyotWheel¶

read_mode: Flamingos2ReadMode¶

readout_mode: Flamingos2ReadoutMode¶

reads: Flamingos2Reads¶

class gpp_client.generated.input_types.Flamingos2FpuMaskInput(*, customMask: Flamingos2CustomMaskInput | None = None, builtin: Flamingos2Fpu | None = None)[source]¶

Bases: BaseModel

Flamingos 2 mask input parameters (choose custom or builtin).

builtin: Flamingos2Fpu | None¶: Builtin FPU option

custom_mask: Flamingos2CustomMaskInput | None¶: Custom mask FPU option

class gpp_client.generated.input_types.Flamingos2LongSlitAcquisitionInput(*, explicitFilter: Flamingos2Filter | None = None, exposureTimeMode: ExposureTimeModeInput | None = None)[source]¶

Bases: BaseModel

Flamingos2 Long Slit acquisition input parameters. When specified, these override default values.

explicit_filter: Flamingos2Filter | None¶: An explicit acquisition filter to use instead of the default. The explicitFilter may be unset by assigning a null value, or ignored by skipping it altogether. If not provided, the filter that will be used for the acquisition sequence is the acquisition filter closest to the science filter wavelength. Allowed filters are J, H and K_SHORT.

exposure_time_mode: ExposureTimeModeInput | None¶: Exposure time mode for the acquisition sequence. If not specified, a default exposure time mode is used.

class gpp_client.generated.input_types.Flamingos2LongSlitInput(*, disperser: Flamingos2Disperser | None = None, filter: Flamingos2Filter | None = None, fpu: Flamingos2Fpu | None = None, exposureTimeMode: ExposureTimeModeInput | None = None, explicitReadMode: Flamingos2ReadMode | None = None, explicitReads: Flamingos2Reads | None = None, explicitDecker: Flamingos2Decker | None = None, explicitReadoutMode: Flamingos2ReadoutMode | None = None, explicitOffsets: list[OffsetInput] | None = None, telluricType: TelluricTypeInput | None = None, acquisition: Flamingos2LongSlitAcquisitionInput | None = None)[source]¶

Bases: BaseModel

Edit or create Flamingos2 Long Slit advanced configuration

acquisition: Flamingos2LongSlitAcquisitionInput | None¶: Acquisition properties that, when set, override default values.

disperser: Flamingos2Disperser | None¶: The disperser field must be specified. It cannot be unset with a null value.

explicit_decker: Flamingos2Decker | None¶: The decker field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_offsets: list[OffsetInput] | None¶: The explicitOffsets field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_read_mode: Flamingos2ReadMode | None¶: The read mode field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_readout_mode: Flamingos2ReadoutMode | None¶: The readoutMode field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_reads: Flamingos2Reads | None¶: The reads field may be unset by assigning a null value, or ignored by skipping it altogether

exposure_time_mode: ExposureTimeModeInput | None¶: Exposure time mode for the science sequence. If not specified, the exposure time mode of the observation’s science requirements are used.

filter_: Flamingos2Filter | None¶: The filter field may be unset by assigning a null value, or ignored by skipping it altogether

fpu: Flamingos2Fpu | None¶: The fpu field must be specified. It cannot be unset with a null value.

telluric_type: TelluricTypeInput | None¶: The telluricType field must be either specified or skipped altogether. It cannot be unset with a null value. On create the default is HOT.

class gpp_client.generated.input_types.Flamingos2StaticInput(*, mosPreImaging: MosPreImaging | None = None, useElectronicOffsetting: bool | None = None)[source]¶

Bases: BaseModel

Flamingos 2 static configuration input parameters

mos_pre_imaging: MosPreImaging | None¶: Whether this is a MOS pre-imaging observation (defaults to IS_NOT_MOS_PRE_IMAGING)

use_electronic_offsetting: bool | None¶: Whether to use electronic offsetting (defaults to false)

class gpp_client.generated.input_types.Flamingos2StepInput(*, instrumentConfig: Flamingos2DynamicInput, breakpoint: Breakpoint | None = None, stepConfig: StepConfigInput, telescopeConfig: TelescopeConfigInput | None = None, observeClass: ObserveClass)[source]¶

Bases: BaseModel

breakpoint: Breakpoint | None¶

instrument_config: Flamingos2DynamicInput¶

observe_class: ObserveClass¶

step_config: StepConfigInput¶

telescope_config: TelescopeConfigInput | None¶

class gpp_client.generated.input_types.FluxDensity(*, wavelength: WavelengthInput, density: Any)[source]¶

Bases: BaseModel

Flux density entry

density: Any¶

wavelength: WavelengthInput¶

class gpp_client.generated.input_types.FluxDensityContinuumIntegratedInput(*, value: Any, units: FluxDensityContinuumIntegratedUnits, error: Any | None = None)[source]¶

Bases: BaseModel

A flux density continuum value with integrated units

error: Any | None¶

units: FluxDensityContinuumIntegratedUnits¶

value: Any¶

class gpp_client.generated.input_types.FluxDensityContinuumSurfaceInput(*, value: Any, units: FluxDensityContinuumSurfaceUnits, error: Any | None = None)[source]¶

Bases: BaseModel

A flux density continuum value with surface units

error: Any | None¶

units: FluxDensityContinuumSurfaceUnits¶

value: Any¶

class gpp_client.generated.input_types.GaussianInput(*, fwhm: AngleInput | None = None, spectralDefinition: SpectralDefinitionIntegratedInput | None = None)[source]¶

Bases: BaseModel

Create or edit a gaussian source. Specify both “fwhm” and “spectralDefinition” when creating a new Gaussian.

fwhm: AngleInput | None¶: The fwhm field is required when creating a new instance of Gaussian, but optional when editing

spectral_definition: SpectralDefinitionIntegratedInput | None¶: The spectralDefinition field is required when creating a new instance of Gaussian, but optional when editing

class gpp_client.generated.input_types.GhostDetectorConfigInput(*, exposureTimeMode: ExposureTimeModeInput | None = None, explicitBinning: GhostBinning | None = None, explicitReadMode: GhostReadMode | None = None)[source]¶

Bases: BaseModel

explicit_binning: GhostBinning | None¶: Explicit binning to use for the detector. If not specified upon creation, a 1x1 default will be used.

explicit_read_mode: GhostReadMode | None¶: Explicit read mode for the detector. If not specified upon creation, a default of MEDIUM (red camera) or SLOW (blue camera) will be used.

exposure_time_mode: ExposureTimeModeInput | None¶: Exposure time mode for the detector. If not specified, the exposure time mode of the observation’s science requirements are used. Note, only TimeAndCount exposure time modes are accepted at this time.

class gpp_client.generated.input_types.GhostIfuInput(*, stepCount: Any | None = None, resolutionMode: GhostResolutionMode | None = None, red: GhostDetectorConfigInput | None = None, blue: GhostDetectorConfigInput | None = None, slitViewingCameraExposureTime: TimeSpanInput | None = None, explicitIfu1Agitator: GhostIfu1FiberAgitator | None = None, explicitIfu2Agitator: GhostIfu2FiberAgitator | None = None)[source]¶

Bases: BaseModel

Edit or create GHOST IFU Mode

blue: GhostDetectorConfigInput | None¶: Blue config. If not specified, defaults will be applied. Cannot be unset with a null value.

explicit_ifu_1_agitator: GhostIfu1FiberAgitator | None¶: IFU1 fiber agitator setting. If not specified, a default (DISABLED) will be applied. Cannot be unset with a null value.

explicit_ifu_2_agitator: GhostIfu2FiberAgitator | None¶: IFU2 fiber agitator setting. If not specified, a default (DISABLED) will be applied. Cannot be unset with a null value.

red: GhostDetectorConfigInput | None¶: Red config. If not specified, defaults will be applied. Cannot be unset with a null value.

resolution_mode: GhostResolutionMode | None¶: The disperser field must be specified. It cannot be unset with a null value.

slit_viewing_camera_exposure_time: TimeSpanInput | None¶: Slit viewing camera exposure time. If not specified, this will remain null. May be unset with a null value.

step_count: Any | None¶: Requested step count. If not specified, a default of 1 will applied. Cannot be unset with a null value.

class gpp_client.generated.input_types.GmosCcdModeInput(*, xBin: GmosBinning | None = None, yBin: GmosBinning | None = None, ampCount: GmosAmpCount | None = None, ampGain: GmosAmpGain | None = None, ampReadMode: GmosAmpReadMode | None = None)[source]¶

Bases: BaseModel

GMOS CCD readout input parameters

amp_count: GmosAmpCount | None¶: Amp Count, defaults to ‘TWELVE’.

amp_gain: GmosAmpGain | None¶: Amp Gain, defaults to ‘LOW’

amp_read_mode: GmosAmpReadMode | None¶: Amp Read Mode, defaults to ‘SLOW’

x_bin: GmosBinning | None¶: X Binning, defaults to ‘ONE’.

y_bin: GmosBinning | None¶: Y Binning, defaults to ‘ONE’.

class gpp_client.generated.input_types.GmosCustomMaskInput(*, filename: str, slitWidth: GmosCustomSlitWidth)[source]¶

Bases: BaseModel

GMOS custom mask input parameters

filename: str¶: Custom mask file name

slit_width: GmosCustomSlitWidth¶: Custom mask slit width

class gpp_client.generated.input_types.GmosGroupedImagingVariantInput(*, order: WavelengthOrder | None = None, offsets: TelescopeConfigGeneratorInput | None = None, skyCount: Any | None = None, skyOffsets: TelescopeConfigGeneratorInput | None = None)[source]¶

Bases: BaseModel

Input used for specifying GMOS grouped filter imaging.

offsets: TelescopeConfigGeneratorInput | None¶: Offset generator for the science object datasets. The same offset sequence is created for each filter using the specified generator. If not specified, no offsets will be used.

order: WavelengthOrder | None¶: Whether the filters should appear in the sequence in increasing or decreasing order by their wavelength. Defaults to INCREASING on create, absent (i.e., not modified) on update.

sky_count: Any | None¶: Number of sky positions to collect before and after object datasets. For example, if set to 2 there will be two sky positions before a group of object exposures and two more after using the same filter as the object datasets. Defaults to 0 on creation, absent (i.e., not modified) on update.

sky_offsets: TelescopeConfigGeneratorInput | None¶: Offset generator to use for sky positions. If not specified, no offsets will be used.

class gpp_client.generated.input_types.GmosImagingVariantInput(*, grouped: GmosGroupedImagingVariantInput | None = None, interleaved: GmosInterleavedImagingVariantInput | None = None, preImaging: GmosPreImagingVariantInput | None = None)[source]¶

Bases: BaseModel

Input that specifies which imaging sub-type is desired along with its configuration details. Exactly one of the options should be defined and the other two left unspecified.

grouped: GmosGroupedImagingVariantInput | None¶: Grouped mode collects all datasets for each filter before changing filters.

interleaved: GmosInterleavedImagingVariantInput | None¶: Interleaved mode cycles through all filters repeatedly.

pre_imaging: GmosPreImagingVariantInput | None¶: PreImaging mode is used for MOS mask creation.

class gpp_client.generated.input_types.GmosInterleavedImagingVariantInput(*, offsets: TelescopeConfigGeneratorInput | None = None, skyCount: Any | None = None, skyOffsets: TelescopeConfigGeneratorInput | None = None)[source]¶

Bases: BaseModel

Input used for specifying GMOS interleaved filter imaging.

offsets: TelescopeConfigGeneratorInput | None¶: Offset generator for the science object datasets. The offset pattern is created for the sequence of science datasets as a whole.

sky_count: Any | None¶: Number of sky positions to collect, per filter, before and after a series of object datasets. Defaults to 0 on creation, absent (i.e., not modified) on update.

sky_offsets: TelescopeConfigGeneratorInput | None¶: Offset generator to use for sky positions. If not specified, no offsets will be used. When specifying an offset generator, the skyCount should be set to a value greater than 0.

class gpp_client.generated.input_types.GmosNodAndShuffleInput(*, posA: OffsetInput, posB: OffsetInput, eOffset: GmosEOffsetting, shuffleOffset: Any, shuffleCycles: Any)[source]¶

Bases: BaseModel

Creation input parameters for GMOS nod and shuffle

e_offset: GmosEOffsetting¶: Electronic offsetting

pos_a: OffsetInput¶: Offset position A

pos_b: OffsetInput¶: Offset position B

shuffle_cycles: Any¶: Shuffle cycles

shuffle_offset: Any¶: Shuffle offset

class gpp_client.generated.input_types.GmosNorthAtomInput(*, description: Any | None = None, steps: list[GmosNorthStepInput])[source]¶

Bases: BaseModel

description: Any | None¶

steps: list[GmosNorthStepInput]¶

class gpp_client.generated.input_types.GmosNorthDynamicInput(*, exposure: TimeSpanInput, readout: GmosCcdModeInput, dtax: GmosDtax, roi: GmosRoi, gratingConfig: GmosNorthGratingConfigInput | None = None, filter: GmosNorthFilter | None = None, fpu: GmosNorthFpuInput | None = None)[source]¶

Bases: BaseModel

GMOS North instrument configuration input

dtax: GmosDtax¶: GMOS detector x offset

exposure: TimeSpanInput¶: Exposure time

filter_: GmosNorthFilter | None¶: GMOS North filter

fpu: GmosNorthFpuInput | None¶: GMOS North FPU

grating_config: GmosNorthGratingConfigInput | None¶: GMOS North grating

readout: GmosCcdModeInput¶: GMOS CCD readout

roi: GmosRoi¶: GMOS region of interest

class gpp_client.generated.input_types.GmosNorthFpuInput(*, customMask: GmosCustomMaskInput | None = None, builtin: GmosNorthBuiltinFpu | None = None)[source]¶

Bases: BaseModel

GMOS North FPU input parameters (choose custom or builtin).

builtin: GmosNorthBuiltinFpu | None¶: Builtin FPU option

custom_mask: GmosCustomMaskInput | None¶: Custom mask FPU option

class gpp_client.generated.input_types.GmosNorthGratingConfigInput(*, grating: GmosNorthGrating, order: GmosGratingOrder, wavelength: WavelengthInput)[source]¶

Bases: BaseModel

GMOS North grating input parameters

grating: GmosNorthGrating¶: GmosGmosNorth grating

order: GmosGratingOrder¶: GMOS grating order

wavelength: WavelengthInput¶: Grating wavelength

class gpp_client.generated.input_types.GmosNorthImagingFilterInput(*, filter: GmosNorthFilter, exposureTimeMode: ExposureTimeModeInput | None = None)[source]¶

Bases: BaseModel

Defines the GMOS North filter to use along with its exposure time mode. If the exposure time mode is not specified, it is taken from the observation’s requirements.

exposure_time_mode: ExposureTimeModeInput | None¶

filter_: GmosNorthFilter¶

class gpp_client.generated.input_types.GmosNorthImagingInput(*, variant: GmosImagingVariantInput | None = None, filters: list[GmosNorthImagingFilterInput] | None = None, explicitBin: GmosBinning | None = None, explicitAmpReadMode: GmosAmpReadMode | None = None, explicitAmpGain: GmosAmpGain | None = None, explicitRoi: GmosRoi | None = None)[source]¶

Bases: BaseModel

Edit or create GMOS North Imaging advanced configuration

explicit_amp_gain: GmosAmpGain | None¶: The explicitAmpGain field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_amp_read_mode: GmosAmpReadMode | None¶: The explicitAmpReadMode field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_bin: GmosBinning | None¶: The explicitBin field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_roi: GmosRoi | None¶: The explicitRoi field may be unset by assigning a null value, or ignored by skipping it altogether

filters: list[GmosNorthImagingFilterInput] | None¶: The filters field must be specified with at least one filter. It cannot be unset with a null value.

variant: GmosImagingVariantInput | None¶

class gpp_client.generated.input_types.GmosNorthLongSlitAcquisitionInput(*, explicitFilter: GmosNorthFilter | None = None, explicitRoi: GmosLongSlitAcquisitionRoi | None = None, exposureTimeMode: ExposureTimeModeInput | None = None)[source]¶

Bases: BaseModel

Parameters that override acquisition defaults. These are optional and may be specified to change the default behavior of the acquisition sequence.

explicit_filter: GmosNorthFilter | None¶: An explicit acquisition filter to use instead of the default. The explicitFilter may be unset by assigning a null value, or ignored by skipping it altogether. If not provided, the filter that will be used for the acquisition sequence is the broadband filter closest to the central wavelength.

explicit_roi: GmosLongSlitAcquisitionRoi | None¶: An explicit acquisition ROI mode to use instead of the default. The explicitRoi may be unset by assigning a null value, or ignored by skipping it altogether. If not provided, the ROI(s) that will be used for the acquisition sequence will depend on the science ROI.

exposure_time_mode: ExposureTimeModeInput | None¶: Exposure time mode for the acquisition sequence. If not specified, a default exposure time mode is used.

class gpp_client.generated.input_types.GmosNorthLongSlitInput(*, grating: GmosNorthGrating | None = None, filter: GmosNorthFilter | None = None, fpu: GmosNorthBuiltinFpu | None = None, centralWavelength: WavelengthInput | None = None, exposureTimeMode: ExposureTimeModeInput | None = None, explicitXBin: GmosBinning | None = None, explicitYBin: GmosBinning | None = None, explicitAmpReadMode: GmosAmpReadMode | None = None, explicitAmpGain: GmosAmpGain | None = None, explicitRoi: GmosRoi | None = None, explicitWavelengthDithers: list[WavelengthDitherInput] | None = None, explicitOffsets: list[OffsetComponentInput] | None = None, explicitSpatialOffsets: list[OffsetComponentInput] | None = None, acquisition: GmosNorthLongSlitAcquisitionInput | None = None)[source]¶

Bases: BaseModel

Edit or create GMOS North Long Slit advanced configuration

acquisition: GmosNorthLongSlitAcquisitionInput | None¶: Parameters that override acquisition defaults.

central_wavelength: WavelengthInput | None¶: The centralWavelength field must be either specified or skipped altogether. It cannot be unset with a null value.

explicit_amp_gain: GmosAmpGain | None¶: The explicitAmpGain field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_amp_read_mode: GmosAmpReadMode | None¶: The explicitAmpReadMode field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_offsets: list[OffsetComponentInput] | None¶: The explicitOffsets field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_roi: GmosRoi | None¶: The explicitRoi field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_spatial_offsets: list[OffsetComponentInput] | None¶: The explicitSpatialOffsets field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_wavelength_dithers: list[WavelengthDitherInput] | None¶: The explicitWavelengthDithers field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_x_bin: GmosBinning | None¶: The explicitXBin field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_y_bin: GmosBinning | None¶: The explicitYBin field may be unset by assigning a null value, or ignored by skipping it altogether

exposure_time_mode: ExposureTimeModeInput | None¶: Exposure time mode for the science sequence. If not specified, the exposure time mode of the observation’s science requirements are used.

filter_: GmosNorthFilter | None¶: The filter field may be unset by assigning a null value, or ignored by skipping it altogether

fpu: GmosNorthBuiltinFpu | None¶: The fpu field must be either specified or skipped altogether. It cannot be unset with a null value.

grating: GmosNorthGrating | None¶: The grating field must be either specified or skipped altogether. It cannot be unset with a null value.

class gpp_client.generated.input_types.GmosNorthStaticInput(*, stageMode: GmosNorthStageMode | None = None, detector: GmosNorthDetector | None = None, mosPreImaging: MosPreImaging | None = None, nodAndShuffle: GmosNodAndShuffleInput | None = None)[source]¶

Bases: BaseModel

GMOS North static configuration input parameters

detector: GmosNorthDetector | None¶: GMOS North Detector option (defaults to HAMAMATSU)

mos_pre_imaging: MosPreImaging | None¶: Whether this is a MOS pre-imaging observation (defaults to IS_NOT_MOS_PRE_IMAGING)

nod_and_shuffle: GmosNodAndShuffleInput | None¶

Currently not used or stored.

Type:: GMOS Nod And Shuffle configuration. Warning

stage_mode: GmosNorthStageMode | None¶: GMOS North Stage Mode (default to FOLLOW_XY)

class gpp_client.generated.input_types.GmosNorthStepInput(*, instrumentConfig: GmosNorthDynamicInput, breakpoint: Breakpoint | None = None, stepConfig: StepConfigInput, telescopeConfig: TelescopeConfigInput | None = None, observeClass: ObserveClass)[source]¶

Bases: BaseModel

breakpoint: Breakpoint | None¶

instrument_config: GmosNorthDynamicInput¶

observe_class: ObserveClass¶

step_config: StepConfigInput¶

telescope_config: TelescopeConfigInput | None¶

class gpp_client.generated.input_types.GmosPreImagingVariantInput(*, offset1: OffsetInput | None = None, offset2: OffsetInput | None = None, offset3: OffsetInput | None = None, offset4: OffsetInput | None = None)[source]¶

Bases: BaseModel

MOS pre-imaging offsets, each of which default to (0, 0).

offset_1: OffsetInput | None¶

offset_2: OffsetInput | None¶

offset_3: OffsetInput | None¶

offset_4: OffsetInput | None¶

class gpp_client.generated.input_types.GmosSouthAtomInput(*, description: Any | None = None, steps: list[GmosSouthStepInput])[source]¶

Bases: BaseModel

description: Any | None¶

steps: list[GmosSouthStepInput]¶

class gpp_client.generated.input_types.GmosSouthDynamicInput(*, exposure: TimeSpanInput, readout: GmosCcdModeInput, dtax: GmosDtax, roi: GmosRoi, gratingConfig: GmosSouthGratingConfigInput | None = None, filter: GmosSouthFilter | None = None, fpu: GmosSouthFpuInput | None = None)[source]¶

Bases: BaseModel

GMOS South instrument configuration input

dtax: GmosDtax¶: GMOS detector x offset

exposure: TimeSpanInput¶: Exposure time

filter_: GmosSouthFilter | None¶: GMOS South filter

fpu: GmosSouthFpuInput | None¶: GMOS South FPU

grating_config: GmosSouthGratingConfigInput | None¶: GMOS South grating

readout: GmosCcdModeInput¶: GMOS CCD readout

roi: GmosRoi¶: GMOS region of interest

class gpp_client.generated.input_types.GmosSouthFpuInput(*, customMask: GmosCustomMaskInput | None = None, builtin: GmosSouthBuiltinFpu | None = None)[source]¶

Bases: BaseModel

GMOS South FPU input parameters (choose custom or builtin).

builtin: GmosSouthBuiltinFpu | None¶: Builtin FPU option

custom_mask: GmosCustomMaskInput | None¶: Custom mask FPU option

class gpp_client.generated.input_types.GmosSouthGratingConfigInput(*, grating: GmosSouthGrating, order: GmosGratingOrder, wavelength: WavelengthInput)[source]¶

Bases: BaseModel

GMOS South grating input parameters

grating: GmosSouthGrating¶: GmosGmosSouth grating

order: GmosGratingOrder¶: GMOS grating order

wavelength: WavelengthInput¶: Grating wavelength

class gpp_client.generated.input_types.GmosSouthImagingFilterInput(*, filter: GmosSouthFilter, exposureTimeMode: ExposureTimeModeInput | None = None)[source]¶

Bases: BaseModel

Defines the GMOS South filter to use along with its exposure time mode. If the exposure time mode is not specified, it is taken from the observation’s requirements.

exposure_time_mode: ExposureTimeModeInput | None¶

filter_: GmosSouthFilter¶

class gpp_client.generated.input_types.GmosSouthImagingInput(*, variant: GmosImagingVariantInput | None = None, filters: list[GmosSouthImagingFilterInput] | None = None, explicitBin: GmosBinning | None = None, explicitAmpReadMode: GmosAmpReadMode | None = None, explicitAmpGain: GmosAmpGain | None = None, explicitRoi: GmosRoi | None = None)[source]¶

Bases: BaseModel

Edit or create GMOS South Imaging advanced configuration

explicit_amp_gain: GmosAmpGain | None¶: The explicitAmpGain field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_amp_read_mode: GmosAmpReadMode | None¶: The explicitAmpReadMode field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_bin: GmosBinning | None¶: The explicitBin field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_roi: GmosRoi | None¶: The explicitRoi field may be unset by assigning a null value, or ignored by skipping it altogether

filters: list[GmosSouthImagingFilterInput] | None¶: The filters field must be specified with at least one filter. It cannot be unset with a null value.

variant: GmosImagingVariantInput | None¶

class gpp_client.generated.input_types.GmosSouthLongSlitAcquisitionInput(*, explicitFilter: GmosSouthFilter | None = None, explicitRoi: GmosLongSlitAcquisitionRoi | None = None, exposureTimeMode: ExposureTimeModeInput | None = None)[source]¶

Bases: BaseModel

Parameters that override acquisition defaults. These are optional and may be specified to change the default behavior of the acquisition sequence.

explicit_filter: GmosSouthFilter | None¶: An explicit acquisition filter to use instead of the default. The explicitFilter may be unset by assigning a null value, or ignored by skipping it altogether. If not provided, the filter that will be used for the acquisition sequence is the broadband filter closest to the central wavelength.

explicit_roi: GmosLongSlitAcquisitionRoi | None¶: An explicit acquisition ROI mode to use instead of the default. The explicitRoi may be unset by assigning a null value, or ignored by skipping it altogether. If not provided, the ROI(s) that will be used for the acquisition sequence will depend on the science ROI.

exposure_time_mode: ExposureTimeModeInput | None¶: Exposure time mode for the acquisition sequence. If not specified, a default exposure time mode is used.

class gpp_client.generated.input_types.GmosSouthLongSlitInput(*, grating: GmosSouthGrating | None = None, filter: GmosSouthFilter | None = None, fpu: GmosSouthBuiltinFpu | None = None, centralWavelength: WavelengthInput | None = None, exposureTimeMode: ExposureTimeModeInput | None = None, explicitXBin: GmosBinning | None = None, explicitYBin: GmosBinning | None = None, explicitAmpReadMode: GmosAmpReadMode | None = None, explicitAmpGain: GmosAmpGain | None = None, explicitRoi: GmosRoi | None = None, explicitWavelengthDithers: list[WavelengthDitherInput] | None = None, explicitOffsets: list[OffsetComponentInput] | None = None, explicitSpatialOffsets: list[OffsetComponentInput] | None = None, acquisition: GmosSouthLongSlitAcquisitionInput | None = None)[source]¶

Bases: BaseModel

Edit or create GMOS South Long Slit advanced configuration

acquisition: GmosSouthLongSlitAcquisitionInput | None¶: Parameters that override acquisition defaults.

central_wavelength: WavelengthInput | None¶: The centralWavelength field must be either specified or skipped altogether. It cannot be unset with a null value.

explicit_amp_gain: GmosAmpGain | None¶: The explicitAmpGain field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_amp_read_mode: GmosAmpReadMode | None¶: The explicitAmpReadMode field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_offsets: list[OffsetComponentInput] | None¶: The explicitOffsets field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_roi: GmosRoi | None¶: The explicitRoi field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_spatial_offsets: list[OffsetComponentInput] | None¶: The explicitSpatialOffsets field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_wavelength_dithers: list[WavelengthDitherInput] | None¶: The explicitWavelengthDithers field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_x_bin: GmosBinning | None¶: The explicitXBin field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_y_bin: GmosBinning | None¶: The explicitYBin field may be unset by assigning a null value, or ignored by skipping it altogether

exposure_time_mode: ExposureTimeModeInput | None¶: Exposure time mode for the science sequence. If not specified, the exposure time mode of the observation’s science requirements are used.

filter_: GmosSouthFilter | None¶: The filter field may be unset by assigning a null value, or ignored by skipping it altogether

fpu: GmosSouthBuiltinFpu | None¶: The fpu field must be either specified or skipped altogether. It cannot be unset with a null value.

grating: GmosSouthGrating | None¶: The grating field must be either specified or skipped altogether. It cannot be unset with a null value.

class gpp_client.generated.input_types.GmosSouthStaticInput(*, stageMode: GmosSouthStageMode | None = None, detector: GmosSouthDetector | None = None, mosPreImaging: MosPreImaging | None = None, nodAndShuffle: GmosNodAndShuffleInput | None = None)[source]¶

Bases: BaseModel

GMOS South static configuration input parameters

detector: GmosSouthDetector | None¶: GMOS South Detector option (defaults to HAMAMATSU)

mos_pre_imaging: MosPreImaging | None¶: Whether this is a MOS pre-imaging observation (defaults to IS_NOT_MOS_PRE_IMAGING)

nod_and_shuffle: GmosNodAndShuffleInput | None¶

currently not used or stored.

Type:: GMOS Nod And Shuffle configuration. Warning

stage_mode: GmosSouthStageMode | None¶: GMOS South Stage Mode (defaults to FOLLOW_XYZ)

class gpp_client.generated.input_types.GmosSouthStepInput(*, instrumentConfig: GmosSouthDynamicInput, breakpoint: Breakpoint | None = None, stepConfig: StepConfigInput, telescopeConfig: TelescopeConfigInput | None = None, observeClass: ObserveClass)[source]¶

Bases: BaseModel

breakpoint: Breakpoint | None¶

instrument_config: GmosSouthDynamicInput¶

observe_class: ObserveClass¶

step_config: StepConfigInput¶

telescope_config: TelescopeConfigInput | None¶

class gpp_client.generated.input_types.GoaPropertiesInput(*, proprietaryMonths: Any | None = None, shouldNotify: bool | None = None, privateHeader: bool | None = None)[source]¶

Bases: BaseModel

Gemini Observatory Archive properties creation and editing input for a particular program.

private_header: bool | None¶: Whether the header (as well as the data itself) should remain private. This property is applicable to science programs and defaults to false.

proprietary_months: Any | None¶: How many months to withhold public access to the data. This property is applicable to science programs, defaults to the proprietary period associated with the Call for Proposals if any; 0 months otherwise.

should_notify: bool | None¶: Whether the PI wishes to be notified when new data are received. This property is applicable to science programs and defaults to true.

class gpp_client.generated.input_types.GroupEditInput(*, groupId: Any | None = None, programId: Any | None = None)[source]¶

Bases: BaseModel

group_id: Any | None¶: Group ID, or Null to watch top-level group(s), or omit to watch all groups.

program_id: Any | None¶: Program ID

class gpp_client.generated.input_types.GroupElementInput(*, groupId: Any | None = None, observationId: Any | None = None)[source]¶

Bases: BaseModel

A group element identifier. Exactly one of groupId and observationId must be provided.

group_id: Any | None¶

observation_id: Any | None¶

Bases: BaseModel

description: Any | None¶: Group description (optional).

existence: Existence | None¶: Existence. Defaults to ‘present’ on creation. Change this value to delete a group (must be empty).

maximum_interval: TimeSpanInput | None¶: If specified, elements will be separated by at most maximumInterval.

minimum_interval: TimeSpanInput | None¶: If specified, elements will be separated by at least minimumInterval.

minimum_required: Any | None¶: Minimum number of elements to be observed. If unspecified then all elements will be observed.

name: Any | None¶: Group name (optional).

ordered: bool | None¶: If true, elements will be observed in order. Defaults to false if left unspecified.

parent_group: Any | None¶: Parent group (optional). If specified then parent index must also be specified.

parent_group_index: Any | None¶: Parent index. If unspecified then the element will appear first in the program or parent group (if specified). Cannot be set to null.

same_night: bool | None¶: If true, all observations in this group must be scheduled on the same night. Mutually exclusive with maximumInterval. Only valid for AND groups.

class gpp_client.generated.input_types.HourAngleRangeInput(*, minHours: Any | None = None, maxHours: Any | None = None)[source]¶

Bases: BaseModel

Hour angle range creation parameters

max_hours: Any | None¶

min_hours: Any | None¶

class gpp_client.generated.input_types.Igrins2AtomInput(*, description: Any | None = None, steps: list[Igrins2StepInput])[source]¶

Bases: BaseModel

description: Any | None¶

steps: list[Igrins2StepInput]¶

class gpp_client.generated.input_types.Igrins2DynamicInput(*, exposure: TimeSpanInput)[source]¶

Bases: BaseModel

exposure: TimeSpanInput¶

class gpp_client.generated.input_types.Igrins2LongSlitInput(*, exposureTimeMode: ExposureTimeModeInput | None = None, explicitOffsetMode: Igrins2OffsetMode | None = None, explicitSaveSVCImages: bool | None = None, explicitOffsets: list[OffsetInput] | None = None, telluricType: TelluricTypeInput | None = None)[source]¶

Bases: BaseModel

Edit or create IGRINS-2 Long Slit configuration

explicit_offset_mode: Igrins2OffsetMode | None¶: The offset mode field may be unset by assigning a null value, or ignored by skipping it altogether

explicit_offsets: list[OffsetInput] | None¶: Spatial offsets. May be unset by assigning null, or ignored by skipping. For NodAlongSlit mode, all offsets must have P = 0.

explicit_save_svc_images: bool | None¶: The save SVC images field may be unset by assigning a null value, or ignored by skipping it altogether

exposure_time_mode: ExposureTimeModeInput | None¶: The exposureTimeMode field may be unset by assigning a null value, or ignored by skipping it altogether

telluric_type: TelluricTypeInput | None¶: The telluricType field must be either specified or skipped altogether. It cannot be unset with a null value. On create the default is HOT.

class gpp_client.generated.input_types.Igrins2StaticInput(*, saveSVCImages: bool | None = None, offsetMode: Igrins2OffsetMode | None = None)[source]¶

Bases: BaseModel

IGRINS-2 static configuration input parameters

offset_mode: Igrins2OffsetMode | None¶: Offset mode (defaults to NOD_ALONG_SLIT)

save_svc_images: bool | None¶: Whether to save SVC images (defaults to false)

class gpp_client.generated.input_types.Igrins2StepInput(*, instrumentConfig: Igrins2DynamicInput, breakpoint: Breakpoint | None = None, stepConfig: StepConfigInput, telescopeConfig: TelescopeConfigInput | None = None, observeClass: ObserveClass)[source]¶

Bases: BaseModel

breakpoint: Breakpoint | None¶

instrument_config: Igrins2DynamicInput¶

observe_class: ObserveClass¶

step_config: StepConfigInput¶

telescope_config: TelescopeConfigInput | None¶

class gpp_client.generated.input_types.ImagingScienceRequirementsInput(*, minimumFov: AngleInput | None = None, narrowFilters: bool | None = None, broadFilters: bool | None = None, combinedFilters: bool | None = None)[source]¶

Bases: BaseModel

Edit or create imaging science requirements

broad_filters: bool | None¶: broadFilters, which may be unset by assigning a null value, or ignored by skipping it altogether.

combined_filters: bool | None¶: combinedFilters, which may be unset by assigning a null value, or ignored by skipping it altogether.

minimum_fov: AngleInput | None¶: minimumFov, which may be unset by assigning a null value, or ignored by skipping it altogether.

narrow_filters: bool | None¶: narrowFilters, which may be unset by assigning a null value, or ignored by skipping it altogether.

class gpp_client.generated.input_types.LargeProgramInput(*, toOActivation: ToOActivation | None = None, minPercentTime: Any | None = None, minPercentTotalTime: Any | None = None, totalTime: TimeSpanInput | None = None, aeonMultiFacility: bool | None = None, jwstSynergy: bool | None = None)[source]¶

Bases: BaseModel

aeon_multi_facility: bool | None¶: Whether this proposal is part of the AEON/Multi-facility program.

jwst_synergy: bool | None¶: Whether this proposal has JWST synergy.

min_percent_time: Any | None¶: The minimum percentage of time required (first semester) to consider this proposal a success. If not set, 100% is assumed.

min_percent_total_time: Any | None¶: The minimum percentage of time required over the lifetime of the program to consider this proposal a success. If not set, 100% is assumed.

to_o_activation: ToOActivation | None¶: The toOActivation field is optional. If not specified when creating a proposal, it defaults to `NONE’.

total_time: TimeSpanInput | None¶: The total time requested over the lifetime of the program. If not set, zero hours are assumed.

class gpp_client.generated.input_types.LineFluxIntegratedInput(*, value: Any, units: LineFluxIntegratedUnits)[source]¶

Bases: BaseModel

A line flux value with integrated units

units: LineFluxIntegratedUnits¶

value: Any¶

class gpp_client.generated.input_types.LineFluxSurfaceInput(*, value: Any, units: LineFluxSurfaceUnits)[source]¶

Bases: BaseModel

A line flux value with surface units

units: LineFluxSurfaceUnits¶

value: Any¶

class gpp_client.generated.input_types.LinkUserInput(*, programUserId: Any, userId: Any)[source]¶

Bases: BaseModel

Links a ‘User’ with a ‘Program’, filling in the ‘user’ field of the corresponding ‘ProgramUser’.

program_user_id: Any¶: The program user that will reference the user.

user_id: Any¶: The user to be linked.

class gpp_client.generated.input_types.NonsiderealInput(*, keyType: EphemerisKeyType | None = None, des: Any | None = None, key: Any | None = None, ephemeris: UserSuppliedEphemeris | None = None)[source]¶

Bases: BaseModel

Nonsidereal target parameters. For the key, if specified, provide either (keyType and des) or key.

des: Any | None¶: The des field must be either specified or skipped altogether. It cannot be unset with a null value.

ephemeris: UserSuppliedEphemeris | None¶: Ephemeris must be specified if (and only if) the key type is USER_SUPPLIED.

key: Any | None¶: The key field must be either specified or skipped altogether. It cannot be unset with a null value.

key_type: EphemerisKeyType | None¶: The keyType field must be either specified or skipped altogether. It cannot be unset with a null value.

class gpp_client.generated.input_types.ObscalcUpdateInput(*, programId: Any | None = None, observationId: Any | None = None, oldCalculationState: WhereOptionEqCalculationState | None = None, oldState: WhereOptionEqCalculationState | None = None, newCalculationState: WhereOptionEqCalculationState | None = None, newState: WhereOptionEqCalculationState | None = None, executableOnly: bool | None = False)[source]¶

Bases: BaseModel

Input to the obscalcUpdate subscription. Specify programId and/or observation id to filter events to that program and/or observation. Specify the old and new states to limit events to only those transitions.

executable_only: bool | None¶: When set to true, events will be limited to those that impact executable observations only. Changes to observations that are not yet READY or ONGOING, or which have already completed, will not trigger events.

new_calculation_state: WhereOptionEqCalculationState | None¶

new_state: WhereOptionEqCalculationState | None¶

observation_id: Any | None¶

old_calculation_state: WhereOptionEqCalculationState | None¶

old_state: WhereOptionEqCalculationState | None¶

program_id: Any | None¶

class gpp_client.generated.input_types.ObservationEditInput(*, observationId: Any | None = None, programId: Any | None = None)[source]¶

Bases: BaseModel

observation_id: Any | None¶

program_id: Any | None¶

class gpp_client.generated.input_types.ObservationPropertiesInput(*, subtitle: Any | None = None, scienceBand: ScienceBand | None = None, posAngleConstraint: PosAngleConstraintInput | None = None, targetEnvironment: TargetEnvironmentInput | None = None, constraintSet: ConstraintSetInput | None = None, timingWindows: list[TimingWindowInput] | None = None, attachments: list[Any] | None = None, scienceRequirements: ScienceRequirementsInput | None = None, observingMode: ObservingModeInput | None = None, existence: Existence | None = None, groupId: Any | None = None, groupIndex: Any | None = None, observerNotes: Any | None = None)[source]¶

Bases: BaseModel

Observation properties

attachments: list[Any] | None¶: The attachments defaults to empty if not specified on creation, and may be edited by specifying a new whole array

constraint_set: ConstraintSetInput | None¶: The constraintSet defaults to standard values if not specified on creation, and may be edited but not deleted

existence: Existence | None¶: Whether the observation is considered deleted (defaults to PRESENT) but may be edited

group_id: Any | None¶: Enclosing group, if any.

group_index: Any | None¶: Index in enclosing group or at the top level if ungrouped. If left unspecified on creation, observation will be added last in its enclosing group or at the top level. Cannot be set to null.

observer_notes: Any | None¶: Set the notes for thhe observer

observing_mode: ObservingModeInput | None¶: The observingMode describes the chosen observing mode and instrument, is optional and may be deleted

pos_angle_constraint: PosAngleConstraintInput | None¶: Position angle constraint, if any. Set to null to remove all position angle constraints

science_band: ScienceBand | None¶: The science band to assign to this observation. Set to null to remove the science band.

science_requirements: ScienceRequirementsInput | None¶: The scienceRequirements defaults to spectroscopy if not specified on creation, and may be edited but not deleted

subtitle: Any | None¶: Subtitle adds additional detail to the target-based observation title, and is both optional and nullable

target_environment: TargetEnvironmentInput | None¶: The targetEnvironment defaults to empty if not specified on creation, and may be edited but not deleted

timing_windows: list[TimingWindowInput] | None¶: The timingWindows defaults to empty if not specified on creation, and may be edited by specifying a new whole array

class gpp_client.generated.input_types.ObservationTimesInput(*, observationTime: Any | None = None, observationDuration: TimeSpanInput | None = None)[source]¶

Bases: BaseModel

Observation times properties

observation_duration: TimeSpanInput | None¶: Expected observation duration used in conjunction with observationTime. If not set, remaining observation time is used.

observation_time: Any | None¶: Expected execution time used for time-dependent calculations such as average parallactic angle and guide star selection.

class gpp_client.generated.input_types.ObservingModeInput(*, flamingos2LongSlit: Flamingos2LongSlitInput | None = None, ghostIfu: GhostIfuInput | None = None, gmosNorthImaging: GmosNorthImagingInput | None = None, gmosNorthLongSlit: GmosNorthLongSlitInput | None = None, gmosSouthImaging: GmosSouthImagingInput | None = None, gmosSouthLongSlit: GmosSouthLongSlitInput | None = None, igrins2LongSlit: Igrins2LongSlitInput | None = None, visitor: VisitorInput | None = None)[source]¶

Bases: BaseModel

Edit or create an observation’s observing mode

flamingos_2_long_slit: Flamingos2LongSlitInput | None¶: The flamingos2LongSlit field must be either specified or skipped altogether. It cannot be unset with a null value.

ghost_ifu: GhostIfuInput | None¶: The ghostIfu field must be either specified or skipped altogether. It cannot be unset with a null value.

gmos_north_imaging: GmosNorthImagingInput | None¶: The gmosNorthImaging field must be either specified or skipped altogether. It cannot be unset with a null value.

gmos_north_long_slit: GmosNorthLongSlitInput | None¶: The gmosNorthLongSlit field must be either specified or skipped altogether. It cannot be unset with a null value.

gmos_south_imaging: GmosSouthImagingInput | None¶: The gmosSouthImaging field must be either specified or skipped altogether. It cannot be unset with a null value.

gmos_south_long_slit: GmosSouthLongSlitInput | None¶: The gmosSouthLongSlit field must be either specified or skipped altogether. It cannot be unset with a null value.

igrins_2_long_slit: Igrins2LongSlitInput | None¶: The igrins2LongSlit field must be either specified or skipped altogether. It cannot be unset with a null value.

visitor: VisitorInput | None¶: A visiting instrument mode. It cannot be unset with a null value.

class gpp_client.generated.input_types.OffsetComponentInput(*, microarcseconds: Any | None = None, milliarcseconds: Any | None = None, arcseconds: Any | None = None)[source]¶

Bases: BaseModel

Offset component (p or q) input parameters. Choose one angle units definition.

arcseconds: Any | None¶: Angle in arcsec

microarcseconds: Any | None¶: Angle in µas

milliarcseconds: Any | None¶: Angle in mas

class gpp_client.generated.input_types.OffsetInput(*, p: OffsetComponentInput, q: OffsetComponentInput)[source]¶

Bases: BaseModel

Offset input. Define offset in p and q.

p: OffsetComponentInput¶: Offset in p

q: OffsetComponentInput¶: Offset in q

class gpp_client.generated.input_types.OpportunityInput(*, region: RegionInput)[source]¶

Bases: BaseModel

region: RegionInput¶

class gpp_client.generated.input_types.ParallaxInput(*, microarcseconds: Any | None = None, milliarcseconds: Any | None = None)[source]¶

Bases: BaseModel

Parallax, choose one of the available units

microarcseconds: Any | None¶

milliarcseconds: Any | None¶

class gpp_client.generated.input_types.PartnerLinkInput(*, linkType: PartnerLinkType | None = None, partner: Partner | None = None)[source]¶

Bases: BaseModel

Describes the user / partner association. Only one of partner or linkType should be specified, but as long as they are consistent both may be supplied.

link_type: PartnerLinkType | None¶: Describes the state of the association between a user and a partner. The link type is assumed to be HAS_PARTNER if the partner is specified. Otherwise, if partner is null, the link type is required.

partner: Partner | None¶: If the user should be associated with a particular partner, it is specified here. Only set partner or linkType, but not both.

class gpp_client.generated.input_types.PartnerSplitInput(*, partner: Partner, percent: Any)[source]¶

Bases: BaseModel

Time request percentage that should be associated with a particular partner for Queue and Classical proposals.

partner: Partner¶

percent: Any¶: Percentage of requested time that should be associated with the partner.

class gpp_client.generated.input_types.PoorWeatherInput(*, ignore: Ignore | None = None)[source]¶

Bases: BaseModel

Input for a poor weather proposal. There are no fields to further specify a poor weather proposal but GraphQL requires at least one field. Therefore this input includes a single optional ‘ignore’ field which need not be set.

ignore: Ignore | None¶: This field is not intended to be used (and may be left unset), but is required by the GraphQL specification.

class gpp_client.generated.input_types.PosAngleConstraintInput(*, mode: PosAngleConstraintMode | None = None, angle: AngleInput | None = None)[source]¶

Bases: BaseModel

Create or edit position angle constraint. If not specified, then the position angle required to reach the best guide star option will be used.

angle: AngleInput | None¶: The fixed position angle that is used when the mode is FIXED, ALLOW_FLIP or PARALLACTIC_OVERRIDE. Set but ignored when UNBOUNDED or AVERAGE_PARALLACTIC.

mode: PosAngleConstraintMode | None¶: The constraint mode field determines whether the angle field is respected or ignored.

class gpp_client.generated.input_types.ProgramEditInput(*, programId: Any | None = None)[source]¶

Bases: BaseModel

program_id: Any | None¶

class gpp_client.generated.input_types.ProgramNotePropertiesInput(*, title: Any | None = None, text: Any | None = None, isPrivate: bool | None = None, existence: Existence | None = None)[source]¶

Bases: BaseModel

ProgramNote creation and edit properties.

existence: Existence | None¶: Whether the program is considered deleted (defaults to PRESENT).

is_private: bool | None¶: Whether the note is only available to Gemini staff. This property is available only to Gemini staff and defaults to false.

text: Any | None¶: The note text, if any.

title: Any | None¶: The note title. Required on creation.

Bases: BaseModel

Program properties

active_end: Any | None¶

Active period end date (exclusive) for this program. The date is considered to be the local date at each observation site. Observations may end the morning of the indicated date at the site of the observation.

This property is avaliable only to those with staff access or better. Not nullable. Limited to dates between 1900 and 2100 (exclusive).

active_start: Any | None¶

Active period start date (inclusive) for this program. The date is considered to be the local date at each observation site. Observations may begin the evening of the indicated date at the site of the observation.

This property is avaliable only to those with staff access or better. Not nullable. Limited to dates between 1900 and 2100 (exclusive).

description: Any | None¶: The program description / abstract, which is both optional and nullable.

existence: Existence | None¶: Whether the program is considered deleted (defaults to PRESENT) but may be edited

goa: GoaPropertiesInput | None¶: Sets the GOA properties for this program. If not specified on create, default values are used.

name: Any | None¶: The program name / title, which is both optional and nullable.

class gpp_client.generated.input_types.ProgramReferencePropertiesCalibrationInput(*, semester: Any, instrument: Instrument)[source]¶

Bases: BaseModel

Inputs required when updating or switching to a calibration program.

instrument: Instrument¶

semester: Any¶

class gpp_client.generated.input_types.ProgramReferencePropertiesCommissioningInput(*, semester: Any, instrument: Instrument)[source]¶

Bases: BaseModel

Inputs required when updating or switching to a commissioning program.

instrument: Instrument¶

semester: Any¶

class gpp_client.generated.input_types.ProgramReferencePropertiesEngineeringInput(*, semester: Any, instrument: Instrument)[source]¶

Bases: BaseModel

Inputs required when updating or switching to an engineering program.

instrument: Instrument¶

semester: Any¶

class gpp_client.generated.input_types.ProgramReferencePropertiesExampleInput(*, instrument: Instrument)[source]¶

Bases: BaseModel

Inputs required when updating or switching to an example program.

instrument: Instrument¶

Bases: BaseModel

Properties for the chosen program reference type. Supply the value for exactly one of the inputs.

calibration: ProgramReferencePropertiesCalibrationInput | None¶

commissioning: ProgramReferencePropertiesCommissioningInput | None¶

engineering: ProgramReferencePropertiesEngineeringInput | None¶

example: ProgramReferencePropertiesExampleInput | None¶

library: ProgramReferencePropertiesLibraryInput | None¶

monitoring: ProgramReferencePropertiesMonitoringInput | None¶

science: ProgramReferencePropertiesScienceInput | None¶

system: ProgramReferencePropertiesSystemInput | None¶

class gpp_client.generated.input_types.ProgramReferencePropertiesLibraryInput(*, instrument: Instrument, description: Any)[source]¶

Bases: BaseModel

Inputs required when updating or switching to a library program.

description: Any¶

instrument: Instrument¶

class gpp_client.generated.input_types.ProgramReferencePropertiesMonitoringInput(*, semester: Any, instrument: Instrument)[source]¶

Bases: BaseModel

Inputs required when updating or switching to a monitoring program.

instrument: Instrument¶

semester: Any¶

class gpp_client.generated.input_types.ProgramReferencePropertiesScienceInput(*, semester: Any, scienceSubtype: ScienceSubtype)[source]¶

Bases: BaseModel

Inputs required when updating or switching to a science program.

science_subtype: ScienceSubtype¶

semester: Any¶

class gpp_client.generated.input_types.ProgramReferencePropertiesSystemInput(*, description: Any)[source]¶

Bases: BaseModel

Inputs required when updating or switching to a system program.

description: Any¶

class gpp_client.generated.input_types.ProgramUserPropertiesInput(*, partnerLink: PartnerLinkInput | None = None, preferredProfile: UserProfileInput | None = None, educationalStatus: EducationalStatus | None = None, thesis: bool | None = None, gender: Gender | None = None, affiliation: Any | None = None, hasDataAccess: bool | None = None)[source]¶

Bases: BaseModel

Editable properties that define a program / user connection.

affiliation: Any | None¶: Investigator affiliation.

educational_status: EducationalStatus | None¶: The user’s educational status.

gender: Gender | None¶: The user’s reported gender.

has_data_access: bool | None¶: Whether the user has data access. This property may be changed only by the PI (or staff). If a COI attempts to change the data access flag, the entire update is ignored.

partner_link: PartnerLinkInput | None¶: The user’s partner.

preferred_profile: UserProfileInput | None¶: The preferred profile overrides any values that may be in the Orcid profile (user.profile).

thesis: bool | None¶: Is a thesis included in the proposal.

class gpp_client.generated.input_types.ProperMotionComponentInput(*, microarcsecondsPerYear: Any | None = None, milliarcsecondsPerYear: Any | None = None)[source]¶

Bases: BaseModel

Proper motion component, choose one of the available units

microarcseconds_per_year: Any | None¶

milliarcseconds_per_year: Any | None¶

class gpp_client.generated.input_types.ProperMotionInput(*, ra: ProperMotionComponentInput, dec: ProperMotionComponentInput)[source]¶

Bases: BaseModel

Proper motion, choose one of the available units

dec: ProperMotionComponentInput¶

ra: ProperMotionComponentInput¶

class gpp_client.generated.input_types.ProposalPropertiesInput(*, category: TacCategory | None = None, callId: Any | None = None, type: ProposalTypeInput | None = None)[source]¶

Bases: BaseModel

Program proposal

call_id: Any | None¶: Sets the associated Call for Proposals. This is optional upon creation, but must be set for a successful submission. Also, the Call for Proposals type must agree with the proposal type (see ‘type’ below). For example a Queue proposal must be submitted to a Regular Semester Call and a Demo Science proposal must be submitted to a Demo Science Call, etc.

category: TacCategory | None¶: The category field may be unset by assigning a null value, or ignored by skipping it altogether

type_: ProposalTypeInput | None¶: Specifies the properties that depend on the call type. If not set on creation, a regular semester queue proposal is assumed. The selected call properties must match the call (see ‘callId’ above) or a submission attempt will fail with an error. Call properties can be edited, but when switching the call type itself, all properties required for that type must be included.

class gpp_client.generated.input_types.ProposalTypeInput(*, classical: ClassicalInput | None = None, demoScience: DemoScienceInput | None = None, directorsTime: DirectorsTimeInput | None = None, fastTurnaround: FastTurnaroundInput | None = None, largeProgram: LargeProgramInput | None = None, poorWeather: PoorWeatherInput | None = None, queue: QueueInput | None = None, systemVerification: SystemVerificationInput | None = None)[source]¶

Bases: BaseModel

Properties associated with particular proposal types. Exactly one of these should be set upon creation or editing.

classical: ClassicalInput | None¶

demo_science: DemoScienceInput | None¶

directors_time: DirectorsTimeInput | None¶

fast_turnaround: FastTurnaroundInput | None¶

large_program: LargeProgramInput | None¶

poor_weather: PoorWeatherInput | None¶

queue: QueueInput | None¶

system_verification: SystemVerificationInput | None¶

class gpp_client.generated.input_types.QueueInput(*, toOActivation: ToOActivation | None = None, minPercentTime: Any | None = None, partnerSplits: list[PartnerSplitInput] | None = None, considerForBand3: ConsiderForBand3 | None = None, aeonMultiFacility: bool | None = None, jwstSynergy: bool | None = None, usLongTerm: bool | None = None)[source]¶

Bases: BaseModel

aeon_multi_facility: bool | None¶: Whether this proposal is part of the AEON/Multi-facility program.

consider_for_band_3: ConsiderForBand3 | None¶: Whether this proposal should be considered for Band 3. Defaults to UNSET on creation; must be CONSIDER or DO_NOT_CONSIDER before the proposal can be submitted.

jwst_synergy: bool | None¶: Whether this proposal has JWST synergy.

min_percent_time: Any | None¶: The minimum percentage of time required to consider this proposal a success. If not set, 100% is assumed.

partner_splits: list[PartnerSplitInput] | None¶: The partnerSplits field specifies how time is apportioned over partners. This will default to empty but if specified, the partner percents must sum to 100. By submission time, it must be specified.

to_o_activation: ToOActivation | None¶: The toOActivation field is optional. If not specified when creating a proposal, it defaults to `NONE’.

us_long_term: bool | None¶: Whether this is a US Long Term proposal.

class gpp_client.generated.input_types.RadialVelocityInput(*, centimetersPerSecond: Any | None = None, metersPerSecond: Any | None = None, kilometersPerSecond: Any | None = None)[source]¶

Bases: BaseModel

Radial velocity, choose one of the available units

centimeters_per_second: Any | None¶

kilometers_per_second: Any | None¶

meters_per_second: Any | None¶

class gpp_client.generated.input_types.RandomTelescopeConfigGeneratorInput(*, size: AngleInput, center: OffsetInput | None = None, seed: Any | None = None)[source]¶

Bases: BaseModel

center: OffsetInput | None¶: Center of the random pattern. Defaults to (0, 0).

seed: Any | None¶: Random generator seed, which will default to a random value if not specified.

size: AngleInput¶: Radius defining the circular area in which all offsets will be placed.

class gpp_client.generated.input_types.RecordDatasetInput(*, stepId: Any, visitId: Any, filename: Any, qaState: DatasetQaState | None = None, comment: Any | None = None, idempotencyKey: Any | None = None)[source]¶

Bases: BaseModel

Dataset creation parameters.

comment: Any | None¶: Dataset comment.

filename: Any¶: Dataset filename.

idempotency_key: Any | None¶: Idempotency key, if any. The IdempotencyKey may be provided by clients when the dataset is created and is used to enable problem-free retry in the case of failure.

qa_state: DatasetQaState | None¶: Dataset QA State.

step_id: Any¶: Corresponding Step id.

visit_id: Any¶: Visit associated with the dataset.

class gpp_client.generated.input_types.RecordFlamingos2VisitInput(*, observationId: Any, flamingos2: Flamingos2StaticInput, idempotencyKey: Any | None = None)[source]¶

Bases: BaseModel

Input parameters for creating a new Flamingos 2 Visit

flamingos_2: Flamingos2StaticInput¶

idempotency_key: Any | None¶: Idempotency key, if any. The IdempotencyKey may be provided by clients when the visit is created and is used to enable problem-free retry in the case of failure.

observation_id: Any¶

class gpp_client.generated.input_types.RecordGmosNorthVisitInput(*, observationId: Any, gmosNorth: GmosNorthStaticInput, idempotencyKey: Any | None = None)[source]¶

Bases: BaseModel

Input parameters for creating a new GmosNorthVisit

gmos_north: GmosNorthStaticInput¶

idempotency_key: Any | None¶: Idempotency key, if any. The IdempotencyKey may be provided by clients when the visit is created and is used to enable problem-free retry in the case of failure.

observation_id: Any¶

class gpp_client.generated.input_types.RecordGmosSouthVisitInput(*, observationId: Any, gmosSouth: GmosSouthStaticInput, idempotencyKey: Any | None = None)[source]¶

Bases: BaseModel

Input parameters for creating a new GmosSouthVisit

gmos_south: GmosSouthStaticInput¶

idempotency_key: Any | None¶: Idempotency key, if any. The IdempotencyKey may be provided by clients when the visit is created and is used to enable problem-free retry in the case of failure.

observation_id: Any¶

class gpp_client.generated.input_types.RecordIgrins2VisitInput(*, observationId: Any, igrins2: Igrins2StaticInput, idempotencyKey: Any | None = None)[source]¶

Bases: BaseModel

Input parameters for creating a new IGRINS-2 Visit

idempotency_key: Any | None¶: Idempotency key, if any. The IdempotencyKey may be provided by clients when the visit is created and is used to enable problem-free retry in the case of failure.

igrins_2: Igrins2StaticInput¶

observation_id: Any¶

class gpp_client.generated.input_types.RecordVisitInput(*, observationId: Any, idempotencyKey: Any | None = None)[source]¶

Bases: BaseModel

Input parameters for creating a new visit.

idempotency_key: Any | None¶: Idempotency key, if any. The IdempotencyKey may be provided by clients when the visit is created and is used to enable problem-free retry in the case of failure.

observation_id: Any¶

class gpp_client.generated.input_types.RedeemUserInvitationInput(*, key: Any, accept: bool | None = True)[source]¶

Bases: BaseModel

accept: bool | None¶: Pass false here to decline the invitation.

key: Any¶

class gpp_client.generated.input_types.RegionInput(*, rightAscensionArc: RightAscensionArcInput, declinationArc: DeclinationArcInput)[source]¶

Bases: BaseModel

declination_arc: DeclinationArcInput¶

right_ascension_arc: RightAscensionArcInput¶

class gpp_client.generated.input_types.ReplaceFlamingos2SequenceInput(*, observationId: Any | None = None, observationReference: Any | None = None, sequenceType: SequenceType, sequence: list[Flamingos2AtomInput] | None = None)[source]¶

Bases: BaseModel

Replace Flamingos 2 sequence input. Select the observation using one of the observation ID or the observation reference. If both are provided, they must refer to the same observation.

observation_id: Any | None¶

observation_reference: Any | None¶

sequence: list[Flamingos2AtomInput] | None¶: The new sequence. Any unexecuted steps are deleted and replaced with the provided sequence. Steps that were previously executed, or for which at least one execution event was received, are preserved.

sequence_type: SequenceType¶: Specifies which sequence should be replaced.

class gpp_client.generated.input_types.ReplaceGmosNorthSequenceInput(*, observationId: Any | None = None, observationReference: Any | None = None, sequenceType: SequenceType, sequence: list[GmosNorthAtomInput] | None = None)[source]¶

Bases: BaseModel

Replace GMOS North sequence input. Select the observation using one of the observation ID or the observation reference. If both are provided, they must refer to the same observation.

observation_id: Any | None¶

observation_reference: Any | None¶

sequence: list[GmosNorthAtomInput] | None¶: The new sequence. Any unexecuted steps are deleted and replaced with the provided sequence. Steps that were previously executed, or for which at least one execution event was received, are preserved.

sequence_type: SequenceType¶: Specifies which sequence should be replaced.

class gpp_client.generated.input_types.ReplaceGmosSouthSequenceInput(*, observationId: Any | None = None, observationReference: Any | None = None, sequenceType: SequenceType, sequence: list[GmosSouthAtomInput] | None = None)[source]¶

Bases: BaseModel

Replace GMOS South sequence input. Select the observation using one of the observation ID or the observation reference. If both are provided, they must refer to the same observation.

observation_id: Any | None¶

observation_reference: Any | None¶

sequence: list[GmosSouthAtomInput] | None¶: The new sequence. Any unexecuted steps are deleted and replaced with the provided sequence. Steps that were previously executed, or for which at least one execution event was received, are preserved.

sequence_type: SequenceType¶: Specifies which sequence should be replaced.

class gpp_client.generated.input_types.ReplaceIgrins2SequenceInput(*, observationId: Any | None = None, observationReference: Any | None = None, sequenceType: SequenceType, sequence: list[Igrins2AtomInput] | None = None)[source]¶

Bases: BaseModel

Replace IGRINS-2 sequence input. Select the observation using one of the observation ID or the observation reference. If both are provided, they must refer to the same observation.

observation_id: Any | None¶

observation_reference: Any | None¶

sequence: list[Igrins2AtomInput] | None¶: The new sequence. Any unexecuted steps are deleted and replaced with the provided sequence. Steps that were previously executed, or for which at least one execution event was received, are preserved.

sequence_type: SequenceType¶: Specifies which sequence should be replaced.

class gpp_client.generated.input_types.ResetAcquisitionInput(*, observationId: Any | None = None, observationReference: Any | None = None)[source]¶

Bases: BaseModel

Input parameters for resetting the acquisition sequence so that it executes from the initial step, regardless of which steps may have previously been executed. Select one of observationId or observationReference.

observation_id: Any | None¶

observation_reference: Any | None¶

class gpp_client.generated.input_types.RevokeUserInvitationInput(*, id: Any)[source]¶

Bases: BaseModel

id: Any¶

class gpp_client.generated.input_types.RightAscensionArcInput(*, type: ArcType, start: RightAscensionInput | None = None, end: RightAscensionInput | None = None)[source]¶

Bases: BaseModel

end: RightAscensionInput | None¶

start: RightAscensionInput | None¶

type_: ArcType¶

class gpp_client.generated.input_types.RightAscensionInput(*, microseconds: Any | None = None, degrees: Any | None = None, hours: Any | None = None, hms: Any | None = None)[source]¶

Bases: BaseModel

Right Ascension, choose one of the available units

degrees: Any | None¶

hms: Any | None¶

hours: Any | None¶

microseconds: Any | None¶

class gpp_client.generated.input_types.ScienceRequirementsInput(*, exposureTimeMode: ExposureTimeModeInput | None = None, spectroscopy: SpectroscopyScienceRequirementsInput | None = None, imaging: ImagingScienceRequirementsInput | None = None)[source]¶

Bases: BaseModel

Edit science requirements

exposure_time_mode: ExposureTimeModeInput | None¶: ExposureTimeMode, which may be unset by assigning a null value, or ignored by skipping it altogether.

imaging: ImagingScienceRequirementsInput | None¶: The imaging field must be either specified or skipped altogether. It cannot be unset with a null value.

spectroscopy: SpectroscopyScienceRequirementsInput | None¶: The spectroscopy field must be either specified or skipped altogether. It cannot be unset with a null value.

class gpp_client.generated.input_types.SetAllocationsInput(*, programId: Any | None = None, proposalReference: Any | None = None, programReference: Any | None = None, allocations: list[AllocationInput])[source]¶

Bases: BaseModel

Describes the program allocations. Each partner and band combination should appear at most once in the ‘allocations’ array. One of programId, programReference or proposalReference is required. (If two or more are provided, they must refer to the same program.)

allocations: list[AllocationInput]¶

program_id: Any | None¶

program_reference: Any | None¶

proposal_reference: Any | None¶

class gpp_client.generated.input_types.SetGuideTargetNameInput(*, observationId: Any | None = None, observationReference: Any | None = None, targetName: Any | None = None)[source]¶

Bases: BaseModel

Input parameters for setting the guide star name for an observation. Identify the observation to clone by specifying either its id or reference. If both are specified, they must refer to the same observation. If neither is specified, an error will be returned.

observation_id: Any | None¶

observation_reference: Any | None¶

target_name: Any | None¶: The name of the guide star. This must satisfy the regular expression “^Gaia DR3 (-?d+)$” where the numeric part is the Gaia source_id. Omit or set to null to delete.

class gpp_client.generated.input_types.SetObservationWorkflowStateInput(*, observationId: Any, state: ObservationWorkflowState)[source]¶

Bases: BaseModel

observation_id: Any¶

state: ObservationWorkflowState¶

class gpp_client.generated.input_types.SetProgramReferenceInput(*, programId: Any | None = None, proposalReference: Any | None = None, programReference: Any | None = None, SET: ProgramReferencePropertiesInput)[source]¶

Bases: BaseModel

Input for setting the program reference. Identify the program to update with one of programId, proposalReference or programReference. If more than one of these is specified, all must match. Use SET to specify the new program reference properties.

program_id: Any | None¶

program_reference: Any | None¶

proposal_reference: Any | None¶

set_: ProgramReferencePropertiesInput¶

class gpp_client.generated.input_types.SetProposalStatusInput(*, programId: Any | None = None, proposalReference: Any | None = None, programReference: Any | None = None, status: ProposalStatus)[source]¶

Bases: BaseModel

Input for setting the proposal status. Identify the program to update with one of programId, proposalReference or programReference. If more than one of these is specified, all must match.

program_id: Any | None¶

program_reference: Any | None¶

proposal_reference: Any | None¶

status: ProposalStatus¶

class gpp_client.generated.input_types.SiderealInput(*, ra: RightAscensionInput | None = None, dec: DeclinationInput | None = None, epoch: Any | None = None, properMotion: ProperMotionInput | None = None, radialVelocity: RadialVelocityInput | None = None, parallax: ParallaxInput | None = None, catalogInfo: CatalogInfoInput | None = None)[source]¶

Bases: BaseModel

Sidereal target edit parameters

catalog_info: CatalogInfoInput | None¶: The catalogInfo field may be unset by assigning a null value, or ignored by skipping it altogether

dec: DeclinationInput | None¶: The dec field must be either specified or skipped altogether. It cannot be unset with a null value.

epoch: Any | None¶: The epoch field must be either specified or skipped altogether. It cannot be unset with a null value.

parallax: ParallaxInput | None¶: The parallax field may be unset by assigning a null value, or ignored by skipping it altogether

proper_motion: ProperMotionInput | None¶: The properMotion field may be unset by assigning a null value, or ignored by skipping it altogether

ra: RightAscensionInput | None¶: The ra field must be either specified or skipped altogether. It cannot be unset with a null value.

radial_velocity: RadialVelocityInput | None¶: The radialVelocity field may be unset by assigning a null value, or ignored by skipping it altogether

class gpp_client.generated.input_types.SignalToNoiseExposureTimeModeInput(*, value: Any, at: WavelengthInput)[source]¶

Bases: BaseModel

Signal-to-noise mode parameters

at: WavelengthInput¶: Corresponding wavelength.

value: Any¶: s/n value

class gpp_client.generated.input_types.SiteCoordinateLimitsInput(*, north: CoordinateLimitsInput | None = None, south: CoordinateLimitsInput | None = None)[source]¶

Bases: BaseModel

Coordinate limits input per site.

north: CoordinateLimitsInput | None¶

south: CoordinateLimitsInput | None¶

class gpp_client.generated.input_types.SourceProfileInput(*, point: SpectralDefinitionIntegratedInput | None = None, uniform: SpectralDefinitionSurfaceInput | None = None, gaussian: GaussianInput | None = None)[source]¶

Bases: BaseModel

Create or edit a source profile. Exactly one of “point”, “uniform” or “gaussian” is required.

gaussian: GaussianInput | None¶

point: SpectralDefinitionIntegratedInput | None¶

uniform: SpectralDefinitionSurfaceInput | None¶

class gpp_client.generated.input_types.SpectralDefinitionIntegratedInput(*, bandNormalized: BandNormalizedIntegratedInput | None = None, emissionLines: EmissionLinesIntegratedInput | None = None)[source]¶

Bases: BaseModel

Spectral definition input with integrated units. Specify exactly one of “bandNormalized” or “emissionLines”

band_normalized: BandNormalizedIntegratedInput | None¶

emission_lines: EmissionLinesIntegratedInput | None¶

class gpp_client.generated.input_types.SpectralDefinitionSurfaceInput(*, bandNormalized: BandNormalizedSurfaceInput | None = None, emissionLines: EmissionLinesSurfaceInput | None = None)[source]¶

Bases: BaseModel

Spectral definition input with surface units. Specify exactly one of “bandNormalized” or “emissionLines”

band_normalized: BandNormalizedSurfaceInput | None¶

emission_lines: EmissionLinesSurfaceInput | None¶

class gpp_client.generated.input_types.SpectroscopyScienceRequirementsInput(*, wavelength: WavelengthInput | None = None, resolution: Any | None = None, wavelengthCoverage: WavelengthInput | None = None, focalPlane: FocalPlane | None = None, focalPlaneAngle: AngleInput | None = None, capability: SpectroscopyCapabilities | None = None)[source]¶

Bases: BaseModel

Edit or create spectroscopy science requirements

capability: SpectroscopyCapabilities | None¶: The capabilities field may be unset by assigning a null value, or ignored by skipping it altogether

focal_plane: FocalPlane | None¶: The focalPlane field may be unset by assigning a null value, or ignored by skipping it altogether

focal_plane_angle: AngleInput | None¶: The focalPlaneAngle field may be unset by assigning a null value, or ignored by skipping it altogether

resolution: Any | None¶: The resolution field may be unset by assigning a null value, or ignored by skipping it altogether

wavelength: WavelengthInput | None¶: The wavelength field may be unset by assigning a null value, or ignored by skipping it altogether

wavelength_coverage: WavelengthInput | None¶: The wavelengthCoverage field may be unset by assigning a null value, or ignored by skipping it altogether

class gpp_client.generated.input_types.SpiralTelescopeConfigGeneratorInput(*, size: AngleInput, center: OffsetInput | None = None, seed: Any | None = None)[source]¶

Bases: BaseModel

center: OffsetInput | None¶: Center of the spiral pattern. Defaults to (0, 0).

seed: Any | None¶: Random generator seed, which will default to a random value if not specified.

size: AngleInput¶: Radius defining the circular area in which all offsets will be placed.

class gpp_client.generated.input_types.StepConfigGcalInput(*, arcs: list[GcalArc] | None = None, continuum: GcalContinuum | None = None, diffuser: GcalDiffuser, filter: GcalFilter, shutter: GcalShutter)[source]¶

Bases: BaseModel

GCAL configuration creation input. Specify either one or more arcs or else one continuum.

arcs: list[GcalArc] | None¶

continuum: GcalContinuum | None¶

diffuser: GcalDiffuser¶

filter_: GcalFilter¶

shutter: GcalShutter¶

Bases: BaseModel

Step configuration. Choose exactly one step type.

bias: bool | None¶: Bias step creation option

dark: bool | None¶: Dark step creation option

gcal: StepConfigGcalInput | None¶: GCAL step creation option

science: bool | None¶: Science step creation option

smart_gcal: StepConfigSmartGcalInput | None¶: Smart gcal creation option

class gpp_client.generated.input_types.StepConfigSmartGcalInput(*, smartGcalType: SmartGcalType)[source]¶

Bases: BaseModel

SmartGcal step creation input

smart_gcal_type: SmartGcalType¶: Smart Gcal type

class gpp_client.generated.input_types.SystemVerificationInput(*, toOActivation: ToOActivation | None = None, minPercentTime: Any | None = None)[source]¶

Bases: BaseModel

min_percent_time: Any | None¶: The minimum percentage of time required to consider this proposal a success. If not set, 100% is assumed.

to_o_activation: ToOActivation | None¶: The toOActivation field is optional. If not specified when creating a proposal, it defaults to `NONE’.

class gpp_client.generated.input_types.TargetEditInput(*, targetId: Any | None = None, programId: Any | None = None)[source]¶

Bases: BaseModel

program_id: Any | None¶: Program ID

target_id: Any | None¶: Target ID

class gpp_client.generated.input_types.TargetEnvironmentInput(*, explicitBase: CoordinatesInput | None = None, asterism: list[Any] | None = None, useBlindOffset: bool | None = None, blindOffsetTarget: TargetPropertiesInput | None = None, blindOffsetType: BlindOffsetType | None = None)[source]¶

Bases: BaseModel

Target environment editing and creation parameters

asterism: list[Any] | None¶

blind_offset_target: TargetPropertiesInput | None¶: The target used for acquisition if a blind offset is needed.

blind_offset_type: BlindOffsetType | None¶: The type of blind offset (automatic or manual) if a blind offset exists. Default = Manual

explicit_base: CoordinatesInput | None¶: The explicitBase field may be unset by assigning a null value, or ignored by skipping it altogether

use_blind_offset: bool | None¶: Whether blind offset is enabled for this observation

class gpp_client.generated.input_types.TargetPropertiesInput(*, name: Any | None = None, sidereal: SiderealInput | None = None, nonsidereal: NonsiderealInput | None = None, opportunity: OpportunityInput | None = None, sourceProfile: SourceProfileInput | None = None, existence: Existence | None = None)[source]¶

Bases: BaseModel

Target properties

existence: Existence | None¶

name: Any | None¶

nonsidereal: NonsiderealInput | None¶

opportunity: OpportunityInput | None¶

sidereal: SiderealInput | None¶

source_profile: SourceProfileInput | None¶

class gpp_client.generated.input_types.TelescopeConfigGeneratorInput(*, enumerated: EnumeratedTelescopeConfigGeneratorInput | None = None, random: RandomTelescopeConfigGeneratorInput | None = None, spiral: SpiralTelescopeConfigGeneratorInput | None = None, uniform: UniformTelescopeConfigGeneratorInput | None = None)[source]¶

Bases: BaseModel

An offset generator is specified by defining one of the enumerated, random, spiral or uniform options. If none are defined, the generator type will be NONE.

enumerated: EnumeratedTelescopeConfigGeneratorInput | None¶

random: RandomTelescopeConfigGeneratorInput | None¶

spiral: SpiralTelescopeConfigGeneratorInput | None¶

uniform: UniformTelescopeConfigGeneratorInput | None¶

class gpp_client.generated.input_types.TelescopeConfigInput(*, offset: OffsetInput | None = None, guiding: GuideState | None = None)[source]¶

Bases: BaseModel

Science step creation input

guiding: GuideState | None¶: Whether guiding is enabled for this step (defaults to ‘ENABLED’).

offset: OffsetInput | None¶: Offset position, which defaults to (0, 0) arcsec.

class gpp_client.generated.input_types.TelluricTypeInput(*, tag: TelluricTag, starTypes: list[str] | None = None)[source]¶

Bases: BaseModel

star_types: list[str] | None¶

tag: TelluricTag¶

class gpp_client.generated.input_types.TimeAndCountExposureTimeModeInput(*, time: TimeSpanInput, count: Any, at: WavelengthInput)[source]¶

Bases: BaseModel

Time And Count exposure time mode parameters

at: WavelengthInput¶: S/N at wavelength.

count: Any¶: Exposure count, which must be greater than zero.

time: TimeSpanInput¶: Exposure time, which must be greater than zero.

class gpp_client.generated.input_types.TimeChargeCorrectionInput(*, chargeClass: ChargeClass, op: TimeChargeCorrectionOp, amount: TimeSpanInput, comment: str | None = None)[source]¶

Bases: BaseModel

Describes a manual correction to time accounting calculations.

amount: TimeSpanInput¶: The amount of time to add or subtract (respecting the min and max time span).

charge_class: ChargeClass¶: The charge class to be corrected.

comment: str | None¶: Optional justification for the correction.

op: TimeChargeCorrectionOp¶: The operation (add or subtract) to perform.

Bases: BaseModel

Equivalent time amount in several unit options (exactly one must be specified)

hours: Any | None¶: TimeSpan in hours

iso: str | None¶: TimeSpan as an ISO-8601 string

microseconds: Any | None¶: TimeSpan in µs

milliseconds: Any | None¶: TimeSpan in ms

minutes: Any | None¶: TimeSpan in minutes

seconds: Any | None¶: TimeSpan in seconds

class gpp_client.generated.input_types.TimingWindowEndInput(*, atUtc: Any | None = None, after: TimeSpanInput | None = None, repeat: TimingWindowRepeatInput | None = None)[source]¶

Bases: BaseModel

Timing window end parameters.

after: TimeSpanInput | None¶: Window end after a period of time. If specified, atUtc must be omitted.

at_utc: Any | None¶: Window end date and time, in UTC. If specified, after and repeat must be omitted.

repeat: TimingWindowRepeatInput | None¶: Repetition parameters. Only allowed if after is specified. If ommitted, window will not repeat.

class gpp_client.generated.input_types.TimingWindowInput(*, inclusion: TimingWindowInclusion, startUtc: Any, end: TimingWindowEndInput | None = None)[source]¶

Bases: BaseModel

Timing window creation parameters.

end: TimingWindowEndInput | None¶: Window end parameters. If omitted, the window will never end.

inclusion: TimingWindowInclusion¶: Whether this is an INCLUDE or EXCLUDE window.

start_utc: Any¶: Window start time, in UTC.

class gpp_client.generated.input_types.TimingWindowRepeatInput(*, period: TimeSpanInput, times: Any | None = None)[source]¶

Bases: BaseModel

Timing window repetition parameters.

period: TimeSpanInput¶: Repeat period, counting from the start of the window.

times: Any | None¶: Repetition times. If omitted, will repeat forever.

class gpp_client.generated.input_types.UniformTelescopeConfigGeneratorInput(*, cornerA: OffsetInput, cornerB: OffsetInput)[source]¶

Bases: BaseModel

Defines the region over which the pattern of offsets will be distributed. The number of points is determined by integration time calculator results.

corner_a: OffsetInput¶

corner_b: OffsetInput¶

class gpp_client.generated.input_types.UnlinkUserInput(*, programUserId: Any)[source]¶

Bases: BaseModel

program_user_id: Any¶: The program user to unlink the user from.

class gpp_client.generated.input_types.UnnormalizedSedInput(*, stellarLibrary: StellarLibrarySpectrum | None = None, coolStar: CoolStarTemperature | None = None, galaxy: GalaxySpectrum | None = None, planet: PlanetSpectrum | None = None, quasar: QuasarSpectrum | None = None, hiiRegion: HiiRegionSpectrum | None = None, planetaryNebula: PlanetaryNebulaSpectrum | None = None, powerLaw: Any | None = None, blackBodyTempK: Any | None = None, fluxDensities: list[FluxDensity] | None = None, fluxDensitiesAttachment: Any | None = None)[source]¶

Bases: BaseModel

Un-normalized SED input parameters. Define one value only.

black_body_temp_k: Any | None¶

cool_star: CoolStarTemperature | None¶

flux_densities: list[FluxDensity] | None¶

flux_densities_attachment: Any | None¶

galaxy: GalaxySpectrum | None¶

hii_region: HiiRegionSpectrum | None¶

planet: PlanetSpectrum | None¶

planetary_nebula: PlanetaryNebulaSpectrum | None¶

power_law: Any | None¶

quasar: QuasarSpectrum | None¶

stellar_library: StellarLibrarySpectrum | None¶

class gpp_client.generated.input_types.UpdateAsterismsInput(*, SET: EditAsterismsPatchInput, WHERE: WhereObservation | None = None, LIMIT: Any | None = None, includeDeleted: bool | None = False)[source]¶

Bases: BaseModel

Input for bulk updating multiple observations. Select observations with the ‘WHERE’ input and specify the changes in ‘SET’. All the selected observations must be in the same program.

include_deleted: bool | None¶

limit: Any | None¶: Caps the number of results returned to the given value (if additional observations match the WHERE clause they will be updated but not returned).

set_: EditAsterismsPatchInput¶: Describes the values to modify.

where: WhereObservation | None¶: Filters the observations to be updated according to those that match the given constraints. All must correspond to the same program.

class gpp_client.generated.input_types.UpdateAttachmentsInput(*, SET: AttachmentPropertiesInput, WHERE: WhereAttachment | None = None, LIMIT: Any | None = None)[source]¶

Bases: BaseModel

Attachment selection and update description. Use SET to specify the changes, WHERE to select the attachments to update, and LIMIT to control the size of the return value.

limit: Any | None¶: Caps the number of results returned to the given value (if additional attachments match the WHERE clause they will be updated but not returned).

set_: AttachmentPropertiesInput¶: Describes the attachment values to modify.

where: WhereAttachment | None¶: Filters the attachments to be updated according to those that match the given constraints.

class gpp_client.generated.input_types.UpdateCallsForProposalsInput(*, SET: CallForProposalsPropertiesInput, WHERE: WhereCallForProposals | None = None, LIMIT: Any | None = None, includeDeleted: bool | None = False)[source]¶

Bases: BaseModel

Call for proposals selection and update description. Use SET to specify the changes, WHERE to select the calls to update, and LIMIT to control the size of the return value.

include_deleted: bool | None¶: Set to true to include deleted calls.

limit: Any | None¶: Caps the number of results returned to the given value (if additional calls match the WHERE clause they will be updated but not returned).

set_: CallForProposalsPropertiesInput¶: Describes the call for proposals properties to modify.

where: WhereCallForProposals | None¶: Filters the calls to be updated according to those that match the given constraints.

class gpp_client.generated.input_types.UpdateConfigurationRequestsInput(*, SET: ConfigurationRequestProperties, WHERE: WhereConfigurationRequest | None = None, LIMIT: Any | None = None)[source]¶

Bases: BaseModel

ConfigurationRequest selection and update description. Use SET to specify the changes, WHERE to select the requests to update, and LIMIT to control the size of the return value.

limit: Any | None¶: Caps the number of results returned to the given value (if additional observations match the WHERE clause they will be updated but not returned).

set_: ConfigurationRequestProperties¶: Describes the observation values to modify.

where: WhereConfigurationRequest | None¶: Filters the observations to be updated according to those that match the given constraints.

class gpp_client.generated.input_types.UpdateDatasetsInput(*, SET: DatasetPropertiesInput, WHERE: WhereDataset | None = None, LIMIT: Any | None = None)[source]¶

Bases: BaseModel

Dataset selection and update description. Use SET to specify the changes, WHERE to select the datasets to update, and LIMIT to control the size of the return value.

limit: Any | None¶: Caps the number of results returned to the given value (if additional datasets match the WHERE clause they will be updated but not returned).

set_: DatasetPropertiesInput¶: Describes the dataset values to modify.

where: WhereDataset | None¶: Filters the datasets to be updated according to those that match the given constraints.

class gpp_client.generated.input_types.UpdateGroupsInput(*, SET: GroupPropertiesInput, WHERE: WhereGroup | None = None, LIMIT: Any | None = None)[source]¶

Bases: BaseModel

Dataset selection and update description. Use SET to specify the changes, WHERE to select the groups to update, and LIMIT to control the size of the return value.

limit: Any | None¶: Caps the number of results returned to the given value (if additional datasets match the WHERE clause they will be updated but not returned).

set_: GroupPropertiesInput¶: Describes the dataset values to modify.

where: WhereGroup | None¶: Filters the datasets to be updated according to those that match the given constraints.

class gpp_client.generated.input_types.UpdateObservationsInput(*, SET: ObservationPropertiesInput, WHERE: WhereObservation | None = None, LIMIT: Any | None = None, includeDeleted: bool | None = False)[source]¶

Bases: BaseModel

Observation selection and update description. Use SET to specify the changes, WHERE to select the observations to update, and LIMIT to control the size of the return value.

include_deleted: bool | None¶: Set to true to include deleted observations.

limit: Any | None¶: Caps the number of results returned to the given value (if additional observations match the WHERE clause they will be updated but not returned).

set_: ObservationPropertiesInput¶: Describes the observation values to modify.

where: WhereObservation | None¶: Filters the observations to be updated according to those that match the given constraints.

class gpp_client.generated.input_types.UpdateObservationsTimesInput(*, SET: ObservationTimesInput, WHERE: WhereObservation | None = None, LIMIT: Any | None = None, includeDeleted: bool | None = False)[source]¶

Bases: BaseModel

Observation selection and times update description. Use SET to specify the changes, WHERE to select the observations to update, and LIMIT to control the size of the return value.

include_deleted: bool | None¶: Set to true to include deleted observations.

limit: Any | None¶: Caps the number of results returned to the given value (if additional observations match the WHERE clause they will be updated but not returned).

set_: ObservationTimesInput¶: Describes the observation time values to modify.

where: WhereObservation | None¶: Filters the observations to be updated according to those that match the given constraints.

class gpp_client.generated.input_types.UpdateProgramNotesInput(*, SET: ProgramNotePropertiesInput, WHERE: WhereProgramNote | None = None, LIMIT: Any | None = None, includeDeleted: bool | None = False)[source]¶

Bases: BaseModel

Program note selection and update description. Use SET” to specify the changes, `WHERE to select the programs to update, and LIMIT to control the size of the return value.

include_deleted: bool | None¶: Set to true to include deleted notes.

limit: Any | None¶: Caps the number of results returned to the given value (if additional notes match the WHERE clause they will be updated but not returned).

set_: ProgramNotePropertiesInput¶: Describes the program note values to modify.

where: WhereProgramNote | None¶: Filters the program notes to be updated according to those that match the given constraints.

class gpp_client.generated.input_types.UpdateProgramUsersInput(*, SET: ProgramUserPropertiesInput, WHERE: WhereProgramUser | None = None, LIMIT: Any | None = None)[source]¶

Bases: BaseModel

Parameters for the ‘updateProgramUsers’ mutation. Use ‘SET’ to specify the changes, ‘WHERE’ to select the program users to update, and ‘LIMIT’ to control the size of the return value.

limit: Any | None¶: Caps the number of results returned to the given value (if additional program users match the ‘WHERE’ clause they will be updated not returned).

set_: ProgramUserPropertiesInput¶: Defines the program user properties to modify.

where: WhereProgramUser | None¶: Filters the program users according to those that match the given constraints.

class gpp_client.generated.input_types.UpdateProgramsInput(*, SET: ProgramPropertiesInput, WHERE: WhereProgram | None = None, LIMIT: Any | None = None, includeDeleted: bool | None = False)[source]¶

Bases: BaseModel

Program selection and update description. Use SET to specify the changes, WHERE to select the programs to update, and LIMIT to control the size of the return value.

include_deleted: bool | None¶: Set to true to include deleted programs.

limit: Any | None¶: Caps the number of results returned to the given value (if additional programs match the WHERE clause they will be updated but not returned).

set_: ProgramPropertiesInput¶: Describes the program values to modify.

where: WhereProgram | None¶: Filters the programs to be updated according to those that match the given constraints.

class gpp_client.generated.input_types.UpdateProposalInput(*, programId: Any | None = None, proposalReference: Any | None = None, programReference: Any | None = None, SET: ProposalPropertiesInput)[source]¶

Bases: BaseModel

Input for updating a proposal. Identify the program to update with one of programId, proposalReference or programReference. If more than one of these is specified, all must match. Use SET to specify the new program reference properties.

program_id: Any | None¶

program_reference: Any | None¶

proposal_reference: Any | None¶

set_: ProposalPropertiesInput¶

class gpp_client.generated.input_types.UpdateTargetsInput(*, SET: TargetPropertiesInput, WHERE: WhereTarget | None = None, LIMIT: Any | None = None, includeDeleted: bool | None = False)[source]¶

Bases: BaseModel

Target selection and update description. Use SET to specify the changes, WHERE to select the targets to update, and LIMIT to control the size of the return value.

include_deleted: bool | None¶: Set to true to include deleted targets

limit: Any | None¶: Caps the number of results returned to the given value (if additional targets match the WHERE clause they will be updated but not returned).

set_: TargetPropertiesInput¶: Describes the target values to modify.

where: WhereTarget | None¶: Filters the targets to be updated according to those that match the given constraints.

class gpp_client.generated.input_types.UserProfileInput(*, givenName: str | None = None, familyName: str | None = None, creditName: str | None = None, email: str | None = None)[source]¶

Bases: BaseModel

credit_name: str | None¶

email: str | None¶

family_name: str | None¶

given_name: str | None¶

class gpp_client.generated.input_types.UserSuppliedEphemeris(*, gn: list[UserSuppliedEphemerisElement], gs: list[UserSuppliedEphemerisElement])[source]¶

Bases: BaseModel

Input for a user-supplied ephemeris. Both sites must be specified (but may be empty).

gn: list[UserSuppliedEphemerisElement]¶

gs: list[UserSuppliedEphemerisElement]¶

class gpp_client.generated.input_types.UserSuppliedEphemerisElement(*, when: Any | None = None, coordinates: CoordinatesInput | None = None, velocity: OffsetInput | None = None)[source]¶

Bases: BaseModel

Input for an element in a user-supplied ephemeris. All values must be specified.

coordinates: CoordinatesInput | None¶

velocity: OffsetInput | None¶

when: Any | None¶

class gpp_client.generated.input_types.VisitorInput(*, mode: VisitorObservingModeType | None = None, centralWavelength: WavelengthInput | None = None, guideStarMinSep: AngleInput | None = None)[source]¶

Bases: BaseModel

central_wavelength: WavelengthInput | None¶

guide_star_min_sep: AngleInput | None¶

mode: VisitorObservingModeType | None¶

class gpp_client.generated.input_types.WavelengthDitherInput(*, picometers: int | None = None, angstroms: Any | None = None, nanometers: Any | None = None, micrometers: Any | None = None)[source]¶

Bases: BaseModel

WavelengthDither, choose one of the available units

angstroms: Any | None¶

micrometers: Any | None¶

nanometers: Any | None¶

picometers: int | None¶

class gpp_client.generated.input_types.WavelengthInput(*, picometers: Any | None = None, angstroms: Any | None = None, nanometers: Any | None = None, micrometers: Any | None = None)[source]¶

Bases: BaseModel

Wavelength, choose one of the available units

angstroms: Any | None¶

micrometers: Any | None¶

nanometers: Any | None¶

picometers: Any | None¶

class gpp_client.generated.input_types.WhereAngle(*, AND: list[WhereAngle] | None = None, OR: list[WhereAngle] | None = None, NOT: WhereAngle | None = None, microarcseconds: WhereOrderLong | None = None, microseconds: WhereOrderBigDecimal | None = None, milliarcseconds: WhereOrderBigDecimal | None = None, milliseconds: WhereOrderBigDecimal | None = None, arcseconds: WhereOrderBigDecimal | None = None, seconds: WhereOrderBigDecimal | None = None, arcminutes: WhereOrderBigDecimal | None = None, minutes: WhereOrderBigDecimal | None = None, degrees: WhereOrderBigDecimal | None = None, hours: WhereOrderBigDecimal | None = None)[source]¶

Bases: BaseModel

and_: list[WhereAngle] | None¶

arcminutes: WhereOrderBigDecimal | None¶

arcseconds: WhereOrderBigDecimal | None¶

degrees: WhereOrderBigDecimal | None¶

hours: WhereOrderBigDecimal | None¶

microarcseconds: WhereOrderLong | None¶

microseconds: WhereOrderBigDecimal | None¶

milliarcseconds: WhereOrderBigDecimal | None¶

milliseconds: WhereOrderBigDecimal | None¶

minutes: WhereOrderBigDecimal | None¶

not_: WhereAngle | None¶

or_: list[WhereAngle] | None¶

seconds: WhereOrderBigDecimal | None¶

class gpp_client.generated.input_types.WhereAttachment(*, AND: list[WhereAttachment] | None = None, OR: list[WhereAttachment] | None = None, NOT: WhereAttachment | None = None, id: WhereOrderAttachmentId | None = None, fileName: WhereString | None = None, description: WhereOptionString | None = None, attachmentType: WhereAttachmentType | None = None, checked: bool | None = None, program: WhereProgram | None = None)[source]¶

Bases: BaseModel

Attachment filter options. All specified items must match.

and_: list[WhereAttachment] | None¶: A list of nested attachment filters that all must match in order for the AND group as a whole to match.

attachment_type: WhereAttachmentType | None¶: Matches the attachment type

checked: bool | None¶: Matches whether the attachment has been checked or not

description: WhereOptionString | None¶: Matches the description.

file_name: WhereString | None¶: Matches the attachment file name.

id: WhereOrderAttachmentId | None¶: Matches the attachment ID.

not_: WhereAttachment | None¶: A nested attachment filter that must not match in order for the NOT itself to match.

or_: list[WhereAttachment] | None¶: A list of nested attachment filters where any one match causes the entire OR group as a whole to match.

program: WhereProgram | None¶: Matches the program containing the attachment.

class gpp_client.generated.input_types.WhereAttachmentType(*, EQ: AttachmentType | None = None, NEQ: AttachmentType | None = None, IN: list[AttachmentType] | None = None, NIN: list[AttachmentType] | None = None)[source]¶

Bases: BaseModel

Filters on equality of the property. All supplied criteria must match, but usually only one is selected. E.g., ‘EQ: FINDER’

eq: AttachmentType | None¶: Matches if the property is exactly the supplied value.

in_: list[AttachmentType] | None¶: Matches if the property value is any of the supplied options.

neq: AttachmentType | None¶: Matches if the property is not the supplied value.

nin: list[AttachmentType] | None¶: Matches if the property value is none of the supplied values.

class gpp_client.generated.input_types.WhereBoolean(*, EQ: bool | None = None)[source]¶

Bases: BaseModel

eq: bool | None¶: Matches if the boolean is the provided value.

class gpp_client.generated.input_types.WhereCalculatedObservationWorkflow(*, IS_NULL: bool | None = None, calculationState: WhereOrderCalculationState | None = None, state: WhereOrderCalculationState | None = None, workflowState: WhereOrderObservationWorkflowState | None = None)[source]¶

Bases: BaseModel

Matches on the current state of the ObservationWorkflow, which may be in the process of being updated on the server. Use the ‘calculationState’ if, for example, only interested in results for which no pending change is expected.

calculation_state: WhereOrderCalculationState | None¶: Matches the current state of the background calculation.

is_null: bool | None¶: When true, matches if the calculated workflow is not defined. When false matches if the calculated workflow is defined.

state: WhereOrderCalculationState | None¶: Matches the current state of the background calculation.

workflow_state: WhereOrderObservationWorkflowState | None¶: Matchs the workflow state itself.

class gpp_client.generated.input_types.WhereCallForProposals(*, AND: list[WhereCallForProposals] | None = None, OR: list[WhereCallForProposals] | None = None, NOT: WhereCallForProposals | None = None, id: WhereOrderCallForProposalsId | None = None, type: WhereEqCallForProposalsType | None = None, semester: WhereOrderSemester | None = None, activeStart: WhereOrderDate | None = None, activeEnd: WhereOrderDate | None = None, isOpen: WhereBoolean | None = None, allowsNonPartnerPi: WhereBoolean | None = None)[source]¶

Bases: BaseModel

active_end: WhereOrderDate | None¶: Matches the active period end.

active_start: WhereOrderDate | None¶: Matches the active period start.

allows_non_partner_pi: WhereBoolean | None¶: Matches whether non-partner PIs may participate.

and_: list[WhereCallForProposals] | None¶: A list of nested call for proposals filters that all must match in order for the AND group as a whole to match.

id: WhereOrderCallForProposalsId | None¶: Matches the call for propsals id.

is_open: WhereBoolean | None¶: Matches whether the call is still open for some partner.

not_: WhereCallForProposals | None¶: A nested call for proposals filter that must not match in order for the NOT itself to match.

or_: list[WhereCallForProposals] | None¶: A list of nested call for proposals filters where any one match causes the entire OR group as a whole to match.

semester: WhereOrderSemester | None¶: Matches the call for proposals semester.

type_: WhereEqCallForProposalsType | None¶: Matches the call for proposals type.

class gpp_client.generated.input_types.WhereConfigurationRequest(*, AND: list[WhereConfigurationRequest] | None = None, OR: list[WhereConfigurationRequest] | None = None, NOT: WhereConfigurationRequest | None = None, id: WhereOrderConfigurationRequestId | None = None, program: WhereProgram | None = None, status: WhereOrderConfigurationRequestStatus | None = None)[source]¶

Bases: BaseModel

Configuration request filter options. All specified items must match.

and_: list[WhereConfigurationRequest] | None¶: A list of nested filters that all must match in order for the AND group as a whole to match.

id: WhereOrderConfigurationRequestId | None¶: Matches the configuration request id.

not_: WhereConfigurationRequest | None¶: A nested filter that must not match in order for the NOT itself to match.

or_: list[WhereConfigurationRequest] | None¶: A list of nested filters where any one match causes the entire OR group as a whole to match.

program: WhereProgram | None¶: Matches the associated program.

status: WhereOrderConfigurationRequestStatus | None¶: Matches the configuration request status.

class gpp_client.generated.input_types.WhereDataset(*, AND: list[WhereDataset] | None = None, OR: list[WhereDataset] | None = None, NOT: WhereDataset | None = None, id: WhereOrderDatasetId | None = None, reference: WhereDatasetReference | None = None, observation: WhereObservation | None = None, stepId: WhereEqStepId | None = None, index: WhereOrderPosInt | None = None, filename: WhereString | None = None, qaState: WhereOptionEqQaState | None = None, comment: WhereOptionString | None = None, isWritten: WhereBoolean | None = None)[source]¶

Bases: BaseModel

Dataset filter options. All specified items must match.

and_: list[WhereDataset] | None¶: A list of nested dataset filters that all must match in order for the AND group as a whole to match.

comment: WhereOptionString | None¶: Matches the dataset comment.

filename: WhereString | None¶: Matches the dataset file name.

id: WhereOrderDatasetId | None¶: Matches indicated dataset(s).

index: WhereOrderPosInt | None¶: Matches the particular dataset index within the step.

is_written: WhereBoolean | None¶: If true, matches when the dataset has been written (or not). In particular, a dataset is considered written when a corresponding END_WRITE dataset event has been recieved.

not_: WhereDataset | None¶: A nested dataset filter that must not match in order for the NOT itself to match.

observation: WhereObservation | None¶: Matches all datasets associated with the observation.

or_: list[WhereDataset] | None¶: A list of nested dataset filters where any one match causes the entire OR group as a whole to match.

qa_state: WhereOptionEqQaState | None¶: Matches the dataset QA state.

reference: WhereDatasetReference | None¶: Matches the dataset reference, if any.

step_id: WhereEqStepId | None¶: Matches all datasets associated with the step.

class gpp_client.generated.input_types.WhereDatasetChronicleEntry(*, AND: list[WhereDatasetChronicleEntry] | None = None, OR: list[WhereDatasetChronicleEntry] | None = None, NOT: WhereDatasetChronicleEntry | None = None, id: WhereOrderChronicleId | None = None, user: WhereUser | None = None, operation: WhereEqDatabaseOperation | None = None, timestamp: WhereOrderTimestamp | None = None, dataset: WhereOrderDatasetId | None = None, modDatasetId: WhereBoolean | None = None, modStepId: WhereBoolean | None = None, modObservationId: WhereBoolean | None = None, modVisitId: WhereBoolean | None = None, modReference: WhereBoolean | None = None, modFilename: WhereBoolean | None = None, modQaState: WhereBoolean | None = None, modInterval: WhereBoolean | None = None, modComment: WhereBoolean | None = None)[source]¶

Bases: BaseModel

Allows filtering of DatasetChronicleEntry (see Query -> datasetChronicleEntries) based on a number of criteria.

and_: list[WhereDatasetChronicleEntry] | None¶

dataset: WhereOrderDatasetId | None¶: Limits the results to specified datasets.

id: WhereOrderChronicleId | None¶: Limits the results to those matching a chronicle id.

mod_comment: WhereBoolean | None¶: Add this item to match only when a dataset comment is or isn’t updated.

mod_dataset_id: WhereBoolean | None¶: Add this item to match only when a dataset id is or isn’t updated.

mod_filename: WhereBoolean | None¶: Add this item to match only when a dataset filename is or isn’t updated.

mod_interval: WhereBoolean | None¶: Add this item to match only when a dataset time interval (the range of time during which it was collected) is or isn’t updated.

mod_observation_id: WhereBoolean | None¶: Add this item to match only when an observation id is or isn’t updated.

mod_qa_state: WhereBoolean | None¶: Add this item to match only when a dataset QA state is or isn’t updated.

mod_reference: WhereBoolean | None¶: Add this item to match only when a dataset reference is or isn’t updated.

mod_step_id: WhereBoolean | None¶: Add this item to match only when a step id is or isn’t updated.

mod_visit_id: WhereBoolean | None¶: Add this item to match only when a visit id is or isn’t updated.

not_: WhereDatasetChronicleEntry | None¶

operation: WhereEqDatabaseOperation | None¶: Limits the results to particular database operations.

or_: list[WhereDatasetChronicleEntry] | None¶

timestamp: WhereOrderTimestamp | None¶: Limits the results based on timestamp of the change.

user: WhereUser | None¶: Limits the results to a particular user or users.

class gpp_client.generated.input_types.WhereDatasetReference(*, IS_NULL: bool | None = None, label: WhereString | None = None, observation: WhereObservationReference | None = None, stepIndex: WhereOrderPosInt | None = None, exposureIndex: WhereOrderPosInt | None = None)[source]¶

Bases: BaseModel

exposure_index: WhereOrderPosInt | None¶: Matches the exposure index.

is_null: bool | None¶: Matches if the dataset reference is not defined.

label: WhereString | None¶: Matches the dataset reference label.

observation: WhereObservationReference | None¶: Matches the observation reference.

step_index: WhereOrderPosInt | None¶: Matches the step index.

class gpp_client.generated.input_types.WhereEqCallForProposalsType(*, EQ: CallForProposalsType | None = None, NEQ: CallForProposalsType | None = None, IN: list[CallForProposalsType] | None = None, NIN: list[CallForProposalsType] | None = None)[source]¶

Bases: BaseModel

Filters on equality (or not) of the call for proposals type. All supplied criteria must match, but usually only one is selected.

eq: CallForProposalsType | None¶: Matches if the call for proposals type is exactly the supplied value.

in_: list[CallForProposalsType] | None¶: Matches if the call for proposals type is any of the supplied options.

neq: CallForProposalsType | None¶: Matches if the call for proposals type is not the supplied value.

nin: list[CallForProposalsType] | None¶: Matches if the call for proposals type is none of the supplied values.

class gpp_client.generated.input_types.WhereEqDatabaseOperation(*, EQ: DatabaseOperation | None = None, NEQ: DatabaseOperation | None = None, IN: list[DatabaseOperation] | None = None, NIN: list[DatabaseOperation] | None = None)[source]¶

Bases: BaseModel

Filters on equality (or not) of the database operation. All supplied criteria must match, but usually only one is selected.

eq: DatabaseOperation | None¶: Matches if the database operation is exactly the supplied value.

in_: list[DatabaseOperation] | None¶: Matches if the database operation is any of the supplied options.

neq: DatabaseOperation | None¶: Matches if the database operation is not the supplied value.

nin: list[DatabaseOperation] | None¶: Matches if the database operation is none of the supplied values.

class gpp_client.generated.input_types.WhereEqExecutionEventType(*, EQ: ExecutionEventType | None = None, NEQ: ExecutionEventType | None = None, IN: list[ExecutionEventType] | None = None, NIN: list[ExecutionEventType] | None = None)[source]¶

Bases: BaseModel

eq: ExecutionEventType | None¶: Matches if the property is exactly the supplied value.

in_: list[ExecutionEventType] | None¶: Matches if the property value is any of the supplied options.

neq: ExecutionEventType | None¶: Matches if the property is not the supplied value.

nin: list[ExecutionEventType] | None¶: Matches if the property value is none of the supplied values.

class gpp_client.generated.input_types.WhereEqFocalPlane(*, EQ: FocalPlane | None = None, NEQ: FocalPlane | None = None, IN: list[FocalPlane] | None = None, NIN: list[FocalPlane] | None = None)[source]¶

Bases: BaseModel

eq: FocalPlane | None¶: Matches if the focal plane option is exactly the supplied value.

in_: list[FocalPlane] | None¶: Matches if the focal plane option is any of the supplied values.

neq: FocalPlane | None¶: Matches if the focal plane option is not the supplied value.

nin: list[FocalPlane] | None¶: Matches if the focal plane option is none of the supplied values.

class gpp_client.generated.input_types.WhereEqInstrument(*, EQ: Instrument | None = None, NEQ: Instrument | None = None, IN: list[Instrument] | None = None, NIN: list[Instrument] | None = None)[source]¶

Bases: BaseModel

Filters on equality (or not) of the instrument and the supplied criteria. All supplied criteria must match, but usually only one is selected. E.g. ‘EQ = “GMOS_SOUTH”’ will match when the property value is “GMOS_SOUTH”.

eq: Instrument | None¶: Matches if the instrument is exactly the supplied value.

in_: list[Instrument] | None¶: Matches if the instrument is any of the supplied options.

neq: Instrument | None¶: Matches if the instrument is not the supplied value.

nin: list[Instrument] | None¶: Matches if the instrument is none of the supplied values.

class gpp_client.generated.input_types.WhereEqPartner(*, EQ: Partner | None = None, NEQ: Partner | None = None, IN: list[Partner] | None = None, NIN: list[Partner] | None = None)[source]¶

Bases: BaseModel

Filters on equality (or not) of the property value and the supplied criteria. All supplied criteria must match, but usually only one is selected. E.g. ‘EQ = “Foo”’ will match when the property value is “FOO”.

eq: Partner | None¶: Matches if the property is exactly the supplied value.

in_: list[Partner] | None¶: Matches if the property value is any of the supplied options.

neq: Partner | None¶: Matches if the property is not the supplied value.

nin: list[Partner] | None¶: Matches if the property value is none of the supplied values.

class gpp_client.generated.input_types.WhereEqPartnerLinkType(*, EQ: PartnerLinkType | None = None, NEQ: PartnerLinkType | None = None, IN: list[PartnerLinkType] | None = None, NIN: list[PartnerLinkType] | None = None)[source]¶

Bases: BaseModel

Filters on equality (or not) of the partner link type. All supplied criteria must match, but usually only one is selected.

eq: PartnerLinkType | None¶: Matches if the partner link type is exactly the supplied value.

in_: list[PartnerLinkType] | None¶: Matches if the partner link type is any of the supplied options.

neq: PartnerLinkType | None¶: Matches if the partner link type is not the supplied value.

nin: list[PartnerLinkType] | None¶: Matches if the partner link type is none of the supplied values.

class gpp_client.generated.input_types.WhereEqProgramType(*, EQ: ProgramType | None = None, NEQ: ProgramType | None = None, IN: list[ProgramType] | None = None, NIN: list[ProgramType] | None = None)[source]¶

Bases: BaseModel

Filters on equality (or not) of the program type and the supplied criteria. All supplied criteria must match, but usually only one is selected. E.g. ‘EQ = “CALIBRATION”’ will match when the type is “CALIBRATION”.

eq: ProgramType | None¶: Matches if the program type is exactly the supplied value.

in_: list[ProgramType] | None¶: Matches if the program type is any of the supplied options.

neq: ProgramType | None¶: Matches if the program type is not the supplied value.

nin: list[ProgramType] | None¶: Matches if the program type is none of the supplied values.

class gpp_client.generated.input_types.WhereEqProgramUserRole(*, EQ: ProgramUserRole | None = None, NEQ: ProgramUserRole | None = None, IN: list[ProgramUserRole] | None = None, NIN: list[ProgramUserRole] | None = None)[source]¶

Bases: BaseModel

Filters on equality (or not) of the program user role type and the supplied criteria. All supplied criteria must match, but usually only one is selected.

eq: ProgramUserRole | None¶: Matches if the role is exactly the supplied value.

in_: list[ProgramUserRole] | None¶: Matches if the role is any of the supplied options.

neq: ProgramUserRole | None¶: Matches if the role is not the supplied value.

nin: list[ProgramUserRole] | None¶: Matches if the role is none of the supplied values.

class gpp_client.generated.input_types.WhereEqProposalStatus(*, EQ: ProposalStatus | None = None, NEQ: ProposalStatus | None = None, IN: list[ProposalStatus] | None = None, NIN: list[ProposalStatus] | None = None)[source]¶

Bases: BaseModel

Filters on equality of the property. All supplied criteria must match, but usually only one is selected. E.g., ‘EQ: “SUBMITTED’

eq: ProposalStatus | None¶: Matches if the property is exactly the supplied value.

in_: list[ProposalStatus] | None¶: Matches if the property value is any of the supplied options.

neq: ProposalStatus | None¶: Matches if the property is not the supplied value.

nin: list[ProposalStatus] | None¶: Matches if the property value is none of the supplied values.

class gpp_client.generated.input_types.WhereEqScienceSubtype(*, EQ: ScienceSubtype | None = None, NEQ: ScienceSubtype | None = None, IN: list[ScienceSubtype] | None = None, NIN: list[ScienceSubtype] | None = None)[source]¶

Bases: BaseModel

Filters on equality (or not) of the science subtype and the supplied criteria. All supplied criteria must match, but usually only one is selected. E.g. ‘EQ = “QUEUE”’ will match when the property value is “QUEUE”. Defining, EQ, NEQ etc. implies IS_NULL is false.

eq: ScienceSubtype | None¶: Matches if the subtype is exactly the supplied value.

in_: list[ScienceSubtype] | None¶: Matches if the subtype is any of the supplied options.

neq: ScienceSubtype | None¶: Matches if the subtype is not the supplied value.

nin: list[ScienceSubtype] | None¶: Matches if the subtype is none of the supplied values.

class gpp_client.generated.input_types.WhereEqSite(*, EQ: Site | None = None, NEQ: Site | None = None, IN: list[Site] | None = None, NIN: list[Site] | None = None)[source]¶

Bases: BaseModel

Filters on equality (or not) of the site property. All supplied criteria must match, but usually only one is selected.

eq: Site | None¶: Matches if the site is exactly the supplied value.

in_: list[Site] | None¶: Matches if the site is any of the supplied options.

neq: Site | None¶: Matches if the site is not the supplied value.

nin: list[Site] | None¶: Matches if the site is none of the supplied values.

class gpp_client.generated.input_types.WhereEqStepId(*, EQ: Any | None = None, NEQ: Any | None = None, IN: list[Any] | None = None, NIN: list[Any] | None = None)[source]¶

Bases: BaseModel

eq: Any | None¶: Matches if the property is exactly the supplied value.

in_: list[Any] | None¶: Matches if the property value is any of the supplied options.

neq: Any | None¶: Matches if the property is not the supplied value.

nin: list[Any] | None¶: Matches if the property value is none of the supplied values.

class gpp_client.generated.input_types.WhereEqTargetDisposition(*, EQ: TargetDisposition | None = None, NEQ: TargetDisposition | None = None, IN: list[TargetDisposition] | None = None, NIN: list[TargetDisposition] | None = None)[source]¶

Bases: BaseModel

Filters on equality (or not) of the target disposition and the supplied criteria. All supplied criteria must match, but usually only one is selected. E.g. ‘EQ = “SCIENCE”’ will match when the property value is “SCIENCE”.

eq: TargetDisposition | None¶: Matches if the target disposition is exactly the supplied value.

in_: list[TargetDisposition] | None¶: Matches if the target disposition is any of the supplied options.

neq: TargetDisposition | None¶: Matches if the target disposition is not the supplied value.

nin: list[TargetDisposition] | None¶: Matches if the target disposition is none of the supplied values.

class gpp_client.generated.input_types.WhereEqToOActivation(*, EQ: ToOActivation | None = None, NEQ: ToOActivation | None = None, IN: list[ToOActivation] | None = None, NIN: list[ToOActivation] | None = None)[source]¶

Bases: BaseModel

eq: ToOActivation | None¶: Matches if the property is exactly the supplied value.

in_: list[ToOActivation] | None¶: Matches if the property value is any of the supplied options.

neq: ToOActivation | None¶: Matches if the property is not the supplied value.

nin: list[ToOActivation] | None¶: Matches if the property value is none of the supplied values.

class gpp_client.generated.input_types.WhereEqUserType(*, EQ: UserType | None = None, NEQ: UserType | None = None, IN: list[UserType] | None = None, NIN: list[UserType] | None = None)[source]¶

Bases: BaseModel

Filters on equality (or not) of the user type value and the supplied criteria. All supplied criteria must match, but usually only one is selected.

eq: UserType | None¶: Matches if the user type is exactly the supplied value.

in_: list[UserType] | None¶: Matches if the user type is any of the supplied options.

neq: UserType | None¶: Matches if the user type is not the supplied value.

nin: list[UserType] | None¶: Matches if the user type is none of the supplied values.

class gpp_client.generated.input_types.WhereEqVisitId(*, EQ: Any | None = None, NEQ: Any | None = None, IN: list[Any] | None = None, NIN: list[Any] | None = None)[source]¶

Bases: BaseModel

eq: Any | None¶: Matches if the property is exactly the supplied value.

in_: list[Any] | None¶: Matches if the property value is any of the supplied options.

neq: Any | None¶: Matches if the property is not the supplied value.

nin: list[Any] | None¶: Matches if the property value is none of the supplied values.

class gpp_client.generated.input_types.WhereExecutionEvent(*, AND: list[WhereExecutionEvent] | None = None, OR: list[WhereExecutionEvent] | None = None, NOT: WhereExecutionEvent | None = None, id: WhereOrderExecutionEventId | None = None, visitId: WhereEqVisitId | None = None, observation: WhereObservation | None = None, received: WhereOrderTimestamp | None = None, eventType: WhereEqExecutionEventType | None = None, slewStage: WhereOrderSlewStage | None = None, sequenceCommand: WhereOrderSequenceCommand | None = None, stepId: WhereEqStepId | None = None, stepStage: WhereOrderStepStage | None = None, datasetId: WhereOrderDatasetId | None = None, datasetStage: WhereOrderDatasetStage | None = None)[source]¶

Bases: BaseModel

ExecutionEvent filter options.

and_: list[WhereExecutionEvent] | None¶: A list of nested execution event filters that all must match in order for the AND group as a whole to match.

dataset_id: WhereOrderDatasetId | None¶: Matches on the dataset id, for dataset events.

dataset_stage: WhereOrderDatasetStage | None¶: Matches on the dataset stage, for dataset events.

event_type: WhereEqExecutionEventType | None¶: Matches on execution event type

id: WhereOrderExecutionEventId | None¶: Matches on the execution event id

not_: WhereExecutionEvent | None¶: A nested execution event filter that must not match in order for the NOT itself to match.

observation: WhereObservation | None¶: Matches on observation

or_: list[WhereExecutionEvent] | None¶: A list of nested execution event filters where any one match causes the entire OR group as a whole to match.

received: WhereOrderTimestamp | None¶: Matches on event reception time

sequence_command: WhereOrderSequenceCommand | None¶: Matches the sequence command type, for sequence events.

slew_stage: WhereOrderSlewStage | None¶: Matches the slew stage, for slew events.

step_id: WhereEqStepId | None¶: Matches on the step id, for step and dataset events.

step_stage: WhereOrderStepStage | None¶: Matches on the step stage, for step events.

visit_id: WhereEqVisitId | None¶: Matches on the visit id

Bases: BaseModel

and_: list[WhereGroup] | None¶: A list of nested group filters that all must match in order for the AND group as a whole to match.

description: WhereOptionString | None¶

id: WhereOrderGroupId | None¶

name: WhereOptionString | None¶

not_: WhereGroup | None¶: A nested group filter that must not match in order for the NOT itself to match.

or_: list[WhereGroup] | None¶: A list of nested group filters where any one match causes the entire OR group as a whole to match.

class gpp_client.generated.input_types.WhereImagingConfigOption(*, AND: list[WhereImagingConfigOption] | None = None, OR: list[WhereImagingConfigOption] | None = None, NOT: WhereImagingConfigOption | None = None, adaptiveOptics: WhereBoolean | None = None, instrument: WhereEqInstrument | None = None, fov: WhereAngle | None = None, site: WhereEqSite | None = None)[source]¶

Bases: BaseModel

Imaging instrument configuration option matcher. Configure with the properties of interest and pass it to the ‘imagingConfigOptions’ query to find the corresponding configuration options.

adaptive_optics: WhereBoolean | None¶

and_: list[WhereImagingConfigOption] | None¶

fov: WhereAngle | None¶

instrument: WhereEqInstrument | None¶

not_: WhereImagingConfigOption | None¶

or_: list[WhereImagingConfigOption] | None¶

site: WhereEqSite | None¶

class gpp_client.generated.input_types.WhereObservation(*, AND: list[WhereObservation] | None = None, OR: list[WhereObservation] | None = None, NOT: WhereObservation | None = None, id: WhereOrderObservationId | None = None, reference: WhereObservationReference | None = None, program: WhereProgram | None = None, subtitle: WhereOptionString | None = None, scienceBand: WhereOptionOrderScienceBand | None = None, instrument: WhereOptionEqInstrument | None = None, site: WhereOptionEqSite | None = None, workflow: WhereCalculatedObservationWorkflow | None = None)[source]¶

Bases: BaseModel

Observation filter options. All specified items must match.

and_: list[WhereObservation] | None¶: A list of nested observation filters that all must match in order for the AND group as a whole to match.

id: WhereOrderObservationId | None¶: Matches the observation id.

instrument: WhereOptionEqInstrument | None¶: Matches on the instrument in use, if any.

not_: WhereObservation | None¶: A nested observation filter that must not match in order for the NOT itself to match.

or_: list[WhereObservation] | None¶: A list of nested observation filters where any one match causes the entire OR group as a whole to match.

program: WhereProgram | None¶: Matches the associated program.

reference: WhereObservationReference | None¶: Matches the observation reference, if any.

science_band: WhereOptionOrderScienceBand | None¶: Matches the observation science band.

site: WhereOptionEqSite | None¶: Matches on the site associated with the observation’s instrument, if any.

subtitle: WhereOptionString | None¶: Matches the subtitle of the observation.

workflow: WhereCalculatedObservationWorkflow | None¶: Matches on the observation workflow state.

class gpp_client.generated.input_types.WhereObservationReference(*, IS_NULL: bool | None = None, label: WhereString | None = None, program: WhereProgramReference | None = None, index: WhereOrderPosInt | None = None)[source]¶

Bases: BaseModel

index: WhereOrderPosInt | None¶: Matches the observation index.

is_null: bool | None¶: Matches if the observation reference is not defined.

label: WhereString | None¶: Matches the observation reference label.

program: WhereProgramReference | None¶: Matches the program reference.

class gpp_client.generated.input_types.WhereOptionBoolean(*, IS_NULL: bool | None = None, EQ: bool | None = None)[source]¶

Bases: BaseModel

eq: bool | None¶: Matches if the boolean is the provided value.

is_null: bool | None¶: Matches if the value is not defined.

class gpp_client.generated.input_types.WhereOptionEqCalculationState(*, IS_NULL: bool | None = None, EQ: CalculationState | None = None, NEQ: CalculationState | None = None, IN: list[CalculationState] | None = None, NIN: list[CalculationState] | None = None)[source]¶

Bases: BaseModel

eq: CalculationState | None¶: Matches if the property is exactly the supplied value.

in_: list[CalculationState] | None¶: Matches if the property value is any of the supplied options.

is_null: bool | None¶: When true, matches if the CalculationState is not defined. When false matches if the CalculationState is defined.

neq: CalculationState | None¶: Matches if the property is not the supplied value.

nin: list[CalculationState] | None¶: Matches if the property value is none of the supplied values.

class gpp_client.generated.input_types.WhereOptionEqCalibrationRole(*, IS_NULL: bool | None = None, EQ: CalibrationRole | None = None, NEQ: CalibrationRole | None = None, IN: list[CalibrationRole] | None = None, NIN: list[CalibrationRole] | None = None)[source]¶

Bases: BaseModel

eq: CalibrationRole | None¶: Matches if the property is exactly the supplied value.

in_: list[CalibrationRole] | None¶: Matches if the property value is any of the supplied options.

is_null: bool | None¶: When true, matches if the calibration role is not defined. When false matches if the calibration role is defined.

neq: CalibrationRole | None¶: Matches if the property is not the supplied value.

nin: list[CalibrationRole] | None¶: Matches if the property value is none of the supplied values.

class gpp_client.generated.input_types.WhereOptionEqEducationalStatus(*, IS_NULL: bool | None = None, EQ: EducationalStatus | None = None, NEQ: EducationalStatus | None = None, IN: list[EducationalStatus] | None = None, NIN: list[EducationalStatus] | None = None)[source]¶

Bases: BaseModel

Filters on equality (or not) of the user educational status and the supplied criteria. All supplied criteria must match, but usually only one is selected.

eq: EducationalStatus | None¶: Matches if the property is exactly the supplied value.

in_: list[EducationalStatus] | None¶: Matches if the property value is any of the supplied options.

is_null: bool | None¶: When true, matches if the QaState is not defined. When false matches if the QaState is defined.

neq: EducationalStatus | None¶: Matches if the property is not the supplied value.

nin: list[EducationalStatus] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

Filters on equality (or not) of the user reported geender and the supplied criteria. All supplied criteria must match, but usually only one is selected.

eq: Gender | None¶: Matches if the property is exactly the supplied value.

in_: list[Gender] | None¶: Matches if the property value is any of the supplied options.

is_null: bool | None¶: When true, matches if the QaState is not defined. When false matches if the QaState is defined.

neq: Gender | None¶: Matches if the property is not the supplied value.

nin: list[Gender] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

Filters on equality (or not) of the instrument. All supplied criteria must match, but usually only one is selected.

eq: Instrument | None¶: Matches if the instrument is exactly the supplied value.

in_: list[Instrument] | None¶: Matches if the instrument is any of the supplied options.

is_null: bool | None¶: When true, matches if the instrument is not defined. When false matches if the instrument is defined.

neq: Instrument | None¶: Matches if the instrument is not the supplied value.

nin: list[Instrument] | None¶: Matches if the instrument is none of the supplied values.

Bases: BaseModel

Filters on equality (or not) of the (optional) partner. All supplied criteria must match, but usually only one is selected.

eq: Partner | None¶: Matches if the partrner is exactly the supplied value.

in_: list[Partner] | None¶: Matches if the partner is any of the supplied options.

is_null: bool | None¶: When true, matches if the partner is not defined. When false matches if the partner is defined.

neq: Partner | None¶: Matches if the partner is not the supplied value.

nin: list[Partner] | None¶: Matches if the partner is none of the supplied values.

class gpp_client.generated.input_types.WhereOptionEqQaState(*, IS_NULL: bool | None = None, EQ: DatasetQaState | None = None, NEQ: DatasetQaState | None = None, IN: list[DatasetQaState] | None = None, NIN: list[DatasetQaState] | None = None)[source]¶

Bases: BaseModel

eq: DatasetQaState | None¶: Matches if the property is exactly the supplied value.

in_: list[DatasetQaState] | None¶: Matches if the property value is any of the supplied options.

is_null: bool | None¶: When true, matches if the QaState is not defined. When false matches if the QaState is defined.

neq: DatasetQaState | None¶: Matches if the property is not the supplied value.

nin: list[DatasetQaState] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

Filters on equality of an optional site property. All supplied criteria must match, but usually only one is selected.

eq: Site | None¶: Matches if the site is exactly the supplied value.

in_: list[Site] | None¶: Matches if the site is any of the supplied options.

is_null: bool | None¶: When true, matches if the site is not defined. When false matches if the site role is defined.

neq: Site | None¶: Matches if the site is not the supplied value.

nin: list[Site] | None¶: Matches if the site is none of the supplied values.

class gpp_client.generated.input_types.WhereOptionEqSpectroscopyCapabilities(*, IS_NULL: bool | None = None, EQ: SpectroscopyCapabilities | None = None, NEQ: SpectroscopyCapabilities | None = None, IN: list[SpectroscopyCapabilities] | None = None, NIN: list[SpectroscopyCapabilities] | None = None)[source]¶

Bases: BaseModel

Filters on equality (or not) of the SpectroscopyCapabilities property. All supplied criteria must match, but usually only one is selected.

eq: SpectroscopyCapabilities | None¶: Matches if the spectroscopy capability is the supplied value.

in_: list[SpectroscopyCapabilities] | None¶: Matches if the spectroscopy capability is any one of the supplied values.

is_null: bool | None¶: When true, matches if the spectroscopy capability value is not defined.

neq: SpectroscopyCapabilities | None¶: Matches if the spectroscopy capability is anything other than the supplied value.

nin: list[SpectroscopyCapabilities] | None¶: Matches if the spectroscopy capability is not any one of the supplied values.

Bases: BaseModel

eq: TacCategory | None¶: Matches if the property is exactly the supplied value.

in_: list[TacCategory] | None¶: Matches if the property value is any of the supplied options.

is_null: bool | None¶: When true, matches if the TacCategory is not defined. When false matches if the TacCategory is defined.

neq: TacCategory | None¶: Matches if the property is not the supplied value.

nin: list[TacCategory] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

Filters on equality or order comparisons of science bands. All supplied criteria must match, but usually only one is selected.

eq: ScienceBand | None¶: Matches if the science band is exactly the supplied value.

gt: ScienceBand | None¶: Matches if the science band is ordered after (>) the supplied value.

gte: ScienceBand | None¶: Matches if the science band is ordered after or equal (>=) the supplied value.

in_: list[ScienceBand] | None¶: Matches if the science band is any of the supplied options.

is_null: bool | None¶: When true, matches if the science band is not defined. When false matches if the science band is defined.

lt: ScienceBand | None¶: Matches if the science band is ordered before (<) the supplied value.

lte: ScienceBand | None¶: Matches if the science band is ordered before or equal (<=) the supplied value.

neq: ScienceBand | None¶: Matches if the science band is not the supplied value.

nin: list[ScienceBand] | None¶: Matches if the science band is none of the supplied values.

Bases: BaseModel

String matching options.

eq: Any | None¶

in_: list[Any] | None¶

is_null: bool | None¶: When true the string must not be defined. When false the string must be defined.

like: Any | None¶: Performs string matching with wildcard patterns. The entire string must be matched. Use % to match a sequence of any characters and _ to match any single character.

match_case: bool | None¶: Set to true (the default) for case sensitive matches, false to ignore case.

neq: Any | None¶

nin: list[Any] | None¶

nlike: Any | None¶: Performs string matching with wildcard patterns. The entire string must not match. Use % to match a sequence of any characters and _ to match any single character.

Bases: BaseModel

Filters on equality or order comparisons of the property. All supplied criteria must match, but usually only one is selected. E.g., ‘GT = 2’ for an integer property will match when the value is 3 or more.

eq: Any | None¶: Matches if the property is exactly the supplied value.

gt: Any | None¶: Matches if the property is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the property value is any of the supplied options.

lt: Any | None¶: Matches if the property is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the property is not the supplied value.

nin: list[Any] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

Filters on equality or order comparisons of BigDecimal properties. All supplied criteria must match, but usually only one is selected.

eq: Any | None¶: Matches if the BigDecimal is exactly the supplied value.

gt: Any | None¶: Matches if the BigDecimal is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the BigDecimal is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the BigDecimal is any of the supplied options.

lt: Any | None¶: Matches if the BigDecimal is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the BigDecimal is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the BigDecimal is not the supplied value.

nin: list[Any] | None¶: Matches if the BigDecimal is none of the supplied values.

class gpp_client.generated.input_types.WhereOrderCalculationState(*, EQ: CalculationState | None = None, NEQ: CalculationState | None = None, IN: list[CalculationState] | None = None, NIN: list[CalculationState] | None = None, GT: CalculationState | None = None, LT: CalculationState | None = None, GTE: CalculationState | None = None, LTE: CalculationState | None = None)[source]¶

Bases: BaseModel

eq: CalculationState | None¶: Matches if the calculation state is exactly the supplied value.

gt: CalculationState | None¶: Matches if the calculation state is ordered after (>) the supplied value.

gte: CalculationState | None¶: Matches if the calculation state is ordered after or equal (>=) the supplied value.

in_: list[CalculationState] | None¶: Matches if the calculation state is any of the supplied options.

lt: CalculationState | None¶: Matches if the calculation state is ordered before (<) the supplied value.

lte: CalculationState | None¶: Matches if the calculation state is ordered before or equal (<=) the supplied value.

neq: CalculationState | None¶: Matches if the calculation state is not the supplied value.

nin: list[CalculationState] | None¶: Matches if the calculation state is none of the supplied values.

Bases: BaseModel

Filters on equality or order comparisons of call for proposals ids. All supplied criteria must match, but usually only one is selected.

eq: Any | None¶: Matches if the id is exactly the supplied value.

gt: Any | None¶: Matches if the id is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the id is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the id is any of the supplied options.

lt: Any | None¶: Matches if the id is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the id is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the id is not the supplied value.

nin: list[Any] | None¶: Matches if the id is none of the supplied options.

Bases: BaseModel

Filters on equality or order comparisons of the chronicle id. All supplied criteria must match, but usually only one is selected.

eq: Any | None¶: Matches if the property is exactly the supplied value.

gt: Any | None¶: Matches if the property is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the property value is any of the supplied options.

lt: Any | None¶: Matches if the property is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the property is not the supplied value.

nin: list[Any] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

eq: Any | None¶: Matches if the property is exactly the supplied value.

gt: Any | None¶: Matches if the property is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the property value is any of the supplied options.

lt: Any | None¶: Matches if the property is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the property is not the supplied value.

nin: list[Any] | None¶: Matches if the property value is none of the supplied values.

class gpp_client.generated.input_types.WhereOrderConfigurationRequestStatus(*, EQ: ConfigurationRequestStatus | None = None, NEQ: ConfigurationRequestStatus | None = None, IN: list[ConfigurationRequestStatus] | None = None, NIN: list[ConfigurationRequestStatus] | None = None, GT: ConfigurationRequestStatus | None = None, LT: ConfigurationRequestStatus | None = None, GTE: ConfigurationRequestStatus | None = None, LTE: ConfigurationRequestStatus | None = None)[source]¶

Bases: BaseModel

eq: ConfigurationRequestStatus | None¶: Matches if the property is exactly the supplied value.

gt: ConfigurationRequestStatus | None¶: Matches if the property is ordered after (>) the supplied value.

gte: ConfigurationRequestStatus | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[ConfigurationRequestStatus] | None¶: Matches if the property value is any of the supplied options.

lt: ConfigurationRequestStatus | None¶: Matches if the property is ordered before (<) the supplied value.

lte: ConfigurationRequestStatus | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: ConfigurationRequestStatus | None¶: Matches if the property is not the supplied value.

nin: list[ConfigurationRequestStatus] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

eq: Any | None¶: Matches if the property is exactly the supplied value.

gt: Any | None¶: Matches if the property is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the property value is any of the supplied options.

lt: Any | None¶: Matches if the property is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the property is not the supplied value.

nin: list[Any] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

eq: DatasetStage | None¶: Matches if the property is exactly the supplied value.

gt: DatasetStage | None¶: Matches if the property is ordered after (>) the supplied value.

gte: DatasetStage | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[DatasetStage] | None¶: Matches if the property value is any of the supplied options.

lt: DatasetStage | None¶: Matches if the property is ordered before (<) the supplied value.

lte: DatasetStage | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: DatasetStage | None¶: Matches if the property is not the supplied value.

nin: list[DatasetStage] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

Filters on equality or order comparisons of the Date property. All supplied criteria must match, but usually only one is selected. Dates are specified in ISO 8601 format (e.g., YYYY-MM-DD).

eq: Any | None¶: Matches if the date is exactly the supplied value.

gt: Any | None¶: Matches if the date is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the date is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the date value is any of the supplied options.

lt: Any | None¶: Matches if the date is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the date is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the date is not the supplied value.

nin: list[Any] | None¶: Matches if the date value is none of the supplied values.

Bases: BaseModel

eq: Any | None¶: Matches if the property is exactly the supplied value.

gt: Any | None¶: Matches if the property is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the property value is any of the supplied options.

lt: Any | None¶: Matches if the property is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the property is not the supplied value.

nin: list[Any] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

eq: Any | None¶: Matches if the property is exactly the supplied value.

gt: Any | None¶: Matches if the property is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the property value is any of the supplied options.

lt: Any | None¶: Matches if the property is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the property is not the supplied value.

nin: list[Any] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

Filters on equality or order comparisons of the integer property. All supplied criteria must match, but usually only one is selected.

eq: int | None¶: Matches if the integer is exactly the supplied value.

gt: int | None¶: Matches if the integer is ordered after (>) the supplied value.

gte: int | None¶: Matches if the integer is ordered after or equal (>=) the supplied value.

in_: list[int] | None¶: Matches if the integer is any of the supplied options.

lt: int | None¶: Matches if the integer is ordered before (<) the supplied value.

lte: int | None¶: Matches if the integer is ordered before or equal (<=) the supplied value.

neq: int | None¶: Matches if the integer is not the supplied value.

nin: list[int] | None¶: Matches if the integer is none of the supplied values.

Bases: BaseModel

Filters on equality or order comparisons of long property. All supplied criteria must match, but usually only one is selected.

eq: Any | None¶: Matches if the Long is exactly the supplied value.

gt: Any | None¶: Matches if the Long is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the Long is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the Long is any of the supplied options.

lt: Any | None¶: Matches if the Long is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the Long is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the Long is not the supplied value.

nin: list[Any] | None¶: Matches if the Long is none of the supplied values.

Bases: BaseModel

eq: Any | None¶: Matches if the property is exactly the supplied value.

gt: Any | None¶: Matches if the property is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the property value is any of the supplied options.

lt: Any | None¶: Matches if the property is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the property is not the supplied value.

nin: list[Any] | None¶: Matches if the property value is none of the supplied values.

class gpp_client.generated.input_types.WhereOrderObservationWorkflowState(*, EQ: ObservationWorkflowState | None = None, NEQ: ObservationWorkflowState | None = None, IN: list[ObservationWorkflowState] | None = None, NIN: list[ObservationWorkflowState] | None = None, GT: ObservationWorkflowState | None = None, LT: ObservationWorkflowState | None = None, GTE: ObservationWorkflowState | None = None, LTE: ObservationWorkflowState | None = None)[source]¶

Bases: BaseModel

Filters on equality or order comparisons of the workflow state. All supplied criteria must match, but usually only one is selected.

eq: ObservationWorkflowState | None¶: Matches if the workflow state is exactly the supplied value.

gt: ObservationWorkflowState | None¶: Matches if the workflow state is ordered after (>) the supplied value.

gte: ObservationWorkflowState | None¶: Matches if the workflow state is ordered after or equal (>=) the supplied value.

in_: list[ObservationWorkflowState] | None¶: Matches if the workflow state value is any of the supplied options.

lt: ObservationWorkflowState | None¶: Matches if the workflow state is ordered before (<) the supplied value.

lte: ObservationWorkflowState | None¶: Matches if the workflow state is ordered before or equal (<=) the supplied value.

neq: ObservationWorkflowState | None¶: Matches if the workflow state is not the supplied value.

nin: list[ObservationWorkflowState] | None¶: Matches if the workflow state is none of the supplied values.

Bases: BaseModel

Filters on equality or order comparisons of PosBigDecimal properties. All supplied criteria must match, but usually only one is selected.

eq: Any | None¶: Matches if the PosBigDecimal is exactly the supplied value.

gt: Any | None¶: Matches if the PosBigDecimal is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the PosBigDecimal is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the PosBigDecimal is any of the supplied options.

lt: Any | None¶: Matches if the PosBigDecimal is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the PosBigDecimal is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the PosBigDecimal is not the supplied value.

nin: list[Any] | None¶: Matches if the PosBigDecimal is none of the supplied values.

Bases: BaseModel

Filters on equality or order comparisons of the PosInt property. All supplied criteria must match, but usually only one is selected.

eq: Any | None¶: Matches if the PosInt is exactly the supplied value.

gt: Any | None¶: Matches if the PosInt is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the PosInt is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the PosInt is any of the supplied options.

lt: Any | None¶: Matches if the PosInt is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the PosInt is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the PosInt is not the supplied value.

nin: list[Any] | None¶: Matches if the PosInt is none of the supplied values.

Bases: BaseModel

eq: Any | None¶: Matches if the property is exactly the supplied value.

gt: Any | None¶: Matches if the property is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the property value is any of the supplied options.

lt: Any | None¶: Matches if the property is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the property is not the supplied value.

nin: list[Any] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

Filters on equality or order comparisons of the program note Id. All supplied criteria must match, but usually only one is selected.

eq: Any | None¶: Matches if the program note id is exactly the supplied value.

gt: Any | None¶: Matches if the program note id is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the program note id is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the program note id is any of the supplied options.

lt: Any | None¶: Matches if the program note is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the program note id is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the program note id is not the supplied value.

nin: list[Any] | None¶: Matches if the program note id is none of the supplied values.

Bases: BaseModel

Filters on equality or order comparisons of the program user id. All supplied criteria must match, but usually only one is selected.

eq: Any | None¶: Matches if the program user id is exactly the supplied value.

gt: Any | None¶: Matches if the program user id is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the program user id is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the program user id is any of the supplied options.

lt: Any | None¶: Matches if the program user id is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the program user id is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the program user id is not the supplied value.

nin: list[Any] | None¶: Matches if the program user id is none of the supplied values.

Bases: BaseModel

Filters on equality or order comparisons of Semester. All supplied criteria must match, but usually only one is selected. E.g., ‘GT = “2024A”’ will match when the value is “2024B” or later.

eq: Any | None¶: Matches if the property is exactly the supplied value.

gt: Any | None¶: Matches if the property is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the property value is any of the supplied options.

lt: Any | None¶: Matches if the property is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the property is not the supplied value.

nin: list[Any] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

eq: SequenceCommand | None¶: Matches if the property is exactly the supplied value.

gt: SequenceCommand | None¶: Matches if the property is ordered after (>) the supplied value.

gte: SequenceCommand | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[SequenceCommand] | None¶: Matches if the property value is any of the supplied options.

lt: SequenceCommand | None¶: Matches if the property is ordered before (<) the supplied value.

lte: SequenceCommand | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: SequenceCommand | None¶: Matches if the property is not the supplied value.

nin: list[SequenceCommand] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

eq: SequenceType | None¶: Matches if the property is exactly the supplied value.

gt: SequenceType | None¶: Matches if the property is ordered after (>) the supplied value.

gte: SequenceType | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[SequenceType] | None¶: Matches if the property value is any of the supplied options.

lt: SequenceType | None¶: Matches if the property is ordered before (<) the supplied value.

lte: SequenceType | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: SequenceType | None¶: Matches if the property is not the supplied value.

nin: list[SequenceType] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

Filters on equality or order comparisons of the SlewStage. All supplied criteria must match, but usually only one is selected.

eq: SlewStage | None¶: Matches if the property is exactly the supplied value.

gt: SlewStage | None¶: Matches if the property is ordered after (>) the supplied value.

gte: SlewStage | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[SlewStage] | None¶: Matches if the property value is any of the supplied options.

lt: SlewStage | None¶: Matches if the property is ordered before (<) the supplied value.

lte: SlewStage | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: SlewStage | None¶: Matches if the property is not the supplied value.

nin: list[SlewStage] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

eq: StepStage | None¶: Matches if the property is exactly the supplied value.

gt: StepStage | None¶: Matches if the property is ordered after (>) the supplied value.

gte: StepStage | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[StepStage] | None¶: Matches if the property value is any of the supplied options.

lt: StepStage | None¶: Matches if the property is ordered before (<) the supplied value.

lte: StepStage | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: StepStage | None¶: Matches if the property is not the supplied value.

nin: list[StepStage] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

eq: Any | None¶: Matches if the property is exactly the supplied value.

gt: Any | None¶: Matches if the property is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the property value is any of the supplied options.

lt: Any | None¶: Matches if the property is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the property is not the supplied value.

nin: list[Any] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

eq: Any | None¶: Matches if the property is exactly the supplied value.

gt: Any | None¶: Matches if the property is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the property is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the property value is any of the supplied options.

lt: Any | None¶: Matches if the property is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the property is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the property is not the supplied value.

nin: list[Any] | None¶: Matches if the property value is none of the supplied values.

Bases: BaseModel

eq: Any | None¶: Matches if the user id is exactly the supplied value.

gt: Any | None¶: Matches if the user id is ordered after (>) the supplied value.

gte: Any | None¶: Matches if the user id is ordered after or equal (>=) the supplied value.

in_: list[Any] | None¶: Matches if the user id is any of the supplied options.

lt: Any | None¶: Matches if the user id is ordered before (<) the supplied value.

lte: Any | None¶: Matches if the user id is ordered before or equal (<=) the supplied value.

neq: Any | None¶: Matches if the user id is not the supplied value.

nin: list[Any] | None¶: Matches if the user id is none of the supplied values.

class gpp_client.generated.input_types.WherePartnerLink(*, linkType: WhereEqPartnerLinkType | None = None, partner: WhereOptionEqPartner | None = None)[source]¶

Bases: BaseModel

Partner link filter options. All specified items much match.

link_type: WhereEqPartnerLinkType | None¶: Matches on equality of the link type.

partner: WhereOptionEqPartner | None¶: Matches on the partner itself, if applicable. Only HAS_PARTNER link types will have a partner. For other link types it will be null.

class gpp_client.generated.input_types.WhereProgram(*, AND: list[WhereProgram] | None = None, OR: list[WhereProgram] | None = None, NOT: WhereProgram | None = None, id: WhereOrderProgramId | None = None, name: WhereOptionString | None = None, type: WhereEqProgramType | None = None, reference: WhereProgramReference | None = None, pi: WhereProgramUser | None = None, proposalStatus: WhereEqProposalStatus | None = None, proposal: WhereProposal | None = None, calibrationRole: WhereOptionEqCalibrationRole | None = None, activeStart: WhereOrderDate | None = None, activeEnd: WhereOrderDate | None = None)[source]¶

Bases: BaseModel

Program filter options. All specified items must match.

active_end: WhereOrderDate | None¶: Matches the active period end.

active_start: WhereOrderDate | None¶: Matches the active period start.

and_: list[WhereProgram] | None¶: A list of nested program filters that all must match in order for the AND group as a whole to match.

calibration_role: WhereOptionEqCalibrationRole | None¶: Matches the calibration role.

id: WhereOrderProgramId | None¶: Matches the program ID.

name: WhereOptionString | None¶: Matches the program name.

not_: WhereProgram | None¶: A nested program filter that must not match in order for the NOT itself to match.

or_: list[WhereProgram] | None¶: A list of nested program filters where any one match causes the entire OR group as a whole to match.

pi: WhereProgramUser | None¶: Matches the PI.

proposal: WhereProposal | None¶: Matches the proposal.

proposal_status: WhereEqProposalStatus | None¶: Matches the proposalStatus.

reference: WhereProgramReference | None¶: Matches the program reference (if any).

type_: WhereEqProgramType | None¶: Mathces the program type.

class gpp_client.generated.input_types.WhereProgramNote(*, AND: list[WhereProgramNote] | None = None, OR: list[WhereProgramNote] | None = None, NOT: WhereProgramNote | None = None, id: WhereOrderProgramNoteId | None = None, program: WhereProgram | None = None, title: WhereString | None = None, text: WhereOptionString | None = None, isPrivate: WhereBoolean | None = None)[source]¶

Bases: BaseModel

Program note filter options. All specified items must match.

and_: list[WhereProgramNote] | None¶: A list of nested program note filters that all must match in order for the AND group as a whole to match.

id: WhereOrderProgramNoteId | None¶: Matches the program note ID.

is_private: WhereBoolean | None¶: Matches the private status.

not_: WhereProgramNote | None¶: A nested program note filter that must not match in order for the NOT itself to match.

or_: list[WhereProgramNote] | None¶: A list of nested program note filters where any one match causes the entire OR group as a whole to match.

program: WhereProgram | None¶: Matches the program.

text: WhereOptionString | None¶: Mathces the program note text.

title: WhereString | None¶: Matches the program note title.

class gpp_client.generated.input_types.WhereProgramReference(*, IS_NULL: bool | None = None, label: WhereString | None = None, semester: WhereOrderSemester | None = None, semesterIndex: WhereOrderPosInt | None = None, instrument: WhereEqInstrument | None = None, description: WhereString | None = None, scienceSubtype: WhereEqScienceSubtype | None = None)[source]¶

Bases: BaseModel

description: WhereString | None¶: Matches the (library) description in the program reference, if any.

instrument: WhereEqInstrument | None¶: Matches the instrument in the program reference, if any.

is_null: bool | None¶: Matches if the program reference is not defined.

label: WhereString | None¶: Matches the program reference label.

science_subtype: WhereEqScienceSubtype | None¶: Matches the science subtype in the program reference, if any.

semester: WhereOrderSemester | None¶: Matches the semester in the proposal reference, if any.

semester_index: WhereOrderPosInt | None¶: Matches the index in the program reference, if any.

class gpp_client.generated.input_types.WhereProgramUser(*, AND: list[WhereProgramUser] | None = None, OR: list[WhereProgramUser] | None = None, NOT: WhereProgramUser | None = None, id: WhereOrderProgramUserId | None = None, program: WhereProgram | None = None, user: WhereUser | None = None, role: WhereEqProgramUserRole | None = None, partnerLink: WherePartnerLink | None = None, preferredProfile: WhereUserProfile | None = None, educationalStatus: WhereOptionEqEducationalStatus | None = None, thesis: WhereOptionBoolean | None = None, gender: WhereOptionEqGender | None = None, hasDataAccess: WhereBoolean | None = None)[source]¶

Bases: BaseModel

Program user options. All specified items must match.

and_: list[WhereProgramUser] | None¶: A list of nested program user filters that all must match in order for the AND group as a whole to match.

educational_status: WhereOptionEqEducationalStatus | None¶: Matches the educational status.

gender: WhereOptionEqGender | None¶: Matches the gender status.

has_data_access: WhereBoolean | None¶: Matches the data access flag.

id: WhereOrderProgramUserId | None¶: Matches the program user id.

not_: WhereProgramUser | None¶: A nested program user filter that must not match in order for the NOT itself to match.

or_: list[WhereProgramUser] | None¶: A list of nested program user filters where any one match causes the entire OR group as a whole to match.

partner_link: WherePartnerLink | None¶: Matches the partner.

preferred_profile: WhereUserProfile | None¶: Matches the preferred profile.

program: WhereProgram | None¶: Matches the program.

role: WhereEqProgramUserRole | None¶: Matches the role.

thesis: WhereOptionBoolean | None¶: Matches the thesis flag.

user: WhereUser | None¶: Matches the user.

class gpp_client.generated.input_types.WhereProposal(*, IS_NULL: bool | None = None, AND: list[WhereProposal] | None = None, OR: list[WhereProposal] | None = None, NOT: WhereProposal | None = None, title: WhereOptionString | None = None, reference: WhereProposalReference | None = None, call: WhereCallForProposals | None = None)[source]¶

Bases: BaseModel

Proposal filter options. All specified items must match.

and_: list[WhereProposal] | None¶: A list of nested proposal filters that all must match in order for the AND group as a whole to match.

call: WhereCallForProposals | None¶: Matches on the CfP details (if any).

is_null: bool | None¶: When true, matches if the proposal is not defined. When false matches if the proposal is defined.

not_: WhereProposal | None¶: A nested proposal filter that must not match in order for the NOT itself to match.

or_: list[WhereProposal] | None¶: A list of nested proposal filters where any one match causes the entire OR group as a whole to match.

reference: WhereProposalReference | None¶: Matches on the proposal reference (if any).

title: WhereOptionString | None¶: Matches the proposal title.

class gpp_client.generated.input_types.WhereProposalPartnerEntry(*, AND: list[WhereProposalPartnerEntry] | None = None, OR: list[WhereProposalPartnerEntry] | None = None, NOT: WhereProposalPartnerEntry | None = None, partner: WhereEqPartner | None = None, percent: WhereOrderInt | None = None)[source]¶

Bases: BaseModel

Proposal partner entry filter options. The set of partners is scanned for a matching partner and percentage entry.

and_: list[WhereProposalPartnerEntry] | None¶: A list of nested partner entry filters that all must match in order for the AND group as a whole to match.

not_: WhereProposalPartnerEntry | None¶: A nested partner entry filter that must not match in order for the NOT itself to match.

or_: list[WhereProposalPartnerEntry] | None¶: A list of nested partner entry filters where any one match causes the entire OR group as a whole to match.

partner: WhereEqPartner | None¶: Matches on partner equality

percent: WhereOrderInt | None¶: Matches on partner percentage

class gpp_client.generated.input_types.WhereProposalPartners(*, MATCH: WhereProposalPartnerEntry | None = None, EQ: list[Partner] | None = None, isJoint: bool | None = None)[source]¶

Bases: BaseModel

Proposal partners matching. Use MATCH for detailed matching options, EQ to just match against a partners list, and/or isJoint for checking joint vs individual proposals

eq: list[Partner] | None¶: A simple exact match for the supplied partners. Use MATCH instead for more advanced options.

is_joint: bool | None¶: Matching based on whether the proposal is a joint (i.e., multi-partner) proposal.

match: WhereProposalPartnerEntry | None¶: Detailed partner matching. Use EQ instead of a simple exact match.

class gpp_client.generated.input_types.WhereProposalReference(*, IS_NULL: bool | None = None, label: WhereString | None = None, semester: WhereOrderSemester | None = None, semesterIndex: WhereOrderPosInt | None = None)[source]¶

Bases: BaseModel

is_null: bool | None¶: Matches if the proposal reference is not defined.

label: WhereString | None¶: Matches the proposal reference label.

semester: WhereOrderSemester | None¶: Matches the semester in the proposal reference.

semester_index: WhereOrderPosInt | None¶: Matches the index in the proposal reference.

class gpp_client.generated.input_types.WhereSpectroscopyConfigOption(*, AND: list[WhereSpectroscopyConfigOption] | None = None, OR: list[WhereSpectroscopyConfigOption] | None = None, NOT: WhereSpectroscopyConfigOption | None = None, adaptiveOptics: WhereBoolean | None = None, capability: WhereOptionEqSpectroscopyCapabilities | None = None, focalPlane: WhereEqFocalPlane | None = None, instrument: WhereEqInstrument | None = None, resolution: WhereOrderPosInt | None = None, site: WhereEqSite | None = None, slitLength: WhereAngle | None = None, slitWidth: WhereAngle | None = None, rangeIncludes: WavelengthInput | None = None, wavelengthOptimal: WhereWavelength | None = None, wavelengthCoverage: WhereWavelength | None = None)[source]¶

Bases: BaseModel

Spectroscopy instrument configuration option matcher. Configure with the properties of interest and pass it to the ‘spectroscopyConfigOptions’ query to find the corresponding configuration options.

adaptive_optics: WhereBoolean | None¶

and_: list[WhereSpectroscopyConfigOption] | None¶

capability: WhereOptionEqSpectroscopyCapabilities | None¶

focal_plane: WhereEqFocalPlane | None¶

instrument: WhereEqInstrument | None¶

not_: WhereSpectroscopyConfigOption | None¶

or_: list[WhereSpectroscopyConfigOption] | None¶

range_includes: WavelengthInput | None¶: Matches configuration options that support the provided wavelength. In other words, those for which the given wavelength falls between the min and max limits of the configuration.

resolution: WhereOrderPosInt | None¶

site: WhereEqSite | None¶

slit_length: WhereAngle | None¶

slit_width: WhereAngle | None¶

wavelength_coverage: WhereWavelength | None¶

wavelength_optimal: WhereWavelength | None¶

Bases: BaseModel

String matching options.

eq: Any | None¶

in_: list[Any] | None¶

like: Any | None¶: Performs string matching with wildcard patterns. The entire string must be matched. Use % to match a sequence of any characters and _ to match any single character.

match_case: bool | None¶: Set to true (the default) for case sensitive matches, false to ignore case.

neq: Any | None¶

nin: list[Any] | None¶

nlike: Any | None¶: Performs string matching with wildcard patterns. The entire string must not match. Use % to match a sequence of any characters and _ to match any single character.

class gpp_client.generated.input_types.WhereTarget(*, AND: list[WhereTarget] | None = None, OR: list[WhereTarget] | None = None, NOT: WhereTarget | None = None, id: WhereOrderTargetId | None = None, program: WhereProgram | None = None, name: WhereString | None = None, disposition: WhereEqTargetDisposition | None = None, calibrationRole: WhereOptionEqCalibrationRole | None = None)[source]¶

Bases: BaseModel

Target filter options. All specified items must match.

and_: list[WhereTarget] | None¶: A list of nested target filters that all must match in order for the AND group as a whole to match.

calibration_role: WhereOptionEqCalibrationRole | None¶: Matches the calibration role.

disposition: WhereEqTargetDisposition | None¶: Matches the target disposition.

id: WhereOrderTargetId | None¶: Matches the target id.

name: WhereString | None¶: Matches the target name.

not_: WhereTarget | None¶: A nested target filter that must not match in order for the NOT itself to match.

or_: list[WhereTarget] | None¶: A list of nested target filters where any one match causes the entire OR group as a whole to match.

program: WhereProgram | None¶: Matches the associated program.

Bases: BaseModel

User filter options. All specified items must match.

and_: list[WhereUser] | None¶: A list of nested user filters that all must match in order for the AND group as a whole to match.

id: WhereOrderUserId | None¶: Matches the user Id.

is_null: bool | None¶: When true, matches if the user is not defined. When false matches if the user is defined.

not_: WhereUser | None¶: A nested user filter that must not match in order for the NOT itself to match.

or_: list[WhereUser] | None¶: A list of nested user filters that all must match in order for the OR group as a whole to match.

orcid_id: WhereOptionString | None¶

profile: WhereUserProfile | None¶

type_: WhereEqUserType | None¶: Matches the user type.

class gpp_client.generated.input_types.WhereUserProfile(*, givenName: WhereOptionString | None = None, creditName: WhereOptionString | None = None, familyName: WhereOptionString | None = None, email: WhereOptionString | None = None)[source]¶

Bases: BaseModel

credit_name: WhereOptionString | None¶

email: WhereOptionString | None¶

family_name: WhereOptionString | None¶

given_name: WhereOptionString | None¶

class gpp_client.generated.input_types.WhereWavelength(*, AND: list[WhereWavelength] | None = None, OR: list[WhereWavelength] | None = None, NOT: WhereWavelength | None = None, picometers: WhereOrderPosInt | None = None, angstroms: WhereOrderPosBigDecimal | None = None, nanometers: WhereOrderPosBigDecimal | None = None, micrometers: WhereOrderPosBigDecimal | None = None)[source]¶

Bases: BaseModel

and_: list[WhereWavelength] | None¶

angstroms: WhereOrderPosBigDecimal | None¶

micrometers: WhereOrderPosBigDecimal | None¶

nanometers: WhereOrderPosBigDecimal | None¶

not_: WhereWavelength | None¶

or_: list[WhereWavelength] | None¶

picometers: WhereOrderPosInt | None¶