Field Builders¶
The gpp_client.generated.custom_fields module provides utilities for constructing GraphQL field
selection trees when building custom queries and mutations.
These classes are primarily used for advanced GraphQL customization when the default generated operations do not provide the desired field selection.
API Reference¶
- class gpp_client.generated.custom_fields.AddConditionsEntryResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) AddConditionsEntryResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod conditions_entry() ConditionsEntryFields[source]¶
- fields(*subfields: AddConditionsEntryResultGraphQLField | ConditionsEntryFields) AddConditionsEntryResultFields[source]¶
Subfields should come from the AddConditionsEntryResultFields class
- class gpp_client.generated.custom_fields.AddDatasetEventResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of adding a dataset event.
- alias(alias: str) AddDatasetEventResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod event() DatasetEventFields[source]¶
The new dataset event that was added.
- fields(*subfields: AddDatasetEventResultGraphQLField | DatasetEventFields) AddDatasetEventResultFields[source]¶
Subfields should come from the AddDatasetEventResultFields class
- class gpp_client.generated.custom_fields.AddProgramUserResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) AddProgramUserResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: AddProgramUserResultGraphQLField | ProgramUserFields) AddProgramUserResultFields[source]¶
Subfields should come from the AddProgramUserResultFields class
- classmethod program_user() ProgramUserFields[source]¶
- class gpp_client.generated.custom_fields.AddSequenceEventResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of adding a sequence event.
- alias(alias: str) AddSequenceEventResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod event() SequenceEventFields[source]¶
The new sequence event that was added.
- fields(*subfields: AddSequenceEventResultGraphQLField | SequenceEventFields) AddSequenceEventResultFields[source]¶
Subfields should come from the AddSequenceEventResultFields class
- class gpp_client.generated.custom_fields.AddSlewEventResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of adding a slew event.
- alias(alias: str) AddSlewEventResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod event() SlewEventFields[source]¶
The new slew event that was added.
- fields(*subfields: AddSlewEventResultGraphQLField | SlewEventFields) AddSlewEventResultFields[source]¶
Subfields should come from the AddSlewEventResultFields class
- class gpp_client.generated.custom_fields.AddStepEventResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of adding a step event.
- alias(alias: str) AddStepEventResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod event() StepEventFields[source]¶
The new step event that was added.
- fields(*subfields: AddStepEventResultGraphQLField | StepEventFields) AddStepEventResultFields[source]¶
Subfields should come from the AddStepEventResultFields class
- class gpp_client.generated.custom_fields.AddTimeChargeCorrectionResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of the ‘addTimeChargeCorrection’ mutation. It contains the visit’s updated TimeChargeInvoice after applying the correction.
- alias(alias: str) AddTimeChargeCorrectionResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: AddTimeChargeCorrectionResultGraphQLField | TimeChargeInvoiceFields) AddTimeChargeCorrectionResultFields[source]¶
Subfields should come from the AddTimeChargeCorrectionResultFields class
- classmethod time_charge_invoice() TimeChargeInvoiceFields[source]¶
- class gpp_client.generated.custom_fields.AirMassRangeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) AirMassRangeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: AirMassRangeGraphQLField) AirMassRangeFields[source]¶
Subfields should come from the AirMassRangeFields class
- max: AirMassRangeGraphQLField = <gpp_client.generated.custom_typing_fields.AirMassRangeGraphQLField object>¶
Maximum AirMass (unitless)
- min: AirMassRangeGraphQLField = <gpp_client.generated.custom_typing_fields.AirMassRangeGraphQLField object>¶
Minimum AirMass (unitless)
- class gpp_client.generated.custom_fields.AllConfigChangeEstimatesFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldTime taken to update the configuration before a step is executed.
- alias(alias: str) AllConfigChangeEstimatesFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod all() ConfigChangeEstimateFields[source]¶
Complete collection of items that changed. The selected estimate will be one of the longest (there may be multiple estimates tied for the longest).
- classmethod estimate() TimeSpanFields[source]¶
Time required for the collection of estimates in all. This should be the max of the individual entries because the execution happens in parallel.
- fields(*subfields: AllConfigChangeEstimatesGraphQLField | ConfigChangeEstimateFields | TimeSpanFields) AllConfigChangeEstimatesFields[source]¶
Subfields should come from the AllConfigChangeEstimatesFields class
- index: AllConfigChangeEstimatesGraphQLField = <gpp_client.generated.custom_typing_fields.AllConfigChangeEstimatesGraphQLField object>¶
Index of the selected config change estimate amongst all the estimates in all.
- classmethod selected() ConfigChangeEstimateFields[source]¶
The selected ConfigChangeEstimate is a maximum of all the config change estimates. In other words, one that takes the longest.
- class gpp_client.generated.custom_fields.AllDetectorEstimatesFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe collection of detector estimates involved in an individual step.
- alias(alias: str) AllDetectorEstimatesFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod all() DetectorEstimateFields[source]¶
Complete collection of detectors involved in a step. The selected estimate will be one of the longest (there may be multiple estimates tied for the longest).
- classmethod estimate() TimeSpanFields[source]¶
Time required for the collection of estimates in all. This should be the max of the individual entries because the execution happens in parallel.
- fields(*subfields: AllDetectorEstimatesGraphQLField | DetectorEstimateFields | TimeSpanFields) AllDetectorEstimatesFields[source]¶
Subfields should come from the AllDetectorEstimatesFields class
- index: AllDetectorEstimatesGraphQLField = <gpp_client.generated.custom_typing_fields.AllDetectorEstimatesGraphQLField object>¶
Index of the selected detector estimate amongst all the estimates in all.
- classmethod selected() DetectorEstimateFields[source]¶
The selected DetectorEstimate is a maximum of all the detector estimates. In other words, one that takes the longest.
- class gpp_client.generated.custom_fields.AllocationFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldAn individual time allocation.
- alias(alias: str) AllocationFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- category: AllocationGraphQLField = <gpp_client.generated.custom_typing_fields.AllocationGraphQLField object>¶
- classmethod duration() TimeSpanFields[source]¶
- fields(*subfields: AllocationGraphQLField | TimeSpanFields) AllocationFields[source]¶
Subfields should come from the AllocationFields class
- science_band: AllocationGraphQLField = <gpp_client.generated.custom_typing_fields.AllocationGraphQLField object>¶
- class gpp_client.generated.custom_fields.AngleFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) AngleFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- arcminutes: AngleGraphQLField = <gpp_client.generated.custom_typing_fields.AngleGraphQLField object>¶
Angle in amin
- arcseconds: AngleGraphQLField = <gpp_client.generated.custom_typing_fields.AngleGraphQLField object>¶
Angle in asec
- degrees: AngleGraphQLField = <gpp_client.generated.custom_typing_fields.AngleGraphQLField object>¶
Angle in deg
- dms: AngleGraphQLField = <gpp_client.generated.custom_typing_fields.AngleGraphQLField object>¶
SS
- Type:
Angle in DD
- Type:
MM
- fields(*subfields: AngleGraphQLField) AngleFields[source]¶
Subfields should come from the AngleFields class
- hms: AngleGraphQLField = <gpp_client.generated.custom_typing_fields.AngleGraphQLField object>¶
SS
- Type:
Angle in HH
- Type:
MM
- hours: AngleGraphQLField = <gpp_client.generated.custom_typing_fields.AngleGraphQLField object>¶
Angle in hrs
- microarcseconds: AngleGraphQLField = <gpp_client.generated.custom_typing_fields.AngleGraphQLField object>¶
Angle in µas
- microseconds: AngleGraphQLField = <gpp_client.generated.custom_typing_fields.AngleGraphQLField object>¶
Angle in µs
- milliarcseconds: AngleGraphQLField = <gpp_client.generated.custom_typing_fields.AngleGraphQLField object>¶
Angle in mas
- milliseconds: AngleGraphQLField = <gpp_client.generated.custom_typing_fields.AngleGraphQLField object>¶
Angle in ms
- minutes: AngleGraphQLField = <gpp_client.generated.custom_typing_fields.AngleGraphQLField object>¶
Angle in min
- seconds: AngleGraphQLField = <gpp_client.generated.custom_typing_fields.AngleGraphQLField object>¶
Angle in sec
- class gpp_client.generated.custom_fields.AsterismGroupFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) AsterismGroupFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod asterism() TargetFields[source]¶
Commonly held value across the observations
- fields(*subfields: AsterismGroupGraphQLField | ObservationSelectResultFields | ProgramFields | TargetFields) AsterismGroupFields[source]¶
Subfields should come from the AsterismGroupFields class
- classmethod observations(include_deleted: bool, *, offset: Any | None = None, limit: Any | None = None) ObservationSelectResultFields[source]¶
Observations associated with the common value
- classmethod program() ProgramFields[source]¶
- class gpp_client.generated.custom_fields.AsterismGroupSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe matching asterismGroup results, limited to a maximum of 1000 entries.
- alias(alias: str) AsterismGroupSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: AsterismGroupSelectResultGraphQLField | AsterismGroupFields) AsterismGroupSelectResultFields[source]¶
Subfields should come from the AsterismGroupSelectResultFields class
- has_more: AsterismGroupSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.AsterismGroupSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() AsterismGroupFields[source]¶
Matching asterismGroups up to the return size limit of 1000
- class gpp_client.generated.custom_fields.AtomEventFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldAtom-level events. The execution of a single atom will generate multiple events.
- alias(alias: str) AtomEventFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod atom() AtomRecordFields[source]¶
Atom record associated with this event, if any. Atom records only materialize when the steps they contain execute.
- atom_stage: AtomEventGraphQLField = <gpp_client.generated.custom_typing_fields.AtomEventGraphQLField object>¶
Atom execution stage.
- event_type: AtomEventGraphQLField = <gpp_client.generated.custom_typing_fields.AtomEventGraphQLField object>¶
Event type.
- fields(*subfields: AtomEventGraphQLField | AtomRecordFields | ObservationFields | VisitFields) AtomEventFields[source]¶
Subfields should come from the AtomEventFields class
- id: AtomEventGraphQLField = <gpp_client.generated.custom_typing_fields.AtomEventGraphQLField object>¶
Event id.
- idempotency_key: AtomEventGraphQLField = <gpp_client.generated.custom_typing_fields.AtomEventGraphQLField object>¶
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.
- classmethod observation() ObservationFields[source]¶
Observation whose execution produced this event.
- received: AtomEventGraphQLField = <gpp_client.generated.custom_typing_fields.AtomEventGraphQLField object>¶
Time at which this event was received.
- classmethod visit() VisitFields[source]¶
Visit associated with the event.
- class gpp_client.generated.custom_fields.AtomRecordFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe portion of an atom that executed in a particular visit.
- alias(alias: str) AtomRecordFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- description: AtomRecordGraphQLField = <gpp_client.generated.custom_typing_fields.AtomRecordGraphQLField object>¶
Description, if any.
- execution_state: AtomRecordGraphQLField = <gpp_client.generated.custom_typing_fields.AtomRecordGraphQLField object>¶
The execution state of this atom, according to events received (if any) from Observe.
- fields(*subfields: AtomRecordGraphQLField | ObservationFields | StepRecordSelectResultFields | TimestampIntervalFields | VisitFields) AtomRecordFields[source]¶
Subfields should come from the AtomRecordFields class
- id: AtomRecordGraphQLField = <gpp_client.generated.custom_typing_fields.AtomRecordGraphQLField object>¶
Atom ID.
- index: AtomRecordGraphQLField = <gpp_client.generated.custom_typing_fields.AtomRecordGraphQLField object>¶
Atom execution order – the index of its first executed step.
- instrument: AtomRecordGraphQLField = <gpp_client.generated.custom_typing_fields.AtomRecordGraphQLField object>¶
The instrument associated with this atom.
- classmethod interval() TimestampIntervalFields[source]¶
Time interval during which this atom executed.
- classmethod observation() ObservationFields[source]¶
Observation containing this atom.
- sequence_type: AtomRecordGraphQLField = <gpp_client.generated.custom_typing_fields.AtomRecordGraphQLField object>¶
Sequence type.
- classmethod steps(*, offset: Any | None = None, limit: Any | None = None) StepRecordSelectResultFields[source]¶
Recorded steps associated with this atom, ordered by execution order.
- classmethod visit() VisitFields[source]¶
Visit in which this atom executed.
- class gpp_client.generated.custom_fields.AtomRecordSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldAtomRecord query results, limited to a maximum of 1000 entries.
- alias(alias: str) AtomRecordSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: AtomRecordSelectResultGraphQLField | AtomRecordFields) AtomRecordSelectResultFields[source]¶
Subfields should come from the AtomRecordSelectResultFields class
- has_more: AtomRecordSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.AtomRecordSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() AtomRecordFields[source]¶
Matching atom records up to the return size limit of 1000.
- class gpp_client.generated.custom_fields.AttachmentFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldAttachment
- alias(alias: str) AttachmentFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- attachment_type: AttachmentGraphQLField = <gpp_client.generated.custom_typing_fields.AttachmentGraphQLField object>¶
- checked: AttachmentGraphQLField = <gpp_client.generated.custom_typing_fields.AttachmentGraphQLField object>¶
- description: AttachmentGraphQLField = <gpp_client.generated.custom_typing_fields.AttachmentGraphQLField object>¶
- fields(*subfields: AttachmentGraphQLField | ProgramFields) AttachmentFields[source]¶
Subfields should come from the AttachmentFields class
- file_name: AttachmentGraphQLField = <gpp_client.generated.custom_typing_fields.AttachmentGraphQLField object>¶
- file_size: AttachmentGraphQLField = <gpp_client.generated.custom_typing_fields.AttachmentGraphQLField object>¶
- id: AttachmentGraphQLField = <gpp_client.generated.custom_typing_fields.AttachmentGraphQLField object>¶
- classmethod program() ProgramFields[source]¶
- updated_at: AttachmentGraphQLField = <gpp_client.generated.custom_typing_fields.AttachmentGraphQLField object>¶
- class gpp_client.generated.custom_fields.BandBrightnessIntegratedFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) BandBrightnessIntegratedFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- band: BandBrightnessIntegratedGraphQLField = <gpp_client.generated.custom_typing_fields.BandBrightnessIntegratedGraphQLField object>¶
Magnitude band
- error: BandBrightnessIntegratedGraphQLField = <gpp_client.generated.custom_typing_fields.BandBrightnessIntegratedGraphQLField object>¶
Error, if any
- fields(*subfields: BandBrightnessIntegratedGraphQLField) BandBrightnessIntegratedFields[source]¶
Subfields should come from the BandBrightnessIntegratedFields class
- units: BandBrightnessIntegratedGraphQLField = <gpp_client.generated.custom_typing_fields.BandBrightnessIntegratedGraphQLField object>¶
- value: BandBrightnessIntegratedGraphQLField = <gpp_client.generated.custom_typing_fields.BandBrightnessIntegratedGraphQLField object>¶
- class gpp_client.generated.custom_fields.BandBrightnessSurfaceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) BandBrightnessSurfaceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- band: BandBrightnessSurfaceGraphQLField = <gpp_client.generated.custom_typing_fields.BandBrightnessSurfaceGraphQLField object>¶
Magnitude band
- error: BandBrightnessSurfaceGraphQLField = <gpp_client.generated.custom_typing_fields.BandBrightnessSurfaceGraphQLField object>¶
Error, if any
- fields(*subfields: BandBrightnessSurfaceGraphQLField) BandBrightnessSurfaceFields[source]¶
Subfields should come from the BandBrightnessSurfaceFields class
- units: BandBrightnessSurfaceGraphQLField = <gpp_client.generated.custom_typing_fields.BandBrightnessSurfaceGraphQLField object>¶
- value: BandBrightnessSurfaceGraphQLField = <gpp_client.generated.custom_typing_fields.BandBrightnessSurfaceGraphQLField object>¶
- class gpp_client.generated.custom_fields.BandNormalizedIntegratedFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) BandNormalizedIntegratedFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod brightnesses() BandBrightnessIntegratedFields[source]¶
- fields(*subfields: BandNormalizedIntegratedGraphQLField | BandBrightnessIntegratedFields | UnnormalizedSedFields) BandNormalizedIntegratedFields[source]¶
Subfields should come from the BandNormalizedIntegratedFields class
- classmethod sed() UnnormalizedSedFields[source]¶
Un-normalized spectral energy distribution
- class gpp_client.generated.custom_fields.BandNormalizedInterface(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldBand normalized common interface
- alias(alias: str) BandNormalizedInterface[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: BandNormalizedGraphQLField | UnnormalizedSedFields) BandNormalizedInterface[source]¶
Subfields should come from the BandNormalizedInterface class
- on(type_name: str, *subfields: GraphQLField) BandNormalizedInterface[source]¶
- classmethod sed() UnnormalizedSedFields[source]¶
Un-normalized spectral energy distribution
- class gpp_client.generated.custom_fields.BandNormalizedSurfaceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) BandNormalizedSurfaceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod brightnesses() BandBrightnessSurfaceFields[source]¶
- fields(*subfields: BandNormalizedSurfaceGraphQLField | BandBrightnessSurfaceFields | UnnormalizedSedFields) BandNormalizedSurfaceFields[source]¶
Subfields should come from the BandNormalizedSurfaceFields class
- classmethod sed() UnnormalizedSedFields[source]¶
Un-normalized spectral energy distribution
- class gpp_client.generated.custom_fields.BandedTimeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldCategorizedTime grouped with a ScienceBand. A program may contain multiple observations in distinct bands. Time accounting at the program level must distinguish time spent in observations of each of these bands.
- alias(alias: str) BandedTimeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- band: BandedTimeGraphQLField = <gpp_client.generated.custom_typing_fields.BandedTimeGraphQLField object>¶
ScienceBand associated with the time, if any.
- fields(*subfields: BandedTimeGraphQLField | CategorizedTimeFields) BandedTimeFields[source]¶
Subfields should come from the BandedTimeFields class
- classmethod time() CategorizedTimeFields[source]¶
Time distributed across the program and non-charged categories.
- class gpp_client.generated.custom_fields.BiasFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldBias calibration step
- alias(alias: str) BiasFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: BiasGraphQLField) BiasFields[source]¶
Subfields should come from the BiasFields class
- step_type: BiasGraphQLField = <gpp_client.generated.custom_typing_fields.BiasGraphQLField object>¶
Step type
- class gpp_client.generated.custom_fields.CalculatedBandedTimeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA BandedTime that is automatically updated by a background process.
- alias(alias: str) CalculatedBandedTimeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- calculation_state: CalculatedBandedTimeGraphQLField = <gpp_client.generated.custom_typing_fields.CalculatedBandedTimeGraphQLField object>¶
The current state of the background calculation.
- fields(*subfields: CalculatedBandedTimeGraphQLField | BandedTimeFields) CalculatedBandedTimeFields[source]¶
Subfields should come from the CalculatedBandedTimeFields class
- state: CalculatedBandedTimeGraphQLField = <gpp_client.generated.custom_typing_fields.CalculatedBandedTimeGraphQLField object>¶
The current state of the background calculation.
- classmethod value() BandedTimeFields[source]¶
- class gpp_client.generated.custom_fields.CalculatedCategorizedTimeRangeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA CategorizedTimeRange that is automatically updated by a background process.
- alias(alias: str) CalculatedCategorizedTimeRangeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- calculation_state: CalculatedCategorizedTimeRangeGraphQLField = <gpp_client.generated.custom_typing_fields.CalculatedCategorizedTimeRangeGraphQLField object>¶
The current state of the background calculation.
- fields(*subfields: CalculatedCategorizedTimeRangeGraphQLField | CategorizedTimeRangeFields) CalculatedCategorizedTimeRangeFields[source]¶
Subfields should come from the CalculatedCategorizedTimeRangeFields class
- state: CalculatedCategorizedTimeRangeGraphQLField = <gpp_client.generated.custom_typing_fields.CalculatedCategorizedTimeRangeGraphQLField object>¶
The current state of the background calculation.
- classmethod value() CategorizedTimeRangeFields[source]¶
- class gpp_client.generated.custom_fields.CalculatedExecutionDigestFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldWraps an ExecutionDigest with the background calculation state.
- alias(alias: str) CalculatedExecutionDigestFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- calculation_state: CalculatedExecutionDigestGraphQLField = <gpp_client.generated.custom_typing_fields.CalculatedExecutionDigestGraphQLField object>¶
Background calculation state.
- fields(*subfields: CalculatedExecutionDigestGraphQLField | ExecutionDigestFields) CalculatedExecutionDigestFields[source]¶
Subfields should come from the CalculatedExecutionDigestFields class
- state: CalculatedExecutionDigestGraphQLField = <gpp_client.generated.custom_typing_fields.CalculatedExecutionDigestGraphQLField object>¶
Background calculation state.
- classmethod value() ExecutionDigestFields[source]¶
The current execution digest itself.
- class gpp_client.generated.custom_fields.CalculatedObservationWorkflowFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) CalculatedObservationWorkflowFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- calculation_state: CalculatedObservationWorkflowGraphQLField = <gpp_client.generated.custom_typing_fields.CalculatedObservationWorkflowGraphQLField object>¶
The current state of the background calculation.
- fields(*subfields: CalculatedObservationWorkflowGraphQLField | ObservationWorkflowFields) CalculatedObservationWorkflowFields[source]¶
Subfields should come from the CalculatedObservationWorkflowFields class
- state: CalculatedObservationWorkflowGraphQLField = <gpp_client.generated.custom_typing_fields.CalculatedObservationWorkflowGraphQLField object>¶
The current state of the background calculation.
- classmethod value() ObservationWorkflowFields[source]¶
- class gpp_client.generated.custom_fields.CalibrationProgramReferenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) CalibrationProgramReferenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CalibrationProgramReferenceGraphQLField) CalibrationProgramReferenceFields[source]¶
Subfields should come from the CalibrationProgramReferenceFields class
- instrument: CalibrationProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.CalibrationProgramReferenceGraphQLField object>¶
- label: CalibrationProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.CalibrationProgramReferenceGraphQLField object>¶
- semester: CalibrationProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.CalibrationProgramReferenceGraphQLField object>¶
- semester_index: CalibrationProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.CalibrationProgramReferenceGraphQLField object>¶
- type_: CalibrationProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.CalibrationProgramReferenceGraphQLField object>¶
- class gpp_client.generated.custom_fields.CallForProposalsFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA single Call for Proposals definition.
- classmethod active() DateIntervalFields[source]¶
The active period during which accepted observations for this call may be observed.
- alias(alias: str) CallForProposalsFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- allows_non_partner_pi: CallForProposalsGraphQLField = <gpp_client.generated.custom_typing_fields.CallForProposalsGraphQLField object>¶
Whether this Call allows PIs without a partner to participate.
- classmethod coordinate_limits() SiteCoordinateLimitsFields[source]¶
Coordinate limits for targets that may be observed in this Call for Proposals.
- existence: CallForProposalsGraphQLField = <gpp_client.generated.custom_typing_fields.CallForProposalsGraphQLField object>¶
Whether this Call is PRESENT or has been DELETED.
- fields(*subfields: CallForProposalsGraphQLField | CallForProposalsPartnerFields | DateIntervalFields | SiteCoordinateLimitsFields) CallForProposalsFields[source]¶
Subfields should come from the CallForProposalsFields class
- id: CallForProposalsGraphQLField = <gpp_client.generated.custom_typing_fields.CallForProposalsGraphQLField object>¶
The unique Call for Proposals id associated with this Call.
- instruments: CallForProposalsGraphQLField = <gpp_client.generated.custom_typing_fields.CallForProposalsGraphQLField object>¶
When specified, the observations executed in this Call will only use these instruments. When not specified, all otherwise available instruments may be used.
- non_partner_deadline: CallForProposalsGraphQLField = <gpp_client.generated.custom_typing_fields.CallForProposalsGraphQLField object>¶
The submission deadline for non-partner PIs, when allowed to participate.
- classmethod partners() CallForProposalsPartnerFields[source]¶
Partners that may participate in this Call.
- proprietary_months: CallForProposalsGraphQLField = <gpp_client.generated.custom_typing_fields.CallForProposalsGraphQLField object>¶
Default proprietary period to use for propograms linked to this Call.
- semester: CallForProposalsGraphQLField = <gpp_client.generated.custom_typing_fields.CallForProposalsGraphQLField object>¶
The semester associated with the Call. Some types may have multiple Calls per semester.
- submission_deadline_default: CallForProposalsGraphQLField = <gpp_client.generated.custom_typing_fields.CallForProposalsGraphQLField object>¶
The submission deadline to use for any partners without an explicit partner deadline.
- title: CallForProposalsGraphQLField = <gpp_client.generated.custom_typing_fields.CallForProposalsGraphQLField object>¶
The title of this Call for Proposals.
- type_: CallForProposalsGraphQLField = <gpp_client.generated.custom_typing_fields.CallForProposalsGraphQLField object>¶
Describes which type of proposals are being accepted.
- class gpp_client.generated.custom_fields.CallForProposalsPartnerFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGroups a partner with its submission deadline.
- alias(alias: str) CallForProposalsPartnerFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CallForProposalsPartnerGraphQLField) CallForProposalsPartnerFields[source]¶
Subfields should come from the CallForProposalsPartnerFields class
- partner: CallForProposalsPartnerGraphQLField = <gpp_client.generated.custom_typing_fields.CallForProposalsPartnerGraphQLField object>¶
- submission_deadline: CallForProposalsPartnerGraphQLField = <gpp_client.generated.custom_typing_fields.CallForProposalsPartnerGraphQLField object>¶
The submission deadline for this partner. This will be the ‘submissionDeadlineOverride’ if specified, but otherwise the ‘submissionDeadlineDefault’ of the Call for Proposals itself.
- submission_deadline_override: CallForProposalsPartnerGraphQLField = <gpp_client.generated.custom_typing_fields.CallForProposalsPartnerGraphQLField object>¶
Sets the submission deadline for this partner, overriding the ‘submissionDeadlineDefault’ for the Call for Proposals.
- class gpp_client.generated.custom_fields.CallsForProposalsSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) CallsForProposalsSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CallsForProposalsSelectResultGraphQLField | CallForProposalsFields) CallsForProposalsSelectResultFields[source]¶
Subfields should come from the CallsForProposalsSelectResultFields class
- has_more: CallsForProposalsSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.CallsForProposalsSelectResultGraphQLField object>¶
- classmethod matches() CallForProposalsFields[source]¶
- class gpp_client.generated.custom_fields.CatalogInfoFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) CatalogInfoFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CatalogInfoGraphQLField) CatalogInfoFields[source]¶
Subfields should come from the CatalogInfoFields class
- id: CatalogInfoGraphQLField = <gpp_client.generated.custom_typing_fields.CatalogInfoGraphQLField object>¶
Catalog id string
- name: CatalogInfoGraphQLField = <gpp_client.generated.custom_typing_fields.CatalogInfoGraphQLField object>¶
Catalog name option
- object_type: CatalogInfoGraphQLField = <gpp_client.generated.custom_typing_fields.CatalogInfoGraphQLField object>¶
Catalog description of object morphology
- class gpp_client.generated.custom_fields.CategorizedTimeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA time amount broken into charge class categories.
- alias(alias: str) CategorizedTimeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CategorizedTimeGraphQLField | TimeSpanFields) CategorizedTimeFields[source]¶
Subfields should come from the CategorizedTimeFields class
- classmethod non_charged() TimeSpanFields[source]¶
Execution time that is not charged.
- classmethod program() TimeSpanFields[source]¶
Time charged to the program / PI.
- classmethod total() TimeSpanFields[source]¶
Total of program and uncharged times.
- class gpp_client.generated.custom_fields.CategorizedTimeRangeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA minimum to maximum categorized time estimate. The actual execution time should vary between the two extremes, depending upon which observations and groups are ultimately completed.
- alias(alias: str) CategorizedTimeRangeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CategorizedTimeRangeGraphQLField | CategorizedTimeFields) CategorizedTimeRangeFields[source]¶
Subfields should come from the CategorizedTimeRangeFields class
- classmethod maximum() CategorizedTimeFields[source]¶
Maximum remaining time estimate.
- classmethod minimum() CategorizedTimeFields[source]¶
Minimum remaining time estimate.
- class gpp_client.generated.custom_fields.ChangeProgramUserRoleResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldResult of the program user role update, which is the updated program user itself.
- alias(alias: str) ChangeProgramUserRoleResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ChangeProgramUserRoleResultGraphQLField | ProgramUserFields) ChangeProgramUserRoleResultFields[source]¶
Subfields should come from the ChangeProgramUserRoleResultFields class
- classmethod program_user() ProgramUserFields[source]¶
- class gpp_client.generated.custom_fields.ClassicalFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldProposal properties for Regular Semester (Classical) CallForProposals.
- aeon_multi_facility: ClassicalGraphQLField = <gpp_client.generated.custom_typing_fields.ClassicalGraphQLField object>¶
Whether this proposal is part of the AEON/Multi-facility program.
- alias(alias: str) ClassicalFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- consider_for_band_3: ClassicalGraphQLField = <gpp_client.generated.custom_typing_fields.ClassicalGraphQLField object>¶
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.
- fields(*subfields: ClassicalGraphQLField | PartnerSplitFields) ClassicalFields[source]¶
Subfields should come from the ClassicalFields class
- jwst_synergy: ClassicalGraphQLField = <gpp_client.generated.custom_typing_fields.ClassicalGraphQLField object>¶
Whether this proposal has JWST synergy.
- min_percent_time: ClassicalGraphQLField = <gpp_client.generated.custom_typing_fields.ClassicalGraphQLField object>¶
Minimum percentage of observing time required to consider this proposal successful.
- classmethod partner_splits() PartnerSplitFields[source]¶
Describes how time for the program will be apportioned across partners.
- science_subtype: ClassicalGraphQLField = <gpp_client.generated.custom_typing_fields.ClassicalGraphQLField object>¶
The science type of this Call for Proposals.
- us_long_term: ClassicalGraphQLField = <gpp_client.generated.custom_typing_fields.ClassicalGraphQLField object>¶
Whether this is a US Long Term proposal.
- class gpp_client.generated.custom_fields.CloneGroupResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) CloneGroupResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CloneGroupResultGraphQLField | GroupFields) CloneGroupResultFields[source]¶
Subfields should come from the CloneGroupResultFields class
- classmethod new_group() GroupFields[source]¶
- class gpp_client.generated.custom_fields.CloneObservationResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of cloning an observation, containing the new observation.
- alias(alias: str) CloneObservationResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CloneObservationResultGraphQLField | ObservationFields) CloneObservationResultFields[source]¶
Subfields should come from the CloneObservationResultFields class
- classmethod new_observation() ObservationFields[source]¶
The new cloned (but possibly modified) observation.
- class gpp_client.generated.custom_fields.CloneTargetResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of cloning a target, containing the original and new targets.
- alias(alias: str) CloneTargetResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CloneTargetResultGraphQLField | TargetFields) CloneTargetResultFields[source]¶
Subfields should come from the CloneTargetResultFields class
- classmethod new_target() TargetFields[source]¶
The new cloned (but possibly modified) target
- class gpp_client.generated.custom_fields.CommissioningProgramReferenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) CommissioningProgramReferenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CommissioningProgramReferenceGraphQLField) CommissioningProgramReferenceFields[source]¶
Subfields should come from the CommissioningProgramReferenceFields class
- instrument: CommissioningProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.CommissioningProgramReferenceGraphQLField object>¶
- label: CommissioningProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.CommissioningProgramReferenceGraphQLField object>¶
- semester: CommissioningProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.CommissioningProgramReferenceGraphQLField object>¶
- semester_index: CommissioningProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.CommissioningProgramReferenceGraphQLField object>¶
- type_: CommissioningProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.CommissioningProgramReferenceGraphQLField object>¶
- class gpp_client.generated.custom_fields.ConditionsEntryFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConditionsEntryFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ConditionsEntryGraphQLField | ConditionsIntuitionFields | ConditionsMeasurementFields | UserFields) ConditionsEntryFields[source]¶
Subfields should come from the ConditionsEntryFields class
- id: ConditionsEntryGraphQLField = <gpp_client.generated.custom_typing_fields.ConditionsEntryGraphQLField object>¶
- classmethod intuition() ConditionsIntuitionFields[source]¶
- classmethod measurement() ConditionsMeasurementFields[source]¶
- timestamp: ConditionsEntryGraphQLField = <gpp_client.generated.custom_typing_fields.ConditionsEntryGraphQLField object>¶
- transaction_id: ConditionsEntryGraphQLField = <gpp_client.generated.custom_typing_fields.ConditionsEntryGraphQLField object>¶
- classmethod user() UserFields[source]¶
- class gpp_client.generated.custom_fields.ConditionsExpectationFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConditionsExpectationFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ConditionsExpectationGraphQLField | TimeSpanFields) ConditionsExpectationFields[source]¶
Subfields should come from the ConditionsExpectationFields class
- classmethod timeframe() TimeSpanFields[source]¶
- type_: ConditionsExpectationGraphQLField = <gpp_client.generated.custom_typing_fields.ConditionsExpectationGraphQLField object>¶
- class gpp_client.generated.custom_fields.ConditionsIntuitionFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConditionsIntuitionFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod expectation() ConditionsExpectationFields[source]¶
- fields(*subfields: ConditionsIntuitionGraphQLField | ConditionsExpectationFields) ConditionsIntuitionFields[source]¶
Subfields should come from the ConditionsIntuitionFields class
- seeing_trend: ConditionsIntuitionGraphQLField = <gpp_client.generated.custom_typing_fields.ConditionsIntuitionGraphQLField object>¶
- class gpp_client.generated.custom_fields.ConditionsMeasurementFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConditionsMeasurementFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod azimuth() AngleFields[source]¶
- classmethod elevation() AngleFields[source]¶
- extinction: ConditionsMeasurementGraphQLField = <gpp_client.generated.custom_typing_fields.ConditionsMeasurementGraphQLField object>¶
- fields(*subfields: ConditionsMeasurementGraphQLField | AngleFields | WavelengthFields) ConditionsMeasurementFields[source]¶
Subfields should come from the ConditionsMeasurementFields class
- classmethod seeing() AngleFields[source]¶
- source: ConditionsMeasurementGraphQLField = <gpp_client.generated.custom_typing_fields.ConditionsMeasurementGraphQLField object>¶
- classmethod wavelength() WavelengthFields[source]¶
- class gpp_client.generated.custom_fields.ConfigChangeEstimateFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldAn individual configuration change before a step is executed. Multiple items may change simultaneously (e.g., the science fold may move while the Gcal filter is updated). ConfigChangeEstimate identifies a single item that will be updated.
- alias(alias: str) ConfigChangeEstimateFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- description: ConfigChangeEstimateGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigChangeEstimateGraphQLField object>¶
A possibly longer description of what was updated.
- classmethod estimate() TimeSpanFields[source]¶
Estimated time required to effectuate the change.
- fields(*subfields: ConfigChangeEstimateGraphQLField | TimeSpanFields) ConfigChangeEstimateFields[source]¶
Subfields should come from the ConfigChangeEstimateFields class
- name: ConfigChangeEstimateGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigChangeEstimateGraphQLField object>¶
Name of the item that changed.
- class gpp_client.generated.custom_fields.ConfigurationConditionsFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConfigurationConditionsFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- cloud_extinction: ConfigurationConditionsGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationConditionsGraphQLField object>¶
- fields(*subfields: ConfigurationConditionsGraphQLField) ConfigurationConditionsFields[source]¶
Subfields should come from the ConfigurationConditionsFields class
- image_quality: ConfigurationConditionsGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationConditionsGraphQLField object>¶
- sky_background: ConfigurationConditionsGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationConditionsGraphQLField object>¶
- water_vapor: ConfigurationConditionsGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationConditionsGraphQLField object>¶
- class gpp_client.generated.custom_fields.ConfigurationFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConfigurationFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod conditions() ConfigurationConditionsFields[source]¶
- fields(*subfields: ConfigurationGraphQLField | ConfigurationConditionsFields | ConfigurationObservingModeFields | ConfigurationTargetFields) ConfigurationFields[source]¶
Subfields should come from the ConfigurationFields class
- classmethod observing_mode() ConfigurationObservingModeFields[source]¶
- classmethod target() ConfigurationTargetFields[source]¶
- class gpp_client.generated.custom_fields.ConfigurationFlamingos2LongSlitFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConfigurationFlamingos2LongSlitFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- disperser: ConfigurationFlamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationFlamingos2LongSlitGraphQLField object>¶
- fields(*subfields: ConfigurationFlamingos2LongSlitGraphQLField) ConfigurationFlamingos2LongSlitFields[source]¶
Subfields should come from the ConfigurationFlamingos2LongSlitFields class
- class gpp_client.generated.custom_fields.ConfigurationGmosNorthImagingFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConfigurationGmosNorthImagingFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ConfigurationGmosNorthImagingGraphQLField) ConfigurationGmosNorthImagingFields[source]¶
Subfields should come from the ConfigurationGmosNorthImagingFields class
- filters: ConfigurationGmosNorthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationGmosNorthImagingGraphQLField object>¶
- class gpp_client.generated.custom_fields.ConfigurationGmosNorthLongSlitFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConfigurationGmosNorthLongSlitFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ConfigurationGmosNorthLongSlitGraphQLField) ConfigurationGmosNorthLongSlitFields[source]¶
Subfields should come from the ConfigurationGmosNorthLongSlitFields class
- grating: ConfigurationGmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationGmosNorthLongSlitGraphQLField object>¶
- class gpp_client.generated.custom_fields.ConfigurationGmosSouthImagingFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConfigurationGmosSouthImagingFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ConfigurationGmosSouthImagingGraphQLField) ConfigurationGmosSouthImagingFields[source]¶
Subfields should come from the ConfigurationGmosSouthImagingFields class
- filters: ConfigurationGmosSouthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationGmosSouthImagingGraphQLField object>¶
- class gpp_client.generated.custom_fields.ConfigurationGmosSouthLongSlitFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConfigurationGmosSouthLongSlitFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ConfigurationGmosSouthLongSlitGraphQLField) ConfigurationGmosSouthLongSlitFields[source]¶
Subfields should come from the ConfigurationGmosSouthLongSlitFields class
- grating: ConfigurationGmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationGmosSouthLongSlitGraphQLField object>¶
- class gpp_client.generated.custom_fields.ConfigurationIgrins2LongSlitFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConfigurationIgrins2LongSlitFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ConfigurationIgrins2LongSlitGraphQLField) ConfigurationIgrins2LongSlitFields[source]¶
Subfields should come from the ConfigurationIgrins2LongSlitFields class
- ignore: ConfigurationIgrins2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationIgrins2LongSlitGraphQLField object>¶
- class gpp_client.generated.custom_fields.ConfigurationObservingModeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConfigurationObservingModeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ConfigurationObservingModeGraphQLField | ConfigurationFlamingos2LongSlitFields | ConfigurationGmosNorthImagingFields | ConfigurationGmosNorthLongSlitFields | ConfigurationGmosSouthImagingFields | ConfigurationGmosSouthLongSlitFields | ConfigurationIgrins2LongSlitFields | ConfigurationVisitorFields) ConfigurationObservingModeFields[source]¶
Subfields should come from the ConfigurationObservingModeFields class
- classmethod flamingos_2_long_slit() ConfigurationFlamingos2LongSlitFields[source]¶
- classmethod gmos_north_imaging() ConfigurationGmosNorthImagingFields[source]¶
- classmethod gmos_north_long_slit() ConfigurationGmosNorthLongSlitFields[source]¶
- classmethod gmos_south_imaging() ConfigurationGmosSouthImagingFields[source]¶
- classmethod gmos_south_long_slit() ConfigurationGmosSouthLongSlitFields[source]¶
- classmethod igrins_2_long_slit() ConfigurationIgrins2LongSlitFields[source]¶
- instrument: ConfigurationObservingModeGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationObservingModeGraphQLField object>¶
- mode: ConfigurationObservingModeGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationObservingModeGraphQLField object>¶
- classmethod visitor() ConfigurationVisitorFields[source]¶
- class gpp_client.generated.custom_fields.ConfigurationRequestFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConfigurationRequestFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- applicable_observations: ConfigurationRequestGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationRequestGraphQLField object>¶
- classmethod configuration() ConfigurationFields[source]¶
- fields(*subfields: ConfigurationRequestGraphQLField | ConfigurationFields | ProgramFields) ConfigurationRequestFields[source]¶
Subfields should come from the ConfigurationRequestFields class
- id: ConfigurationRequestGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationRequestGraphQLField object>¶
- justification: ConfigurationRequestGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationRequestGraphQLField object>¶
- classmethod program() ProgramFields[source]¶
- status: ConfigurationRequestGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationRequestGraphQLField object>¶
- class gpp_client.generated.custom_fields.ConfigurationRequestSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe matching configuration requests, limited to a maximum of 1000 entries.
- alias(alias: str) ConfigurationRequestSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ConfigurationRequestSelectResultGraphQLField | ConfigurationRequestFields) ConfigurationRequestSelectResultFields[source]¶
Subfields should come from the ConfigurationRequestSelectResultFields class
- has_more: ConfigurationRequestSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationRequestSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() ConfigurationRequestFields[source]¶
Matching configuration requests up to the return size limit of 1000
- class gpp_client.generated.custom_fields.ConfigurationTargetFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA configuration target will define either coordinates or a region.
- alias(alias: str) ConfigurationTargetFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod coordinates() CoordinatesFields[source]¶
- fields(*subfields: ConfigurationTargetGraphQLField | CoordinatesFields | RegionFields) ConfigurationTargetFields[source]¶
Subfields should come from the ConfigurationTargetFields class
- classmethod region() RegionFields[source]¶
- class gpp_client.generated.custom_fields.ConfigurationVisitorFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConfigurationVisitorFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ConfigurationVisitorGraphQLField | AngleFields) ConfigurationVisitorFields[source]¶
Subfields should come from the ConfigurationVisitorFields class
- mode: ConfigurationVisitorGraphQLField = <gpp_client.generated.custom_typing_fields.ConfigurationVisitorGraphQLField object>¶
- classmethod radius() AngleFields[source]¶
- class gpp_client.generated.custom_fields.ConstraintSetFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConstraintSetFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- cloud_extinction: ConstraintSetGraphQLField = <gpp_client.generated.custom_typing_fields.ConstraintSetGraphQLField object>¶
Cloud extinction
- classmethod elevation_range() ElevationRangeFields[source]¶
Either air mass range or elevation range
- fields(*subfields: ConstraintSetGraphQLField | ElevationRangeFields) ConstraintSetFields[source]¶
Subfields should come from the ConstraintSetFields class
- image_quality: ConstraintSetGraphQLField = <gpp_client.generated.custom_typing_fields.ConstraintSetGraphQLField object>¶
Image quality
- sky_background: ConstraintSetGraphQLField = <gpp_client.generated.custom_typing_fields.ConstraintSetGraphQLField object>¶
Sky background
- water_vapor: ConstraintSetGraphQLField = <gpp_client.generated.custom_typing_fields.ConstraintSetGraphQLField object>¶
Water vapor
- class gpp_client.generated.custom_fields.ConstraintSetGroupFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ConstraintSetGroupFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod constraint_set() ConstraintSetFields[source]¶
Commonly held value across the observations
- fields(*subfields: ConstraintSetGroupGraphQLField | ConstraintSetFields | ObservationSelectResultFields | ProgramFields) ConstraintSetGroupFields[source]¶
Subfields should come from the ConstraintSetGroupFields class
- classmethod observations(include_deleted: bool, *, offset: Any | None = None, limit: Any | None = None) ObservationSelectResultFields[source]¶
Observations associated with the common value
- classmethod program() ProgramFields[source]¶
Link back to program.
- class gpp_client.generated.custom_fields.ConstraintSetGroupSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe matching constraintSetGroup results, limited to a maximum of 1000 entries.
- alias(alias: str) ConstraintSetGroupSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ConstraintSetGroupSelectResultGraphQLField | ConstraintSetGroupFields) ConstraintSetGroupSelectResultFields[source]¶
Subfields should come from the ConstraintSetGroupSelectResultFields class
- has_more: ConstraintSetGroupSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.ConstraintSetGroupSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() ConstraintSetGroupFields[source]¶
Matching constraintSetGroups up to the return size limit of 1000
- class gpp_client.generated.custom_fields.CoordinateLimitsFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldRA/Dec limits.
- alias(alias: str) CoordinateLimitsFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod dec_end() DeclinationFields[source]¶
The end limit defines the end (inclusive) of a declination range in which observations will be accepted.
- classmethod dec_start() DeclinationFields[source]¶
The start limit defines the beginning (inclusive) of a declination range in which observations will be accepted.
- fields(*subfields: CoordinateLimitsGraphQLField | DeclinationFields | RightAscensionFields) CoordinateLimitsFields[source]¶
Subfields should come from the CoordinateLimitsFields class
- classmethod ra_end() RightAscensionFields[source]¶
The end limit defines the end (inclusive) of an RA range in which observations will be accepted.
- classmethod ra_start() RightAscensionFields[source]¶
The start limit defines the beginning (inclusive) of an RA range in which observations will be accepted.
- class gpp_client.generated.custom_fields.CoordinatesFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) CoordinatesFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod dec() DeclinationFields[source]¶
Declination
- fields(*subfields: CoordinatesGraphQLField | DeclinationFields | RightAscensionFields) CoordinatesFields[source]¶
Subfields should come from the CoordinatesFields class
- classmethod ra() RightAscensionFields[source]¶
Right Ascension
- class gpp_client.generated.custom_fields.CreateCallForProposalsResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) CreateCallForProposalsResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod call_for_proposals() CallForProposalsFields[source]¶
- fields(*subfields: CreateCallForProposalsResultGraphQLField | CallForProposalsFields) CreateCallForProposalsResultFields[source]¶
Subfields should come from the CreateCallForProposalsResultFields class
- class gpp_client.generated.custom_fields.CreateGroupResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of creating a new group.
- alias(alias: str) CreateGroupResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CreateGroupResultGraphQLField | GroupFields) CreateGroupResultFields[source]¶
Subfields should come from the CreateGroupResultFields class
- classmethod group() GroupFields[source]¶
The newly created group.
- class gpp_client.generated.custom_fields.CreateObservationResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of creating a new observation.
- alias(alias: str) CreateObservationResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CreateObservationResultGraphQLField | ObservationFields) CreateObservationResultFields[source]¶
Subfields should come from the CreateObservationResultFields class
- classmethod observation() ObservationFields[source]¶
The newly created observation.
- class gpp_client.generated.custom_fields.CreateProgramNoteResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) CreateProgramNoteResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CreateProgramNoteResultGraphQLField | ProgramNoteFields) CreateProgramNoteResultFields[source]¶
Subfields should come from the CreateProgramNoteResultFields class
- classmethod program_note() ProgramNoteFields[source]¶
The newly create program note.
- class gpp_client.generated.custom_fields.CreateProgramResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of creating a new program.
- alias(alias: str) CreateProgramResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CreateProgramResultGraphQLField | ProgramFields) CreateProgramResultFields[source]¶
Subfields should come from the CreateProgramResultFields class
- classmethod program() ProgramFields[source]¶
The newly created program.
- class gpp_client.generated.custom_fields.CreateProposalResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of creating new proposal
- alias(alias: str) CreateProposalResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CreateProposalResultGraphQLField | ProposalFields) CreateProposalResultFields[source]¶
Subfields should come from the CreateProposalResultFields class
- classmethod proposal() ProposalFields[source]¶
The newly created proposal.
- class gpp_client.generated.custom_fields.CreateTargetResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of creating a new target.
- alias(alias: str) CreateTargetResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CreateTargetResultGraphQLField | TargetFields) CreateTargetResultFields[source]¶
Subfields should come from the CreateTargetResultFields class
- classmethod target() TargetFields[source]¶
The newly created target.
- class gpp_client.generated.custom_fields.CreateUserInvitationResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) CreateUserInvitationResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: CreateUserInvitationResultGraphQLField | UserInvitationFields) CreateUserInvitationResultFields[source]¶
Subfields should come from the CreateUserInvitationResultFields class
- classmethod invitation() UserInvitationFields[source]¶
The created invitation.
- key: CreateUserInvitationResultGraphQLField = <gpp_client.generated.custom_typing_fields.CreateUserInvitationResultGraphQLField object>¶
Give this key to the person you wish to invite. They can later redeem the invitation.
- class gpp_client.generated.custom_fields.DarkFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldDark calibration step
- alias(alias: str) DarkFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: DarkGraphQLField) DarkFields[source]¶
Subfields should come from the DarkFields class
- step_type: DarkGraphQLField = <gpp_client.generated.custom_typing_fields.DarkGraphQLField object>¶
Step type
- class gpp_client.generated.custom_fields.DatasetChronicleEntryFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe Chronicle entry for dataset updates.
- alias(alias: str) DatasetChronicleEntryFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod dataset() DatasetFields[source]¶
The dataset that was inserted or updated.
- fields(*subfields: DatasetChronicleEntryGraphQLField | DatasetFields | TimestampIntervalFields | UserFields) DatasetChronicleEntryFields[source]¶
Subfields should come from the DatasetChronicleEntryFields class
- id: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- mod_comment: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- mod_dataset_id: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- mod_filename: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- mod_interval: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- mod_observation_id: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- mod_qa_state: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- mod_reference: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- mod_step_id: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- mod_visit_id: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- new_comment: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- new_dataset_id: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- new_filename: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- classmethod new_interval() TimestampIntervalFields[source]¶
- new_observation_id: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- new_qa_state: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- new_reference: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- new_step_id: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- new_visit_id: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- operation: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
The database operation that was performed.
- timestamp: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
When the update happened.
- transaction_id: DatasetChronicleEntryGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntryGraphQLField object>¶
- classmethod user() UserFields[source]¶
The user who performed the insertion or update.
- class gpp_client.generated.custom_fields.DatasetChronicleEntrySelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) DatasetChronicleEntrySelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: DatasetChronicleEntrySelectResultGraphQLField | DatasetChronicleEntryFields) DatasetChronicleEntrySelectResultFields[source]¶
Subfields should come from the DatasetChronicleEntrySelectResultFields class
- has_more: DatasetChronicleEntrySelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetChronicleEntrySelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() DatasetChronicleEntryFields[source]¶
Matching entries up to the return size limit of 1000
- class gpp_client.generated.custom_fields.DatasetEstimateFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldTime estimate for taking an individual dataset.
- alias(alias: str) DatasetEstimateFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod estimate() TimeSpanFields[source]¶
Total estimate for the dataset, summing exposure, readout and write
- classmethod exposure() TimeSpanFields[source]¶
The exposure time itself
- fields(*subfields: DatasetEstimateGraphQLField | TimeSpanFields) DatasetEstimateFields[source]¶
Subfields should come from the DatasetEstimateFields class
- classmethod readout() TimeSpanFields[source]¶
Time required to readout the detector
- classmethod write() TimeSpanFields[source]¶
Time required to write the data to the storage system
- class gpp_client.generated.custom_fields.DatasetEventFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldDataset-level events. A single dataset will be associated with multiple events as it makes its way through observe, readout and write stages.
- alias(alias: str) DatasetEventFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod atom() AtomRecordFields[source]¶
Atom associated with this event.
- classmethod dataset() DatasetFields[source]¶
The associated dataset.
- dataset_stage: DatasetEventGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetEventGraphQLField object>¶
Dataset execution stage.
- event_type: DatasetEventGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetEventGraphQLField object>¶
Event type.
- fields(*subfields: DatasetEventGraphQLField | AtomRecordFields | DatasetFields | ObservationFields | StepRecordFields | VisitFields) DatasetEventFields[source]¶
Subfields should come from the DatasetEventFields class
- id: DatasetEventGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetEventGraphQLField object>¶
Event id.
- idempotency_key: DatasetEventGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetEventGraphQLField object>¶
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.
- classmethod observation() ObservationFields[source]¶
Observation whose execution produced this event.
- received: DatasetEventGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetEventGraphQLField object>¶
Time at which this event was received.
- classmethod step() StepRecordFields[source]¶
The associated step.
- classmethod visit() VisitFields[source]¶
Visit associated with the event.
- class gpp_client.generated.custom_fields.DatasetFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) DatasetFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- comment: DatasetGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetGraphQLField object>¶
Dataset comment, if any has been set.
- classmethod events(*, offset: Any | None = None, limit: Any | None = None) ExecutionEventSelectResultFields[source]¶
Events associated with the dataset.
- fields(*subfields: DatasetGraphQLField | DatasetReferenceFields | ExecutionEventSelectResultFields | ObservationFields | StepRecordFields | TimestampIntervalFields | VisitFields) DatasetFields[source]¶
Subfields should come from the DatasetFields class
- filename: DatasetGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetGraphQLField object>¶
Dataset filename.
- id: DatasetGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetGraphQLField object>¶
Dataset id.
- idempotency_key: DatasetGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetGraphQLField object>¶
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.
- index: DatasetGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetGraphQLField object>¶
Exposure index within the step.
- classmethod interval() TimestampIntervalFields[source]¶
Dataset time interval, if the dataset collection has started.
- is_written: DatasetGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetGraphQLField object>¶
Has the dataset been written to disk? Note, we assume the dataset has been written when an END_WRITE event is received from Observe.
- classmethod observation() ObservationFields[source]¶
Observation associated with this dataset.
- qa_state: DatasetGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetGraphQLField object>¶
Dataset QA state, if any has been set.
- classmethod reference() DatasetReferenceFields[source]¶
Dataset reference, assuming the observation has an observation reference.
- classmethod step() StepRecordFields[source]¶
The corresponding step.
- classmethod visit() VisitFields[source]¶
Visit associated with this dataset.
- class gpp_client.generated.custom_fields.DatasetReferenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldDataset reference type, broken into its constituient parts and including a formatted label.
- alias(alias: str) DatasetReferenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- exposure_index: DatasetReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetReferenceGraphQLField object>¶
The exposure index relative to its step.
- fields(*subfields: DatasetReferenceGraphQLField | ObservationReferenceFields) DatasetReferenceFields[source]¶
Subfields should come from the DatasetReferenceFields class
- label: DatasetReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetReferenceGraphQLField object>¶
Formatted dataset reference label.
- classmethod observation() ObservationReferenceFields[source]¶
The observation reference.
- step_index: DatasetReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetReferenceGraphQLField object>¶
The step index relative to its observation.
- class gpp_client.generated.custom_fields.DatasetSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe matching dataset results, limited to a maximum of 1000 entries.
- alias(alias: str) DatasetSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: DatasetSelectResultGraphQLField | DatasetFields) DatasetSelectResultFields[source]¶
Subfields should come from the DatasetSelectResultFields class
- has_more: DatasetSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.DatasetSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() DatasetFields[source]¶
Matching datasets up to the return size limit of 1000
- class gpp_client.generated.custom_fields.DateIntervalFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldDate interval marked by a start ‘Date’ (inclusive) and an end ‘Date’ (exclusive). Dates are interpreted as local dates.
- alias(alias: str) DateIntervalFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- end: DateIntervalGraphQLField = <gpp_client.generated.custom_typing_fields.DateIntervalGraphQLField object>¶
End date, local to the observation site, of the interval (exclusive).
- fields(*subfields: DateIntervalGraphQLField) DateIntervalFields[source]¶
Subfields should come from the DateIntervalFields class
- start: DateIntervalGraphQLField = <gpp_client.generated.custom_typing_fields.DateIntervalGraphQLField object>¶
Start date, local to the observation site, of the interval (inclusive).
- class gpp_client.generated.custom_fields.DeclinationArcFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) DeclinationArcFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod end() DeclinationFields[source]¶
- fields(*subfields: DeclinationArcGraphQLField | DeclinationFields) DeclinationArcFields[source]¶
Subfields should come from the DeclinationArcFields class
- classmethod start() DeclinationFields[source]¶
- type_: DeclinationArcGraphQLField = <gpp_client.generated.custom_typing_fields.DeclinationArcGraphQLField object>¶
- class gpp_client.generated.custom_fields.DeclinationFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) DeclinationFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- degrees: DeclinationGraphQLField = <gpp_client.generated.custom_typing_fields.DeclinationGraphQLField object>¶
Declination in signed degrees
- dms: DeclinationGraphQLField = <gpp_client.generated.custom_typing_fields.DeclinationGraphQLField object>¶
SS.SS format
- Type:
Declination in DD
- Type:
MM
- fields(*subfields: DeclinationGraphQLField) DeclinationFields[source]¶
Subfields should come from the DeclinationFields class
- microarcseconds: DeclinationGraphQLField = <gpp_client.generated.custom_typing_fields.DeclinationGraphQLField object>¶
Declination in signed µas
- class gpp_client.generated.custom_fields.DeleteProgramUserResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of deleting a program user.
- alias(alias: str) DeleteProgramUserResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: DeleteProgramUserResultGraphQLField) DeleteProgramUserResultFields[source]¶
Subfields should come from the DeleteProgramUserResultFields class
- result: DeleteProgramUserResultGraphQLField = <gpp_client.generated.custom_typing_fields.DeleteProgramUserResultGraphQLField object>¶
true if a program user was deleted, false otherwise.
- class gpp_client.generated.custom_fields.DeleteProposalResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of deleting a proposal.
- alias(alias: str) DeleteProposalResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: DeleteProposalResultGraphQLField) DeleteProposalResultFields[source]¶
Subfields should come from the DeleteProposalResultFields class
- result: DeleteProposalResultGraphQLField = <gpp_client.generated.custom_typing_fields.DeleteProposalResultGraphQLField object>¶
true if a proposal was deleted, false otherwise.
- class gpp_client.generated.custom_fields.DemoScienceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldProposal properties for Demo Science CallForProposals.
- alias(alias: str) DemoScienceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: DemoScienceGraphQLField) DemoScienceFields[source]¶
Subfields should come from the DemoScienceFields class
- min_percent_time: DemoScienceGraphQLField = <gpp_client.generated.custom_typing_fields.DemoScienceGraphQLField object>¶
Minimum percentage of observing time required to consider this proposal successful.
- science_subtype: DemoScienceGraphQLField = <gpp_client.generated.custom_typing_fields.DemoScienceGraphQLField object>¶
The science type of this Call for Proposals.
- to_o_activation: DemoScienceGraphQLField = <gpp_client.generated.custom_typing_fields.DemoScienceGraphQLField object>¶
Whether (and how) the observations in this proposal are available for Target of Opportunity triggering.
- class gpp_client.generated.custom_fields.DetectorEstimateFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldTime estimate for a single detector. Some instruments will employ multiple detectors per step.
- alias(alias: str) DetectorEstimateFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- count: DetectorEstimateGraphQLField = <gpp_client.generated.custom_typing_fields.DetectorEstimateGraphQLField object>¶
Count of datasets to be produced by the detector
- classmethod dataset() DatasetEstimateFields[source]¶
Time estimate for a single dataset produced by this detector
- description: DetectorEstimateGraphQLField = <gpp_client.generated.custom_typing_fields.DetectorEstimateGraphQLField object>¶
Detector description
- classmethod estimate() TimeSpanFields[source]¶
Total time estimate for the detector, which is the sum of the individual dataset estimate multiplied by the count.
- fields(*subfields: DetectorEstimateGraphQLField | DatasetEstimateFields | TimeSpanFields) DetectorEstimateFields[source]¶
Subfields should come from the DetectorEstimateFields class
- name: DetectorEstimateGraphQLField = <gpp_client.generated.custom_typing_fields.DetectorEstimateGraphQLField object>¶
Indicates which detector is estimated here
- class gpp_client.generated.custom_fields.DirectorsTimeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldProposal properties for Director’s Time CallForProposals.
- alias(alias: str) DirectorsTimeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: DirectorsTimeGraphQLField) DirectorsTimeFields[source]¶
Subfields should come from the DirectorsTimeFields class
- min_percent_time: DirectorsTimeGraphQLField = <gpp_client.generated.custom_typing_fields.DirectorsTimeGraphQLField object>¶
Minimum percentage of observing time required to consider this proposal successful.
- science_subtype: DirectorsTimeGraphQLField = <gpp_client.generated.custom_typing_fields.DirectorsTimeGraphQLField object>¶
The science type of this Call for Proposals.
- to_o_activation: DirectorsTimeGraphQLField = <gpp_client.generated.custom_typing_fields.DirectorsTimeGraphQLField object>¶
Whether (and how) the observations in this proposal are available for Target of Opportunity triggering.
- class gpp_client.generated.custom_fields.ElevationRangeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldEither air mass range or elevation range
- classmethod air_mass() AirMassRangeFields[source]¶
AirMass range if elevation range is an Airmass range
- alias(alias: str) ElevationRangeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ElevationRangeGraphQLField | AirMassRangeFields | HourAngleRangeFields) ElevationRangeFields[source]¶
Subfields should come from the ElevationRangeFields class
- classmethod hour_angle() HourAngleRangeFields[source]¶
Hour angle range if elevation range is an Hour angle range
- class gpp_client.generated.custom_fields.EmailFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) EmailFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: EmailGraphQLField) EmailFields[source]¶
Subfields should come from the EmailFields class
- html_message: EmailGraphQLField = <gpp_client.generated.custom_typing_fields.EmailGraphQLField object>¶
Html format message
- original_time: EmailGraphQLField = <gpp_client.generated.custom_typing_fields.EmailGraphQLField object>¶
Original time of the email sending attempt
- recipient_email: EmailGraphQLField = <gpp_client.generated.custom_typing_fields.EmailGraphQLField object>¶
Recipient email address
- sender_email: EmailGraphQLField = <gpp_client.generated.custom_typing_fields.EmailGraphQLField object>¶
Sender email address
- status: EmailGraphQLField = <gpp_client.generated.custom_typing_fields.EmailGraphQLField object>¶
The status of the email
- status_time: EmailGraphQLField = <gpp_client.generated.custom_typing_fields.EmailGraphQLField object>¶
The time of the last status update
- subject: EmailGraphQLField = <gpp_client.generated.custom_typing_fields.EmailGraphQLField object>¶
Email subject
- text_message: EmailGraphQLField = <gpp_client.generated.custom_typing_fields.EmailGraphQLField object>¶
Text format message
- class gpp_client.generated.custom_fields.EmissionLineIntegratedFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) EmissionLineIntegratedFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: EmissionLineIntegratedGraphQLField | LineFluxIntegratedFields | WavelengthFields) EmissionLineIntegratedFields[source]¶
Subfields should come from the EmissionLineIntegratedFields class
- classmethod line_flux() LineFluxIntegratedFields[source]¶
- line_width: EmissionLineIntegratedGraphQLField = <gpp_client.generated.custom_typing_fields.EmissionLineIntegratedGraphQLField object>¶
km/s
- classmethod wavelength() WavelengthFields[source]¶
- class gpp_client.generated.custom_fields.EmissionLineSurfaceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) EmissionLineSurfaceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: EmissionLineSurfaceGraphQLField | LineFluxSurfaceFields | WavelengthFields) EmissionLineSurfaceFields[source]¶
Subfields should come from the EmissionLineSurfaceFields class
- classmethod line_flux() LineFluxSurfaceFields[source]¶
- line_width: EmissionLineSurfaceGraphQLField = <gpp_client.generated.custom_typing_fields.EmissionLineSurfaceGraphQLField object>¶
km/s
- classmethod wavelength() WavelengthFields[source]¶
- class gpp_client.generated.custom_fields.EmissionLinesIntegratedFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) EmissionLinesIntegratedFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: EmissionLinesIntegratedGraphQLField | EmissionLineIntegratedFields | FluxDensityContinuumIntegratedFields) EmissionLinesIntegratedFields[source]¶
Subfields should come from the EmissionLinesIntegratedFields class
- classmethod flux_density_continuum() FluxDensityContinuumIntegratedFields[source]¶
- classmethod lines() EmissionLineIntegratedFields[source]¶
- class gpp_client.generated.custom_fields.EmissionLinesSurfaceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) EmissionLinesSurfaceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: EmissionLinesSurfaceGraphQLField | EmissionLineSurfaceFields | FluxDensityContinuumSurfaceFields) EmissionLinesSurfaceFields[source]¶
Subfields should come from the EmissionLinesSurfaceFields class
- classmethod flux_density_continuum() FluxDensityContinuumSurfaceFields[source]¶
- classmethod lines() EmissionLineSurfaceFields[source]¶
- class gpp_client.generated.custom_fields.EngineeringProgramReferenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) EngineeringProgramReferenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: EngineeringProgramReferenceGraphQLField) EngineeringProgramReferenceFields[source]¶
Subfields should come from the EngineeringProgramReferenceFields class
- instrument: EngineeringProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.EngineeringProgramReferenceGraphQLField object>¶
- label: EngineeringProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.EngineeringProgramReferenceGraphQLField object>¶
- semester: EngineeringProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.EngineeringProgramReferenceGraphQLField object>¶
- semester_index: EngineeringProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.EngineeringProgramReferenceGraphQLField object>¶
- type_: EngineeringProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.EngineeringProgramReferenceGraphQLField object>¶
- class gpp_client.generated.custom_fields.EnumeratedTelescopeConfigGeneratorFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldIn the ENUMERATED option offsets are explicitly specified instead of calculated.
- alias(alias: str) EnumeratedTelescopeConfigGeneratorFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: EnumeratedTelescopeConfigGeneratorGraphQLField | TelescopeConfigFields) EnumeratedTelescopeConfigGeneratorFields[source]¶
Subfields should come from the EnumeratedTelescopeConfigGeneratorFields class
- classmethod values() TelescopeConfigFields[source]¶
- class gpp_client.generated.custom_fields.ExampleProgramReferenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ExampleProgramReferenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ExampleProgramReferenceGraphQLField) ExampleProgramReferenceFields[source]¶
Subfields should come from the ExampleProgramReferenceFields class
- instrument: ExampleProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ExampleProgramReferenceGraphQLField object>¶
- label: ExampleProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ExampleProgramReferenceGraphQLField object>¶
- type_: ExampleProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ExampleProgramReferenceGraphQLField object>¶
- class gpp_client.generated.custom_fields.ExecutionConfigFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldExecution configuration. All but one of the instruments will be null.
- alias(alias: str) ExecutionConfigFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ExecutionConfigGraphQLField | Flamingos2ExecutionConfigFields | GhostExecutionConfigFields | GmosNorthExecutionConfigFields | GmosSouthExecutionConfigFields | Igrins2ExecutionConfigFields) ExecutionConfigFields[source]¶
Subfields should come from the ExecutionConfigFields class
- classmethod flamingos_2() Flamingos2ExecutionConfigFields[source]¶
Flamingos 2 execution config. This will be null unless the instrument is FLAMINGOS2.
- classmethod ghost() GhostExecutionConfigFields[source]¶
GHOST execution config. This will be null unless the instrument is GHOST.
- classmethod gmos_north() GmosNorthExecutionConfigFields[source]¶
GMOS North execution config. This will be null unless the instrument is GMOS_NORTH.
- classmethod gmos_south() GmosSouthExecutionConfigFields[source]¶
GMOS South execution config. This will be null unless the instrument is GMOS_SOUTH.
- classmethod igrins_2() Igrins2ExecutionConfigFields[source]¶
IGRINS-2 execution config. This will be null unless the instrument is IGRINS2.
- instrument: ExecutionConfigGraphQLField = <gpp_client.generated.custom_typing_fields.ExecutionConfigGraphQLField object>¶
Instrument type. This will indicate which of the instrument-specific fields is defined.
- class gpp_client.generated.custom_fields.ExecutionDigestFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldSummarizes the execution setup time and sequences.
- classmethod acquisition() SequenceDigestFields[source]¶
Acquisition sequence summary.
- alias(alias: str) ExecutionDigestFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ExecutionDigestGraphQLField | SequenceDigestFields | SetupTimeFields) ExecutionDigestFields[source]¶
Subfields should come from the ExecutionDigestFields class
- classmethod science() SequenceDigestFields[source]¶
Science sequence summary.
- classmethod setup() SetupTimeFields[source]¶
Setup time calculations.
- setup_count: ExecutionDigestGraphQLField = <gpp_client.generated.custom_typing_fields.ExecutionDigestGraphQLField object>¶
Estimated number of setups required to complete this observation.
- class gpp_client.generated.custom_fields.ExecutionEventInterface(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldExecution event (sequence, step, or dataset events)
- alias(alias: str) ExecutionEventInterface[source]¶
Sets an alias for the GraphQL field and returns the instance.
- event_type: ExecutionEventGraphQLField = <gpp_client.generated.custom_typing_fields.ExecutionEventGraphQLField object>¶
Event type.
- fields(*subfields: ExecutionEventGraphQLField | ObservationFields | VisitFields) ExecutionEventInterface[source]¶
Subfields should come from the ExecutionEventInterface class
- id: ExecutionEventGraphQLField = <gpp_client.generated.custom_typing_fields.ExecutionEventGraphQLField object>¶
Event id.
- idempotency_key: ExecutionEventGraphQLField = <gpp_client.generated.custom_typing_fields.ExecutionEventGraphQLField object>¶
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.
- classmethod observation() ObservationFields[source]¶
Observation whose execution produced this event.
- on(type_name: str, *subfields: GraphQLField) ExecutionEventInterface[source]¶
- received: ExecutionEventGraphQLField = <gpp_client.generated.custom_typing_fields.ExecutionEventGraphQLField object>¶
Time at which this event was received.
- classmethod visit() VisitFields[source]¶
Visit associated with the event.
- class gpp_client.generated.custom_fields.ExecutionEventSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe matching ExecutionEvent results, limited to a maximum of 1000 entries.
- alias(alias: str) ExecutionEventSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ExecutionEventSelectResultGraphQLField | ExecutionEventInterface) ExecutionEventSelectResultFields[source]¶
Subfields should come from the ExecutionEventSelectResultFields class
- has_more: ExecutionEventSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.ExecutionEventSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() ExecutionEventInterface[source]¶
Matching ExecutionEvents up to the return size limit of 1000
- class gpp_client.generated.custom_fields.ExecutionFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ExecutionFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod atom_records(*, offset: Any | None = None, limit: Any | None = None) AtomRecordSelectResultFields[source]¶
Executed (or at least partially executed) atom records, across all visits, ordered by execution order of the first contained step.
- classmethod datasets(*, offset: Any | None = None, limit: Any | None = None) DatasetSelectResultFields[source]¶
Datasets associated with the observation, across all visits.
- classmethod digest() CalculatedExecutionDigestFields[source]¶
Calculations dependent on the sequence, such as planned time and offsets. If a sequence cannot be generated for this observation, null is returned along with warning messages.
- classmethod events(*, offset: Any | None = None, limit: Any | None = None) ExecutionEventSelectResultFields[source]¶
Events associated with the observation, across all visits.
- execution_state: ExecutionGraphQLField = <gpp_client.generated.custom_typing_fields.ExecutionGraphQLField object>¶
Determines the execution state as a whole of this observation.
- fields(*subfields: ExecutionGraphQLField | AtomRecordSelectResultFields | CalculatedExecutionDigestFields | CategorizedTimeFields | DatasetSelectResultFields | ExecutionEventSelectResultFields | VisitSelectResultFields) ExecutionFields[source]¶
Subfields should come from the ExecutionFields class
- classmethod time_charge() CategorizedTimeFields[source]¶
Time accounting calculation for this observation.
- class gpp_client.generated.custom_fields.ExposureTimeModeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldExposure time mode, either signal to noise or fixed
- alias(alias: str) ExposureTimeModeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ExposureTimeModeGraphQLField | SignalToNoiseExposureTimeModeFields | TimeAndCountExposureTimeModeFields) ExposureTimeModeFields[source]¶
Subfields should come from the ExposureTimeModeFields class
- classmethod signal_to_noise() SignalToNoiseExposureTimeModeFields[source]¶
Signal to noise exposure time mode data, if applicable.
- classmethod time_and_count() TimeAndCountExposureTimeModeFields[source]¶
Time and Count mode data, if applicable.
- class gpp_client.generated.custom_fields.FastTurnaroundFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldProposal properties for Fast Turnaround CallForProposals.
- alias(alias: str) FastTurnaroundFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: FastTurnaroundGraphQLField | ProgramUserFields) FastTurnaroundFields[source]¶
Subfields should come from the FastTurnaroundFields class
- classmethod mentor() ProgramUserFields[source]¶
Program User that will be selected as a mentor for this program. Required when the reviewer does not have PhD educational status.
- min_percent_time: FastTurnaroundGraphQLField = <gpp_client.generated.custom_typing_fields.FastTurnaroundGraphQLField object>¶
Minimum percentage of observing time required to consider this proposal successful.
- classmethod reviewer() ProgramUserFields[source]¶
Program User that will be selected as a reviewer for this program
- science_subtype: FastTurnaroundGraphQLField = <gpp_client.generated.custom_typing_fields.FastTurnaroundGraphQLField object>¶
The science type of this Call for Proposals.
- to_o_activation: FastTurnaroundGraphQLField = <gpp_client.generated.custom_typing_fields.FastTurnaroundGraphQLField object>¶
Whether (and how) the observations in this proposal are available for Target of Opportunity triggering.
- class gpp_client.generated.custom_fields.FilterTypeMetaFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldMetadata for enum FilterType
- alias(alias: str) FilterTypeMetaFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: FilterTypeMetaGraphQLField) FilterTypeMetaFields[source]¶
Subfields should come from the FilterTypeMetaFields class
- long_name: FilterTypeMetaGraphQLField = <gpp_client.generated.custom_typing_fields.FilterTypeMetaGraphQLField object>¶
- short_name: FilterTypeMetaGraphQLField = <gpp_client.generated.custom_typing_fields.FilterTypeMetaGraphQLField object>¶
- tag: FilterTypeMetaGraphQLField = <gpp_client.generated.custom_typing_fields.FilterTypeMetaGraphQLField object>¶
- class gpp_client.generated.custom_fields.Flamingos2AtomFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldFlamingos 2 atom, a collection of steps that should be executed in their entirety
- alias(alias: str) Flamingos2AtomFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- description: Flamingos2AtomGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2AtomGraphQLField object>¶
Optional description of the atom.
- fields(*subfields: Flamingos2AtomGraphQLField | Flamingos2StepFields) Flamingos2AtomFields[source]¶
Subfields should come from the Flamingos2AtomFields class
- id: Flamingos2AtomGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2AtomGraphQLField object>¶
Atom id
- observe_class: Flamingos2AtomGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2AtomGraphQLField object>¶
Observe class for this atom as a whole (combined observe class for each of its steps).
- classmethod steps() Flamingos2StepFields[source]¶
Individual steps that comprise the atom
- class gpp_client.generated.custom_fields.Flamingos2CustomMaskFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldFlamingos 2 Custom Mask
- alias(alias: str) Flamingos2CustomMaskFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: Flamingos2CustomMaskGraphQLField) Flamingos2CustomMaskFields[source]¶
Subfields should come from the Flamingos2CustomMaskFields class
- filename: Flamingos2CustomMaskGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2CustomMaskGraphQLField object>¶
Custom Mask Filename
- slit_width: Flamingos2CustomMaskGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2CustomMaskGraphQLField object>¶
Custom Slit Width
- class gpp_client.generated.custom_fields.Flamingos2DynamicFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldFlamingos 2 dynamic step configuration
- alias(alias: str) Flamingos2DynamicFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod central_wavelength() WavelengthFields[source]¶
Central wavelength, which is taken from the filter wavelength.
- decker: Flamingos2DynamicGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2DynamicGraphQLField object>¶
Flamingos 2 decker.
- disperser: Flamingos2DynamicGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2DynamicGraphQLField object>¶
Flamingos 2 disperser, if any.
- classmethod exposure() TimeSpanFields[source]¶
Flamingos 2 exposure time
- fields(*subfields: Flamingos2DynamicGraphQLField | Flamingos2FpuMaskFields | TimeSpanFields | WavelengthFields) Flamingos2DynamicFields[source]¶
Subfields should come from the Flamingos2DynamicFields class
- filter_: Flamingos2DynamicGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2DynamicGraphQLField object>¶
Flamingos 2 filter.
- classmethod fpu() Flamingos2FpuMaskFields[source]¶
Flamingos 2 FPU, if any.
- lyot_wheel: Flamingos2DynamicGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2DynamicGraphQLField object>¶
Flamingos 2 Lyot Wheel.
- read_mode: Flamingos2DynamicGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2DynamicGraphQLField object>¶
Flamingos 2 read mode.
- readout_mode: Flamingos2DynamicGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2DynamicGraphQLField object>¶
Flamingos 2 readout mode.
- reads: Flamingos2DynamicGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2DynamicGraphQLField object>¶
Flamingos 2 reads.
- class gpp_client.generated.custom_fields.Flamingos2ExecutionConfigFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldFlamingos 2 Execution Config
- classmethod acquisition() Flamingos2ExecutionSequenceFields[source]¶
Flamingos 2 acquisition execution sequence
- alias(alias: str) Flamingos2ExecutionConfigFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: Flamingos2ExecutionConfigGraphQLField | Flamingos2ExecutionSequenceFields | Flamingos2StaticFields) Flamingos2ExecutionConfigFields[source]¶
Subfields should come from the Flamingos2ExecutionConfigFields class
- classmethod science() Flamingos2ExecutionSequenceFields[source]¶
Flamingos 2 science execution
- classmethod static() Flamingos2StaticFields[source]¶
Flamingos 2 static configuration
- class gpp_client.generated.custom_fields.Flamingos2ExecutionSequenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldNext atom to execute and potential future atoms.
- alias(alias: str) Flamingos2ExecutionSequenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: Flamingos2ExecutionSequenceGraphQLField | Flamingos2AtomFields) Flamingos2ExecutionSequenceFields[source]¶
Subfields should come from the Flamingos2ExecutionSequenceFields class
- has_more: Flamingos2ExecutionSequenceGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2ExecutionSequenceGraphQLField object>¶
Whether there are more anticipated atoms than those that appear in ‘possibleFuture’.
- classmethod next_atom() Flamingos2AtomFields[source]¶
Next atom to execute.
- classmethod possible_future() Flamingos2AtomFields[source]¶
(Prefix of the) remaining atoms to execute, if any.
- class gpp_client.generated.custom_fields.Flamingos2FpuMaskFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldFlamingos 2 mask option, either builtin or custom mask
- alias(alias: str) Flamingos2FpuMaskFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- builtin: Flamingos2FpuMaskGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2FpuMaskGraphQLField object>¶
Flamingos 2 builtin FPU, if in use
- classmethod custom_mask() Flamingos2CustomMaskFields[source]¶
The custom mask, if in use
- fields(*subfields: Flamingos2FpuMaskGraphQLField | Flamingos2CustomMaskFields) Flamingos2FpuMaskFields[source]¶
Subfields should come from the Flamingos2FpuMaskFields class
- class gpp_client.generated.custom_fields.Flamingos2LongSlitAcquisitionFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldFlamingos2 Long Slit acquisition settings.
- alias(alias: str) Flamingos2LongSlitAcquisitionFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- default_filter: Flamingos2LongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitAcquisitionGraphQLField object>¶
The filter that will be used by default, if an explicit acquisition filter was not specified. The default is calculated as the acquisition filter closest in wavelength to the observation’s science filter.
- explicit_filter: Flamingos2LongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitAcquisitionGraphQLField object>¶
An explicitly specified filter to use in acquisition (if any).
- classmethod exposure_time_mode() ExposureTimeModeFields[source]¶
The exposure time mode used for ITC lookup for the acquisition sequence.
- fields(*subfields: Flamingos2LongSlitAcquisitionGraphQLField | ExposureTimeModeFields) Flamingos2LongSlitAcquisitionFields[source]¶
Subfields should come from the Flamingos2LongSlitAcquisitionFields class
- filter_: Flamingos2LongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitAcquisitionGraphQLField object>¶
The filter that will be used in the acquisition sequence. This will be the explicitFilter if specified, but otherwise the defaultFilter.
- class gpp_client.generated.custom_fields.Flamingos2LongSlitFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldFlamingos2 Long Slit mode
- classmethod acquisition() Flamingos2LongSlitAcquisitionFields[source]¶
Acquisition properties.
- alias(alias: str) Flamingos2LongSlitFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- decker: Flamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitGraphQLField object>¶
The decker field is either explicitly specified in explicitDecker or else taken from defaultDecker
- default_decker: Flamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitGraphQLField object>¶
Default decker, calculated based on the exposure time
- classmethod default_offsets() OffsetFields[source]¶
Default offsets.
- default_readout_mode: Flamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitGraphQLField object>¶
Default readout mode, science
- disperser: Flamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitGraphQLField object>¶
Flamingos2 Disperser
- explicit_decker: Flamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitGraphQLField object>¶
Optional explicitly specified F2 Decker. If set it overrides the default.
- classmethod explicit_offsets() OffsetFields[source]¶
Optional explicitly specified offsets. If set it overrides the the default.
- explicit_read_mode: Flamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitGraphQLField object>¶
Optional explicitly specified F2 ReadMode. If set it overrides the default.
- explicit_readout_mode: Flamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitGraphQLField object>¶
Optional explicitly specified F2 Readout mode. If set it overrides the default.
- explicit_reads: Flamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitGraphQLField object>¶
Optional explicitly specified F2 Reads. If set it overrides the default.
- classmethod exposure_time_mode() ExposureTimeModeFields[source]¶
The exposure time mode used for ITC lookup for the science sequence.
- fields(*subfields: Flamingos2LongSlitGraphQLField | ExposureTimeModeFields | Flamingos2LongSlitAcquisitionFields | OffsetFields | TelluricTypeFields) Flamingos2LongSlitFields[source]¶
Subfields should come from the Flamingos2LongSlitFields class
- filter_: Flamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitGraphQLField object>¶
Flamingos2 Filter
- fpu: Flamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitGraphQLField object>¶
Flamingos2 FPU
- initial_disperser: Flamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitGraphQLField object>¶
The disperser as it was initially selected. See the disperser field for the disperser that will be used in the observation.
- initial_filter: Flamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitGraphQLField object>¶
The filter as it was initially selected (if any). See the filter field for the filter that will be used in the observation.
- initial_fpu: Flamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitGraphQLField object>¶
The FPU as it was initially selected. See the fpu field for the FPU that will be used in the observation.
- classmethod offsets() OffsetFields[source]¶
Offsets, either explicitly specified in explicitOffsets or else taken from defaultOffsets
- readout_mode: Flamingos2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2LongSlitGraphQLField object>¶
The readoutMode field is either explicitly specified in explicitReadoutMode or else taken from defaultReadoutMode
- classmethod telluric_type() TelluricTypeFields[source]¶
Telluric type configuration for this observation.
- class gpp_client.generated.custom_fields.Flamingos2StaticFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldUnchanging (over the course of the sequence) configuration values
- alias(alias: str) Flamingos2StaticFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: Flamingos2StaticGraphQLField) Flamingos2StaticFields[source]¶
Subfields should come from the Flamingos2StaticFields class
- mos_pre_imaging: Flamingos2StaticGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2StaticGraphQLField object>¶
Is MOS Pre-Imaging Observation
- use_electronic_offsetting: Flamingos2StaticGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2StaticGraphQLField object>¶
Whether to use electronic offsetting
- class gpp_client.generated.custom_fields.Flamingos2StepFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldFlmaingos 2 step with potential breakpoint
- alias(alias: str) Flamingos2StepFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- breakpoint: Flamingos2StepGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2StepGraphQLField object>¶
Whether to pause before the execution of this step
- classmethod estimate() StepEstimateFields[source]¶
Time estimate for this step’s execution
- fields(*subfields: Flamingos2StepGraphQLField | Flamingos2DynamicFields | StepConfigInterface | StepEstimateFields | TelescopeConfigFields) Flamingos2StepFields[source]¶
Subfields should come from the Flamingos2StepFields class
- id: Flamingos2StepGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2StepGraphQLField object>¶
Step id
- classmethod instrument_config() Flamingos2DynamicFields[source]¶
Instrument configuration for this step
- observe_class: Flamingos2StepGraphQLField = <gpp_client.generated.custom_typing_fields.Flamingos2StepGraphQLField object>¶
Observe class for this step
- classmethod step_config() StepConfigInterface[source]¶
The sequence step itself
- classmethod telescope_config() TelescopeConfigFields[source]¶
The telescope configuration at this step.
- class gpp_client.generated.custom_fields.FluxDensityContinuumIntegratedFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) FluxDensityContinuumIntegratedFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- error: FluxDensityContinuumIntegratedGraphQLField = <gpp_client.generated.custom_typing_fields.FluxDensityContinuumIntegratedGraphQLField object>¶
- fields(*subfields: FluxDensityContinuumIntegratedGraphQLField) FluxDensityContinuumIntegratedFields[source]¶
Subfields should come from the FluxDensityContinuumIntegratedFields class
- units: FluxDensityContinuumIntegratedGraphQLField = <gpp_client.generated.custom_typing_fields.FluxDensityContinuumIntegratedGraphQLField object>¶
- value: FluxDensityContinuumIntegratedGraphQLField = <gpp_client.generated.custom_typing_fields.FluxDensityContinuumIntegratedGraphQLField object>¶
- class gpp_client.generated.custom_fields.FluxDensityContinuumSurfaceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) FluxDensityContinuumSurfaceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- error: FluxDensityContinuumSurfaceGraphQLField = <gpp_client.generated.custom_typing_fields.FluxDensityContinuumSurfaceGraphQLField object>¶
- fields(*subfields: FluxDensityContinuumSurfaceGraphQLField) FluxDensityContinuumSurfaceFields[source]¶
Subfields should come from the FluxDensityContinuumSurfaceFields class
- units: FluxDensityContinuumSurfaceGraphQLField = <gpp_client.generated.custom_typing_fields.FluxDensityContinuumSurfaceGraphQLField object>¶
- value: FluxDensityContinuumSurfaceGraphQLField = <gpp_client.generated.custom_typing_fields.FluxDensityContinuumSurfaceGraphQLField object>¶
- class gpp_client.generated.custom_fields.FluxDensityEntryFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) FluxDensityEntryFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- density: FluxDensityEntryGraphQLField = <gpp_client.generated.custom_typing_fields.FluxDensityEntryGraphQLField object>¶
- fields(*subfields: FluxDensityEntryGraphQLField | WavelengthFields) FluxDensityEntryFields[source]¶
Subfields should come from the FluxDensityEntryFields class
- classmethod wavelength() WavelengthFields[source]¶
- class gpp_client.generated.custom_fields.GaussianSourceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGaussian source, one of bandNormalized and emissionLines will be defined.
- alias(alias: str) GaussianSourceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod band_normalized() BandNormalizedIntegratedFields[source]¶
Band normalized spectral definition
- classmethod emission_lines() EmissionLinesIntegratedFields[source]¶
Emission lines spectral definition
- fields(*subfields: GaussianSourceGraphQLField | AngleFields | BandNormalizedIntegratedFields | EmissionLinesIntegratedFields) GaussianSourceFields[source]¶
Subfields should come from the GaussianSourceFields class
- classmethod fwhm() AngleFields[source]¶
full width at half maximum
- class gpp_client.generated.custom_fields.GcalFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGCAL calibration step (flat / arc)
- alias(alias: str) GcalFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- arcs: GcalGraphQLField = <gpp_client.generated.custom_typing_fields.GcalGraphQLField object>¶
GCAL arcs, one or more present if no continuum is used
- continuum: GcalGraphQLField = <gpp_client.generated.custom_typing_fields.GcalGraphQLField object>¶
GCAL continuum, present if no arcs are used
- diffuser: GcalGraphQLField = <gpp_client.generated.custom_typing_fields.GcalGraphQLField object>¶
GCAL diffuser
- fields(*subfields: GcalGraphQLField) GcalFields[source]¶
Subfields should come from the GcalFields class
- filter_: GcalGraphQLField = <gpp_client.generated.custom_typing_fields.GcalGraphQLField object>¶
GCAL filter
- shutter: GcalGraphQLField = <gpp_client.generated.custom_typing_fields.GcalGraphQLField object>¶
GCAL shutter
- step_type: GcalGraphQLField = <gpp_client.generated.custom_typing_fields.GcalGraphQLField object>¶
Step type
- class gpp_client.generated.custom_fields.GhostAtomFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGHOST atom, a collection of steps that should be executed in their entirety
- alias(alias: str) GhostAtomFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- description: GhostAtomGraphQLField = <gpp_client.generated.custom_typing_fields.GhostAtomGraphQLField object>¶
Optional description of the atom.
- fields(*subfields: GhostAtomGraphQLField | GhostStepFields) GhostAtomFields[source]¶
Subfields should come from the GhostAtomFields class
- id: GhostAtomGraphQLField = <gpp_client.generated.custom_typing_fields.GhostAtomGraphQLField object>¶
Atom id
- observe_class: GhostAtomGraphQLField = <gpp_client.generated.custom_typing_fields.GhostAtomGraphQLField object>¶
Observe class for this atom as a whole (combined observe class for each of its steps).
- classmethod steps() GhostStepFields[source]¶
Individual steps that comprise the atom
- class gpp_client.generated.custom_fields.GhostDetectorConfigFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) GhostDetectorConfigFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- binning: GhostDetectorConfigGraphQLField = <gpp_client.generated.custom_typing_fields.GhostDetectorConfigGraphQLField object>¶
Binning that will be used, either explicitly specified or default.
- default_binning: GhostDetectorConfigGraphQLField = <gpp_client.generated.custom_typing_fields.GhostDetectorConfigGraphQLField object>¶
Default binning that will be used for the detector, if not explicitly specified.
- default_read_mode: GhostDetectorConfigGraphQLField = <gpp_client.generated.custom_typing_fields.GhostDetectorConfigGraphQLField object>¶
Default read mode that will be used for the detector, if not explicitly specified.
- explicit_binning: GhostDetectorConfigGraphQLField = <gpp_client.generated.custom_typing_fields.GhostDetectorConfigGraphQLField object>¶
Explicit binning to use for the detector, if specified.
- explicit_read_mode: GhostDetectorConfigGraphQLField = <gpp_client.generated.custom_typing_fields.GhostDetectorConfigGraphQLField object>¶
Explicit read mode for the detector, if specified.
- classmethod exposure_time_mode() ExposureTimeModeFields[source]¶
Exposure time mode for the detector.
- fields(*subfields: GhostDetectorConfigGraphQLField | ExposureTimeModeFields) GhostDetectorConfigFields[source]¶
Subfields should come from the GhostDetectorConfigFields class
- read_mode: GhostDetectorConfigGraphQLField = <gpp_client.generated.custom_typing_fields.GhostDetectorConfigGraphQLField object>¶
Read mode for the detector, either explicitly specified or default.
- class gpp_client.generated.custom_fields.GhostDetectorFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGHOST detector configuration for a single step.
- alias(alias: str) GhostDetectorFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- binning: GhostDetectorGraphQLField = <gpp_client.generated.custom_typing_fields.GhostDetectorGraphQLField object>¶
- exposure_count: GhostDetectorGraphQLField = <gpp_client.generated.custom_typing_fields.GhostDetectorGraphQLField object>¶
- classmethod exposure_time() TimeSpanFields[source]¶
- fields(*subfields: GhostDetectorGraphQLField | TimeSpanFields) GhostDetectorFields[source]¶
Subfields should come from the GhostDetectorFields class
- read_mode: GhostDetectorGraphQLField = <gpp_client.generated.custom_typing_fields.GhostDetectorGraphQLField object>¶
- class gpp_client.generated.custom_fields.GhostDynamicFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGHOST instrument configuration for a single step.
- alias(alias: str) GhostDynamicFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod blue() GhostDetectorFields[source]¶
- classmethod central_wavelength() WavelengthFields[source]¶
Central wavelength, which is fixed at 655 nm.
- fields(*subfields: GhostDynamicGraphQLField | GhostDetectorFields | WavelengthFields) GhostDynamicFields[source]¶
Subfields should come from the GhostDynamicFields class
- ifu_1_fiber_agitator: GhostDynamicGraphQLField = <gpp_client.generated.custom_typing_fields.GhostDynamicGraphQLField object>¶
- ifu_2_fiber_agitator: GhostDynamicGraphQLField = <gpp_client.generated.custom_typing_fields.GhostDynamicGraphQLField object>¶
- classmethod red() GhostDetectorFields[source]¶
- class gpp_client.generated.custom_fields.GhostExecutionConfigFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGHOST Execution Config
- alias(alias: str) GhostExecutionConfigFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GhostExecutionConfigGraphQLField | GhostExecutionSequenceFields | GhostStaticFields) GhostExecutionConfigFields[source]¶
Subfields should come from the GhostExecutionConfigFields class
- classmethod science() GhostExecutionSequenceFields[source]¶
GHOST science execution
- classmethod static() GhostStaticFields[source]¶
GHOST static configuration
- class gpp_client.generated.custom_fields.GhostExecutionSequenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldNext atom to execute and potential future atoms.
- alias(alias: str) GhostExecutionSequenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GhostExecutionSequenceGraphQLField | GhostAtomFields) GhostExecutionSequenceFields[source]¶
Subfields should come from the GhostExecutionSequenceFields class
- has_more: GhostExecutionSequenceGraphQLField = <gpp_client.generated.custom_typing_fields.GhostExecutionSequenceGraphQLField object>¶
Whether there are more anticipated atoms than those that appear in ‘possibleFuture’.
- classmethod next_atom() GhostAtomFields[source]¶
Next atom to execute.
- classmethod possible_future() GhostAtomFields[source]¶
(Prefix of the) remaining atoms to execute, if any.
- class gpp_client.generated.custom_fields.GhostIfuFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGHOST IFU observing mode.
- alias(alias: str) GhostIfuFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod blue() GhostDetectorConfigFields[source]¶
Blue detector config.
- default_ifu_1_agitator: GhostIfuGraphQLField = <gpp_client.generated.custom_typing_fields.GhostIfuGraphQLField object>¶
Default IFU 1 fiber agitator setting, used if not explicitly specified.
- default_ifu_2_agitator: GhostIfuGraphQLField = <gpp_client.generated.custom_typing_fields.GhostIfuGraphQLField object>¶
Default IFU 2 fiber agitator setting, used if not explicitly specified.
- explicit_ifu_1_agitator: GhostIfuGraphQLField = <gpp_client.generated.custom_typing_fields.GhostIfuGraphQLField object>¶
IFU 1 fiber agitator setting, if explicitly specified.
- explicit_ifu_2_agitator: GhostIfuGraphQLField = <gpp_client.generated.custom_typing_fields.GhostIfuGraphQLField object>¶
IFU 2 fiber agitator setting, if explicitly specified.
- fields(*subfields: GhostIfuGraphQLField | GhostDetectorConfigFields | TimeSpanFields) GhostIfuFields[source]¶
Subfields should come from the GhostIfuFields class
- ifu_1_agitator: GhostIfuGraphQLField = <gpp_client.generated.custom_typing_fields.GhostIfuGraphQLField object>¶
IFU 1 fiber agitator setting, either explicitly specified or else default.
- ifu_2_agitator: GhostIfuGraphQLField = <gpp_client.generated.custom_typing_fields.GhostIfuGraphQLField object>¶
IFU 2 fiber agitator setting, either explicitly specified or else default.
- classmethod red() GhostDetectorConfigFields[source]¶
Red detector config.
- resolution_mode: GhostIfuGraphQLField = <gpp_client.generated.custom_typing_fields.GhostIfuGraphQLField object>¶
Resolution mode.
- classmethod slit_viewing_camera_exposure_time() TimeSpanFields[source]¶
Slit viewing camera exposure time (if specified).
- step_count: GhostIfuGraphQLField = <gpp_client.generated.custom_typing_fields.GhostIfuGraphQLField object>¶
Number of steps requested.
- class gpp_client.generated.custom_fields.GhostStaticFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGHOST configuration that applies across all steps.
- alias(alias: str) GhostStaticFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GhostStaticGraphQLField | TimeSpanFields) GhostStaticFields[source]¶
Subfields should come from the GhostStaticFields class
- resolution_mode: GhostStaticGraphQLField = <gpp_client.generated.custom_typing_fields.GhostStaticGraphQLField object>¶
- classmethod slit_viewing_camera_exposure_time() TimeSpanFields[source]¶
- class gpp_client.generated.custom_fields.GhostStepFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGHOST step with potential breakpoint.
- alias(alias: str) GhostStepFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- breakpoint: GhostStepGraphQLField = <gpp_client.generated.custom_typing_fields.GhostStepGraphQLField object>¶
Whether to pause before the execution of this step
- classmethod estimate() StepEstimateFields[source]¶
Time estimate for this step’s execution
- fields(*subfields: GhostStepGraphQLField | GhostDynamicFields | StepConfigInterface | StepEstimateFields | TelescopeConfigFields) GhostStepFields[source]¶
Subfields should come from the GhostStepFields class
- id: GhostStepGraphQLField = <gpp_client.generated.custom_typing_fields.GhostStepGraphQLField object>¶
Step id
- classmethod instrument_config() GhostDynamicFields[source]¶
Instrument configuration for this step
- observe_class: GhostStepGraphQLField = <gpp_client.generated.custom_typing_fields.GhostStepGraphQLField object>¶
Observe class for this step
- classmethod step_config() StepConfigInterface[source]¶
The sequence step itself
- classmethod telescope_config() TelescopeConfigFields[source]¶
The telescope configuration at this step.
- class gpp_client.generated.custom_fields.GmosCcdModeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldCCD Readout Configuration
- alias(alias: str) GmosCcdModeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- amp_count: GmosCcdModeGraphQLField = <gpp_client.generated.custom_typing_fields.GmosCcdModeGraphQLField object>¶
GMOS Amp Count
- amp_gain: GmosCcdModeGraphQLField = <gpp_client.generated.custom_typing_fields.GmosCcdModeGraphQLField object>¶
GMOS Amp Gain
- amp_read_mode: GmosCcdModeGraphQLField = <gpp_client.generated.custom_typing_fields.GmosCcdModeGraphQLField object>¶
GMOS Amp Read Mode
- fields(*subfields: GmosCcdModeGraphQLField) GmosCcdModeFields[source]¶
Subfields should come from the GmosCcdModeFields class
- x_bin: GmosCcdModeGraphQLField = <gpp_client.generated.custom_typing_fields.GmosCcdModeGraphQLField object>¶
GMOS X-binning
- y_bin: GmosCcdModeGraphQLField = <gpp_client.generated.custom_typing_fields.GmosCcdModeGraphQLField object>¶
GMOS Y-binning
- class gpp_client.generated.custom_fields.GmosCustomMaskFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS Custom Mask
- alias(alias: str) GmosCustomMaskFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GmosCustomMaskGraphQLField) GmosCustomMaskFields[source]¶
Subfields should come from the GmosCustomMaskFields class
- filename: GmosCustomMaskGraphQLField = <gpp_client.generated.custom_typing_fields.GmosCustomMaskGraphQLField object>¶
Custom Mask Filename
- slit_width: GmosCustomMaskGraphQLField = <gpp_client.generated.custom_typing_fields.GmosCustomMaskGraphQLField object>¶
Custom Slit Width
- class gpp_client.generated.custom_fields.GmosGroupedImagingVariantFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldWhen doing “grouped” filter imaging, datasets associated with a particular filter are collected consecutively before moving on to other filters (if any). Sky datasets may be collected before and after each group of object datasets.
- alias(alias: str) GmosGroupedImagingVariantFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GmosGroupedImagingVariantGraphQLField | TelescopeConfigGeneratorFields) GmosGroupedImagingVariantFields[source]¶
Subfields should come from the GmosGroupedImagingVariantFields class
- classmethod offsets() TelescopeConfigGeneratorFields[source]¶
Offset generator for the science object datasets. The same offset sequence is created for each filter using the specified generator.
- order: GmosGroupedImagingVariantGraphQLField = <gpp_client.generated.custom_typing_fields.GmosGroupedImagingVariantGraphQLField object>¶
Whether the filters should appear in the sequence in increasing or decreasing order by their wavelength.
- sky_count: GmosGroupedImagingVariantGraphQLField = <gpp_client.generated.custom_typing_fields.GmosGroupedImagingVariantGraphQLField object>¶
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.
- classmethod sky_offsets() TelescopeConfigGeneratorFields[source]¶
Offset generator to use for the sky datasets.
- class gpp_client.generated.custom_fields.GmosImagingVariantFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe specific imaging sub-type, one of which will be defined and the remaining options null.
- alias(alias: str) GmosImagingVariantFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GmosImagingVariantGraphQLField | GmosGroupedImagingVariantFields | GmosInterleavedImagingVariantFields | GmosPreImagingVariantFields) GmosImagingVariantFields[source]¶
Subfields should come from the GmosImagingVariantFields class
- classmethod grouped() GmosGroupedImagingVariantFields[source]¶
Grouped mode collects all datasets for each filter before changing filters.
- classmethod interleaved() GmosInterleavedImagingVariantFields[source]¶
Interleaved mode cycles through all filters repeatedly.
- classmethod pre_imaging() GmosPreImagingVariantFields[source]¶
PreImaging mode is used for MOS mask creation.
- variant_type: GmosImagingVariantGraphQLField = <gpp_client.generated.custom_typing_fields.GmosImagingVariantGraphQLField object>¶
- class gpp_client.generated.custom_fields.GmosInterleavedImagingVariantFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldWhen doing “interleaved” filter imaging, the sequence repeatedly alternates through the set of filters in use.
- alias(alias: str) GmosInterleavedImagingVariantFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GmosInterleavedImagingVariantGraphQLField | TelescopeConfigGeneratorFields) GmosInterleavedImagingVariantFields[source]¶
Subfields should come from the GmosInterleavedImagingVariantFields class
- classmethod offsets() TelescopeConfigGeneratorFields[source]¶
Offset generator for the science object datasets. The offset pattern is applied to the sequence of science datasets as a whole.
- sky_count: GmosInterleavedImagingVariantGraphQLField = <gpp_client.generated.custom_typing_fields.GmosInterleavedImagingVariantGraphQLField object>¶
Number of sky positions to collect, per filter, before and after a series of object datasets. For example, if set to 2 and 2 filters are in use, there would be 4 sky positions before (2 per filter) and 4 after (2 per filter).
- classmethod sky_offsets() TelescopeConfigGeneratorFields[source]¶
Offset generator to use for the sky datasets.
- class gpp_client.generated.custom_fields.GmosNodAndShuffleFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) GmosNodAndShuffleFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- e_offset: GmosNodAndShuffleGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNodAndShuffleGraphQLField object>¶
Whether to use electronic offsetting
- fields(*subfields: GmosNodAndShuffleGraphQLField | OffsetFields) GmosNodAndShuffleFields[source]¶
Subfields should come from the GmosNodAndShuffleFields class
- classmethod pos_a() OffsetFields[source]¶
Offset position A
- classmethod pos_b() OffsetFields[source]¶
Offset position B
- shuffle_cycles: GmosNodAndShuffleGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNodAndShuffleGraphQLField object>¶
Shuffle cycles
- shuffle_offset: GmosNodAndShuffleGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNodAndShuffleGraphQLField object>¶
Shuffle offset
- class gpp_client.generated.custom_fields.GmosNorthAtomFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGmosNorth atom, a collection of steps that should be executed in their entirety
- alias(alias: str) GmosNorthAtomFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- description: GmosNorthAtomGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthAtomGraphQLField object>¶
Optional description of the atom.
- fields(*subfields: GmosNorthAtomGraphQLField | GmosNorthStepFields) GmosNorthAtomFields[source]¶
Subfields should come from the GmosNorthAtomFields class
- id: GmosNorthAtomGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthAtomGraphQLField object>¶
Atom id
- observe_class: GmosNorthAtomGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthAtomGraphQLField object>¶
Observe class for this atom as a whole (combined observe class for each of its steps).
- classmethod steps() GmosNorthStepFields[source]¶
Individual steps that comprise the atom
- class gpp_client.generated.custom_fields.GmosNorthDynamicFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS North dynamic step configuration
- alias(alias: str) GmosNorthDynamicFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod central_wavelength() WavelengthFields[source]¶
Central wavelength, which is taken from the grating (if defined) or else from the filter (if defined).
- dtax: GmosNorthDynamicGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthDynamicGraphQLField object>¶
GMOS detector x offset
- classmethod exposure() TimeSpanFields[source]¶
GMOS exposure time
- fields(*subfields: GmosNorthDynamicGraphQLField | GmosCcdModeFields | GmosNorthFpuFields | GmosNorthGratingConfigFields | TimeSpanFields | WavelengthFields) GmosNorthDynamicFields[source]¶
Subfields should come from the GmosNorthDynamicFields class
- filter_: GmosNorthDynamicGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthDynamicGraphQLField object>¶
GMOS North filter
- classmethod fpu() GmosNorthFpuFields[source]¶
GMOS North FPU
- classmethod grating_config() GmosNorthGratingConfigFields[source]¶
GMOS North grating
- classmethod readout() GmosCcdModeFields[source]¶
GMOS CCD Readout
- roi: GmosNorthDynamicGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthDynamicGraphQLField object>¶
GMOS region of interest
- class gpp_client.generated.custom_fields.GmosNorthExecutionConfigFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS North Execution Config
- classmethod acquisition() GmosNorthExecutionSequenceFields[source]¶
GMOS North acquisition execution sequence
- alias(alias: str) GmosNorthExecutionConfigFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GmosNorthExecutionConfigGraphQLField | GmosNorthExecutionSequenceFields | GmosNorthStaticFields) GmosNorthExecutionConfigFields[source]¶
Subfields should come from the GmosNorthExecutionConfigFields class
- classmethod science() GmosNorthExecutionSequenceFields[source]¶
GMOS North science execution
- classmethod static() GmosNorthStaticFields[source]¶
GMOS North static configuration
- class gpp_client.generated.custom_fields.GmosNorthExecutionSequenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldNext atom to execute and potential future atoms.
- alias(alias: str) GmosNorthExecutionSequenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GmosNorthExecutionSequenceGraphQLField | GmosNorthAtomFields) GmosNorthExecutionSequenceFields[source]¶
Subfields should come from the GmosNorthExecutionSequenceFields class
- has_more: GmosNorthExecutionSequenceGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthExecutionSequenceGraphQLField object>¶
Whether there are more anticipated atoms than those that appear in ‘possibleFuture’.
- classmethod next_atom() GmosNorthAtomFields[source]¶
Next atom to execute.
- classmethod possible_future() GmosNorthAtomFields[source]¶
(Prefix of the) remaining atoms to execute, if any.
- class gpp_client.generated.custom_fields.GmosNorthFpuFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS North FPU option, either builtin or custom mask
- alias(alias: str) GmosNorthFpuFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- builtin: GmosNorthFpuGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthFpuGraphQLField object>¶
GMOS North builtin FPU, if in use
- classmethod custom_mask() GmosCustomMaskFields[source]¶
The custom mask, if in use
- fields(*subfields: GmosNorthFpuGraphQLField | GmosCustomMaskFields) GmosNorthFpuFields[source]¶
Subfields should come from the GmosNorthFpuFields class
- class gpp_client.generated.custom_fields.GmosNorthGratingConfigFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS North Grating Configuration
- alias(alias: str) GmosNorthGratingConfigFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GmosNorthGratingConfigGraphQLField | WavelengthFields) GmosNorthGratingConfigFields[source]¶
Subfields should come from the GmosNorthGratingConfigFields class
- grating: GmosNorthGratingConfigGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthGratingConfigGraphQLField object>¶
GMOS North Grating
- order: GmosNorthGratingConfigGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthGratingConfigGraphQLField object>¶
GMOS grating order
- classmethod wavelength() WavelengthFields[source]¶
Grating wavelength
- class gpp_client.generated.custom_fields.GmosNorthImagingFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS North Imaging mode
- alias(alias: str) GmosNorthImagingFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- amp_gain: GmosNorthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthImagingGraphQLField object>¶
GMOS amp read gain, either explicitly specified in explicitAmpGain or else taken from the defaultAmpGain.
- amp_read_mode: GmosNorthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthImagingGraphQLField object>¶
GMOS amp read mode, either explicitly specified in explicitAmpReadMode or else taken from the defaultAmpReadMode.
- bin: GmosNorthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthImagingGraphQLField object>¶
GMOS Binning, either explicitly specified in explicitBin or else taken from the defaultBin. XBinning == YBinning = Binning
- default_amp_gain: GmosNorthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthImagingGraphQLField object>¶
Default GMOS amp gain (LOW).
- default_amp_read_mode: GmosNorthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthImagingGraphQLField object>¶
Default GmosAmpReadMode (SLOW).
- default_bin: GmosNorthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthImagingGraphQLField object>¶
Default GMOS Binning (TWO).
- default_roi: GmosNorthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthImagingGraphQLField object>¶
Default GMOS ROI (FULL_FRAME).
- explicit_amp_gain: GmosNorthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthImagingGraphQLField object>¶
Optional explicitly specified GMOS amp gain. If set it override the default.
- explicit_amp_read_mode: GmosNorthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthImagingGraphQLField object>¶
Optional explicitly specified GMOS amp read mode. If set it overrides the default.
- explicit_bin: GmosNorthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthImagingGraphQLField object>¶
Optional explicitly specified GMOS Binning. If set it overrides the default.
- explicit_roi: GmosNorthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthImagingGraphQLField object>¶
Optional explicitly specified GMOS ROI. If set it overrides the default.
- fields(*subfields: GmosNorthImagingGraphQLField | GmosImagingVariantFields | GmosNorthImagingFilterFields) GmosNorthImagingFields[source]¶
Subfields should come from the GmosNorthImagingFields class
- classmethod filters() GmosNorthImagingFilterFields[source]¶
The filters (at least one is required) to be used for data collection. How they are used depends on the imaging variant configuration.
- classmethod initial_filters() GmosNorthImagingFilterFields[source]¶
Initial GMOS North Filters that were used when creating the imaging mode.
- roi: GmosNorthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthImagingGraphQLField object>¶
GMOS ROI, either explicitly specified in explicitRoi or else taken from the defaultRoi.
- classmethod variant() GmosImagingVariantFields[source]¶
Details specific to the type of imaging being performed.
- class gpp_client.generated.custom_fields.GmosNorthImagingFilterFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldImaging filters combine an actual filter with an exposure time mode.
- alias(alias: str) GmosNorthImagingFilterFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod exposure_time_mode() ExposureTimeModeFields[source]¶
- fields(*subfields: GmosNorthImagingFilterGraphQLField | ExposureTimeModeFields) GmosNorthImagingFilterFields[source]¶
Subfields should come from the GmosNorthImagingFilterFields class
- filter_: GmosNorthImagingFilterGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthImagingFilterGraphQLField object>¶
- class gpp_client.generated.custom_fields.GmosNorthLongSlitAcquisitionFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldAcquisition settings for GMOS North long slit acquisition.
- alias(alias: str) GmosNorthLongSlitAcquisitionFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- default_filter: GmosNorthLongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitAcquisitionGraphQLField object>¶
The GMOS Nouth filter that will be used by default, if an explicit acquisition filter was not specified. The default is calculated as the broadband filter closest in wavelength to the observation’s centralWavelength.
- default_roi: GmosNorthLongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitAcquisitionGraphQLField object>¶
The acquisition ROI(s) that will be used by default, if an explicit ROI was not specified.
- explicit_filter: GmosNorthLongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitAcquisitionGraphQLField object>¶
An explicitly specified GMOS North filter to use in acquisition (if any).
- explicit_roi: GmosNorthLongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitAcquisitionGraphQLField object>¶
An explicitly specified ROI to use in acquisition (if any).
- classmethod exposure_time_mode() ExposureTimeModeFields[source]¶
The exposure time mode used for ITC lookup for the acquisition sequence.
- fields(*subfields: GmosNorthLongSlitAcquisitionGraphQLField | ExposureTimeModeFields) GmosNorthLongSlitAcquisitionFields[source]¶
Subfields should come from the GmosNorthLongSlitAcquisitionFields class
- filter_: GmosNorthLongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitAcquisitionGraphQLField object>¶
The GMOS North filter that will be used in the acquisition sequence. This will be the explicitFilter if specified, but otherwise the defaultFilter.
- roi: GmosNorthLongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitAcquisitionGraphQLField object>¶
The ROI(s) that will be used for the acquisition sequence. In the case of a compound ROI such as CCD2_STAMP, the first will be used for the imaging step and the second for the remainder of the steps.
- class gpp_client.generated.custom_fields.GmosNorthLongSlitFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS North Long Slit mode
- classmethod acquisition() GmosNorthLongSlitAcquisitionFields[source]¶
Settings that apply to the acquisition sequence.
- alias(alias: str) GmosNorthLongSlitFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- amp_gain: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
GMOS amp read gain, either explicitly specified in explicitAmpGain or else taken from the defaultAmpGain.
- amp_read_mode: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
GMOS amp read mode, either explicitly specified in explicitAmpReadMode or else taken from the defaultAmpReadMode.
- classmethod central_wavelength() WavelengthFields[source]¶
The central wavelength, either explicitly specified in explicitCentralWavelength or else taken from the defaultCentralWavelength.
- default_amp_gain: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
Default GMOS amp gain (LOW).
- default_amp_read_mode: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
Default GmosAmpReadMode (SLOW).
- classmethod default_offsets() OffsetQFields[source]¶
Default offsets.
- default_roi: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
Default GMOS ROI (FULL_FRAME).
- classmethod default_spatial_offsets() OffsetQFields[source]¶
Default spatial offsets.
- classmethod default_wavelength_dithers() WavelengthDitherFields[source]¶
Default wavelength dithers, calculated based on the grating dispersion.
- default_x_bin: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
Default GMOS X-Binning, calculated from the effective slit size which in turn is based on the selected FPU, target source profile and image quality.
- default_y_bin: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
Default GMOS Y-Binning (TWO).
- explicit_amp_gain: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
Optional explicitly specified GMOS amp gain. If set it override the default.
- explicit_amp_read_mode: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
Optional explicitly specified GMOS amp read mode. If set it overrides the default.
- classmethod explicit_offsets() OffsetQFields[source]¶
Optional explicitly specified q offsets. If set it overrides the the default.
- explicit_roi: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
Optional explicitly specified GMOS ROI. If set it overrides the default.
- classmethod explicit_spatial_offsets() OffsetQFields[source]¶
Optional explicitly specified spatial q offsets. If set it overrides the the default.
- classmethod explicit_wavelength_dithers() WavelengthDitherFields[source]¶
Optional explicitly specified wavelength dithers. If set it overrides the default.
- explicit_x_bin: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
Optional explicitly specified GMOS X-Binning. If set it overrides the default.
- explicit_y_bin: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
Optional explicitly specified GMOS Y-Binning. If set it overrides the default.
- classmethod exposure_time_mode() ExposureTimeModeFields[source]¶
The exposure time mode used for ITC lookup for the science sequence.
- fields(*subfields: GmosNorthLongSlitGraphQLField | ExposureTimeModeFields | GmosNorthLongSlitAcquisitionFields | OffsetQFields | WavelengthDitherFields | WavelengthFields) GmosNorthLongSlitFields[source]¶
Subfields should come from the GmosNorthLongSlitFields class
- filter_: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
GMOS North Filter
- fpu: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
GMOS North FPU
- grating: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
GMOS North Grating
- classmethod initial_central_wavelength() WavelengthFields[source]¶
The central wavelength as initially selected. See the centralWavelength field for the wavelength that will be used in the observation.
- initial_filter: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
The filter as it was initially selected (if any). See the filter field for the filter that will be used in the observation.
- initial_fpu: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
The FPU as it was initially selected. See the fpu field for the FPU that will be used in the observation.
- initial_grating: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
The grating as it was initially selected. See the grating field for the grating that will be used in the observation.
- classmethod offsets() OffsetQFields[source]¶
Q offsets, either explicitly specified in explicitOffsets or else taken from defaultOffsets
- roi: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
GMOS ROI, either explicitly specified in explicitRoi or else taken from the defaultRoi.
- classmethod spatial_offsets() OffsetQFields[source]¶
Spacial q offsets, either explicitly specified in explicitSpatialOffsets or else taken from defaultSpatialOffsets
- classmethod wavelength_dithers() WavelengthDitherFields[source]¶
Wavelength dithers required to fill in the chip gaps. This value is either explicitly specified in explicitWavelengthDithers or else taken from defaultWavelengthDithers
- x_bin: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
GMOS X-Binning, either explicitly specified in explicitXBin or else taken from the defaultXBin.
- y_bin: GmosNorthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthLongSlitGraphQLField object>¶
GMOS Y-Binning, either explicitly specified in explicitYBin or else taken from the defaultYBin.
- class gpp_client.generated.custom_fields.GmosNorthStaticFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldUnchanging (over the course of the sequence) configuration values
- alias(alias: str) GmosNorthStaticFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- detector: GmosNorthStaticGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthStaticGraphQLField object>¶
Detector in use (always HAMAMATSU for recent and new observations)
- fields(*subfields: GmosNorthStaticGraphQLField | GmosNodAndShuffleFields) GmosNorthStaticFields[source]¶
Subfields should come from the GmosNorthStaticFields class
- mos_pre_imaging: GmosNorthStaticGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthStaticGraphQLField object>¶
Is MOS Pre-Imaging Observation
- classmethod nod_and_shuffle() GmosNodAndShuffleFields[source]¶
Nod-and-shuffle configuration. This is currently not used and will always return null.
- stage_mode: GmosNorthStaticGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthStaticGraphQLField object>¶
Stage mode
- class gpp_client.generated.custom_fields.GmosNorthStepFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGmosNorth step with potential breakpoint
- alias(alias: str) GmosNorthStepFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- breakpoint: GmosNorthStepGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthStepGraphQLField object>¶
Whether to pause before the execution of this step
- classmethod estimate() StepEstimateFields[source]¶
Time estimate for this step’s execution
- fields(*subfields: GmosNorthStepGraphQLField | GmosNorthDynamicFields | StepConfigInterface | StepEstimateFields | TelescopeConfigFields) GmosNorthStepFields[source]¶
Subfields should come from the GmosNorthStepFields class
- id: GmosNorthStepGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthStepGraphQLField object>¶
Step id
- classmethod instrument_config() GmosNorthDynamicFields[source]¶
Instrument configuration for this step
- observe_class: GmosNorthStepGraphQLField = <gpp_client.generated.custom_typing_fields.GmosNorthStepGraphQLField object>¶
Observe class for this step
- classmethod step_config() StepConfigInterface[source]¶
The sequence step itself
- classmethod telescope_config() TelescopeConfigFields[source]¶
The telescope configuration at this step.
- class gpp_client.generated.custom_fields.GmosPreImagingVariantFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA special imaging case, MOS pre-imaging is defined by an offset region.
- alias(alias: str) GmosPreImagingVariantFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GmosPreImagingVariantGraphQLField | OffsetFields) GmosPreImagingVariantFields[source]¶
Subfields should come from the GmosPreImagingVariantFields class
- classmethod offset_1() OffsetFields[source]¶
- classmethod offset_2() OffsetFields[source]¶
- classmethod offset_3() OffsetFields[source]¶
- classmethod offset_4() OffsetFields[source]¶
- class gpp_client.generated.custom_fields.GmosSouthAtomFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGmosSouth atom, a collection of steps that should be executed in their entirety
- alias(alias: str) GmosSouthAtomFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- description: GmosSouthAtomGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthAtomGraphQLField object>¶
Optional description of the atom.
- fields(*subfields: GmosSouthAtomGraphQLField | GmosSouthStepFields) GmosSouthAtomFields[source]¶
Subfields should come from the GmosSouthAtomFields class
- id: GmosSouthAtomGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthAtomGraphQLField object>¶
Atom id
- observe_class: GmosSouthAtomGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthAtomGraphQLField object>¶
Observe class for this atom as a whole (combined observe class for each of its steps).
- classmethod steps() GmosSouthStepFields[source]¶
Individual steps that comprise the atom
- class gpp_client.generated.custom_fields.GmosSouthDynamicFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS South dynamic step configuration
- alias(alias: str) GmosSouthDynamicFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod central_wavelength() WavelengthFields[source]¶
Central wavelength, which is taken from the grating (if defined) or else from the filter (if defined).
- dtax: GmosSouthDynamicGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthDynamicGraphQLField object>¶
GMOS detector x offset
- classmethod exposure() TimeSpanFields[source]¶
GMOS exposure time
- fields(*subfields: GmosSouthDynamicGraphQLField | GmosCcdModeFields | GmosSouthFpuFields | GmosSouthGratingConfigFields | TimeSpanFields | WavelengthFields) GmosSouthDynamicFields[source]¶
Subfields should come from the GmosSouthDynamicFields class
- filter_: GmosSouthDynamicGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthDynamicGraphQLField object>¶
GMOS South filter
- classmethod fpu() GmosSouthFpuFields[source]¶
GMOS South FPU
- classmethod grating_config() GmosSouthGratingConfigFields[source]¶
GMOS South grating
- classmethod readout() GmosCcdModeFields[source]¶
GMOS CCD Readout
- roi: GmosSouthDynamicGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthDynamicGraphQLField object>¶
GMOS region of interest
- class gpp_client.generated.custom_fields.GmosSouthExecutionConfigFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS South Execution Config
- classmethod acquisition() GmosSouthExecutionSequenceFields[source]¶
GMOS South acquisition execution sequence.
- alias(alias: str) GmosSouthExecutionConfigFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GmosSouthExecutionConfigGraphQLField | GmosSouthExecutionSequenceFields | GmosSouthStaticFields) GmosSouthExecutionConfigFields[source]¶
Subfields should come from the GmosSouthExecutionConfigFields class
- classmethod science() GmosSouthExecutionSequenceFields[source]¶
GMOS South science execution
- classmethod static() GmosSouthStaticFields[source]¶
GMOS South static configuration
- class gpp_client.generated.custom_fields.GmosSouthExecutionSequenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldNext atom to execute and potential future atoms.
- alias(alias: str) GmosSouthExecutionSequenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GmosSouthExecutionSequenceGraphQLField | GmosSouthAtomFields) GmosSouthExecutionSequenceFields[source]¶
Subfields should come from the GmosSouthExecutionSequenceFields class
- has_more: GmosSouthExecutionSequenceGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthExecutionSequenceGraphQLField object>¶
Whether there are more anticipated atoms than those that appear in ‘possibleFuture’.
- classmethod next_atom() GmosSouthAtomFields[source]¶
Next atom to execute.
- classmethod possible_future() GmosSouthAtomFields[source]¶
(Prefix of the) remaining atoms to execute, if any.
- class gpp_client.generated.custom_fields.GmosSouthFpuFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS South FPU option, either builtin or custom mask
- alias(alias: str) GmosSouthFpuFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- builtin: GmosSouthFpuGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthFpuGraphQLField object>¶
GMOS South builtin FPU, if in use
- classmethod custom_mask() GmosCustomMaskFields[source]¶
The custom mask, if in use
- fields(*subfields: GmosSouthFpuGraphQLField | GmosCustomMaskFields) GmosSouthFpuFields[source]¶
Subfields should come from the GmosSouthFpuFields class
- class gpp_client.generated.custom_fields.GmosSouthGratingConfigFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS South Grating Configuration
- alias(alias: str) GmosSouthGratingConfigFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GmosSouthGratingConfigGraphQLField | WavelengthFields) GmosSouthGratingConfigFields[source]¶
Subfields should come from the GmosSouthGratingConfigFields class
- grating: GmosSouthGratingConfigGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthGratingConfigGraphQLField object>¶
GMOS South Grating
- order: GmosSouthGratingConfigGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthGratingConfigGraphQLField object>¶
GMOS grating order
- classmethod wavelength() WavelengthFields[source]¶
Grating wavelength
- class gpp_client.generated.custom_fields.GmosSouthImagingFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS South Imaging mode
- alias(alias: str) GmosSouthImagingFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- amp_gain: GmosSouthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthImagingGraphQLField object>¶
GMOS amp read gain, either explicitly specified in explicitAmpGain or else taken from the defaultAmpGain.
- amp_read_mode: GmosSouthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthImagingGraphQLField object>¶
GMOS amp read mode, either explicitly specified in explicitAmpReadMode or else taken from the defaultAmpReadMode.
- bin: GmosSouthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthImagingGraphQLField object>¶
GMOS Binning, either explicitly specified in explicitBin or else taken from the defaultBin. XBinning == YBinning = Binning
- default_amp_gain: GmosSouthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthImagingGraphQLField object>¶
Default GMOS amp gain (LOW).
- default_amp_read_mode: GmosSouthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthImagingGraphQLField object>¶
Default GmosAmpReadMode (SLOW).
- default_bin: GmosSouthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthImagingGraphQLField object>¶
Default GMOS Binning (TWO).
- default_roi: GmosSouthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthImagingGraphQLField object>¶
Default GMOS ROI (FULL_FRAME).
- explicit_amp_gain: GmosSouthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthImagingGraphQLField object>¶
Optional explicitly specified GMOS amp gain. If set it override the default.
- explicit_amp_read_mode: GmosSouthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthImagingGraphQLField object>¶
Optional explicitly specified GMOS amp read mode. If set it overrides the default.
- explicit_bin: GmosSouthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthImagingGraphQLField object>¶
Optional explicitly specified GMOS Binning. If set it overrides the default.
- explicit_roi: GmosSouthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthImagingGraphQLField object>¶
Optional explicitly specified GMOS ROI. If set it overrides the default.
- fields(*subfields: GmosSouthImagingGraphQLField | GmosImagingVariantFields | GmosSouthImagingFilterFields) GmosSouthImagingFields[source]¶
Subfields should come from the GmosSouthImagingFields class
- classmethod filters() GmosSouthImagingFilterFields[source]¶
The filters (at least one is required) to be used for data collection. How they are used depends on the imaging variant configuration.
- classmethod initial_filters() GmosSouthImagingFilterFields[source]¶
Initial GMOS North Filters that were used when creating the imaging mode.
- roi: GmosSouthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthImagingGraphQLField object>¶
GMOS ROI, either explicitly specified in explicitRoi or else taken from the defaultRoi.
- classmethod variant() GmosImagingVariantFields[source]¶
Details specific to the type of imaging being performed.
- class gpp_client.generated.custom_fields.GmosSouthImagingFilterFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldImaging filters combine an actual filter with an exposure time mode.
- alias(alias: str) GmosSouthImagingFilterFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod exposure_time_mode() ExposureTimeModeFields[source]¶
- fields(*subfields: GmosSouthImagingFilterGraphQLField | ExposureTimeModeFields) GmosSouthImagingFilterFields[source]¶
Subfields should come from the GmosSouthImagingFilterFields class
- filter_: GmosSouthImagingFilterGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthImagingFilterGraphQLField object>¶
- class gpp_client.generated.custom_fields.GmosSouthLongSlitAcquisitionFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldAcquisition settings for GMOS South long slit acquisition.
- alias(alias: str) GmosSouthLongSlitAcquisitionFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- default_filter: GmosSouthLongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitAcquisitionGraphQLField object>¶
The GMOS South filter that will be used by default, if an explicit acquisition filter was not specified. The default is calculated as the broadband filter closest in wavelength to the observation’s centralWavelength.
- default_roi: GmosSouthLongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitAcquisitionGraphQLField object>¶
The acquisition ROI(s) that will be used by default, if an explicit ROI was not specified.
- explicit_filter: GmosSouthLongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitAcquisitionGraphQLField object>¶
An explicitly specified GMOS South filter to use in acquisition (if any).
- explicit_roi: GmosSouthLongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitAcquisitionGraphQLField object>¶
An explicitly specified ROI to use in acquisition (if any).
- classmethod exposure_time_mode() ExposureTimeModeFields[source]¶
The exposure time mode used for ITC lookup for the acquisition sequence.
- fields(*subfields: GmosSouthLongSlitAcquisitionGraphQLField | ExposureTimeModeFields) GmosSouthLongSlitAcquisitionFields[source]¶
Subfields should come from the GmosSouthLongSlitAcquisitionFields class
- filter_: GmosSouthLongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitAcquisitionGraphQLField object>¶
The GMOS South filter that will be used in the acquisition sequence. This will be the explicitFilter if specified, but otherwise the defaultFilter.
- roi: GmosSouthLongSlitAcquisitionGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitAcquisitionGraphQLField object>¶
The ROI(s) that will be used for the acquisition sequence. In the case of a compound ROI such as CCD2_STAMP, the first will be used for the imaging step and the second for the remainder of the steps.
- class gpp_client.generated.custom_fields.GmosSouthLongSlitFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS South Long Slit mode
- classmethod acquisition() GmosSouthLongSlitAcquisitionFields[source]¶
Settings that apply to the acquisition sequence.
- alias(alias: str) GmosSouthLongSlitFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- amp_gain: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
GMOS amp read gain, either explicitly specified in explicitAmpGain or else taken from the defaultAmpGain.
- amp_read_mode: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
GMOS amp read mode, either explicitly specified in explicitAmpReadMode or else taken from the defaultAmpReadMode.
- classmethod central_wavelength() WavelengthFields[source]¶
The central wavelength, either explicitly specified in explicitCentralWavelength or else taken from the defaultCentralWavelength.
- default_amp_gain: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
Default GMOS amp gain (LOW).
- default_amp_read_mode: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
Default GmosAmpReadMode (SLOW).
- classmethod default_offsets() OffsetQFields[source]¶
Default offsets.
- default_roi: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
Default GMOS ROI (FULL_FRAME).
- classmethod default_spatial_offsets() OffsetQFields[source]¶
Default spatial offsets.
- classmethod default_wavelength_dithers() WavelengthDitherFields[source]¶
Default wavelength dithers, calculated based on the grating dispersion.
- default_x_bin: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
Default GMOS X-Binning, calculated from the effective slit size which in turn is based on the selected FPU, target source profile and image quality.
- default_y_bin: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
Default GMOS Y-Binning (TWO).
- explicit_amp_gain: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
Optional explicitly specified GMOS amp gain. If set it override the default.
- explicit_amp_read_mode: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
Optional explicitly specified GMOS amp read mode. If set it overrides the default.
- classmethod explicit_offsets() OffsetQFields[source]¶
Optional explicitly specified q offsets. If set it overrides the the default.
- explicit_roi: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
Optional explicitly specified GMOS ROI. If set it overrides the default.
- classmethod explicit_spatial_offsets() OffsetQFields[source]¶
Optional explicitly specified spatial q offsets. If set it overrides the the default.
- classmethod explicit_wavelength_dithers() WavelengthDitherFields[source]¶
Optional explicitly specified wavelength dithers. If set it overrides the default.
- explicit_x_bin: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
Optional explicitly specified GMOS X-Binning. If set it overrides the default.
- explicit_y_bin: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
Optional explicitly specified GMOS Y-Binning. If set it overrides the default.
- classmethod exposure_time_mode() ExposureTimeModeFields[source]¶
The exposure time mode used for ITC lookup for the science sequence.
- fields(*subfields: GmosSouthLongSlitGraphQLField | ExposureTimeModeFields | GmosSouthLongSlitAcquisitionFields | OffsetQFields | WavelengthDitherFields | WavelengthFields) GmosSouthLongSlitFields[source]¶
Subfields should come from the GmosSouthLongSlitFields class
- filter_: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
GMOS South Filter
- fpu: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
GMOS South FPU
- grating: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
GMOS South Grating
- classmethod initial_central_wavelength() WavelengthFields[source]¶
The central wavelength as initially selected. See the centralWavelength field for the wavelength that will be used in the observation.
- initial_filter: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
The filter as it was initially selected (if any). See the filter field for the filter that will be used in the observation.
- initial_fpu: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
The FPU as it was initially selected. See the fpu field for the FPU that will be used in the observation.
- initial_grating: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
The grating as it was initially selected. See the grating field for the grating that will be used in the observation.
- classmethod offsets() OffsetQFields[source]¶
Q offsets, either explicitly specified in explicitOffsets or else taken from defaultOffsets
- roi: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
GMOS ROI, either explicitly specified in explicitRoi or else taken from the defaultRoi.
- classmethod spatial_offsets() OffsetQFields[source]¶
Spacial q offsets, either explicitly specified in explicitSpatialOffsets or else taken from defaultSpatialOffsets
- classmethod wavelength_dithers() WavelengthDitherFields[source]¶
Wavelength dithers required to fill in the chip gaps. This value is either explicitly specified in explicitWavelengthDithers or else taken from defaultWavelengthDithers
- x_bin: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
GMOS X-Binning, either explicitly specified in explicitXBin or else taken from the defaultXBin.
- y_bin: GmosSouthLongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthLongSlitGraphQLField object>¶
GMOS Y-Binning, either explicitly specified in explicitYBin or else taken from the defaultYBin.
- class gpp_client.generated.custom_fields.GmosSouthStaticFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldUnchanging (over the course of the sequence) configuration values
- alias(alias: str) GmosSouthStaticFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- detector: GmosSouthStaticGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthStaticGraphQLField object>¶
Detector in use (always HAMAMATSU for recent and new observations)
- fields(*subfields: GmosSouthStaticGraphQLField | GmosNodAndShuffleFields) GmosSouthStaticFields[source]¶
Subfields should come from the GmosSouthStaticFields class
- mos_pre_imaging: GmosSouthStaticGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthStaticGraphQLField object>¶
Is MOS Pre-Imaging Observation
- classmethod nod_and_shuffle() GmosNodAndShuffleFields[source]¶
#Nod-and-shuffle configuration Nod-and-shuffle configuration. This is currently not used and will always return null.
- stage_mode: GmosSouthStaticGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthStaticGraphQLField object>¶
Stage mode
- class gpp_client.generated.custom_fields.GmosSouthStepFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGmosSouth step with potential breakpoint
- alias(alias: str) GmosSouthStepFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- breakpoint: GmosSouthStepGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthStepGraphQLField object>¶
Whether to pause before the execution of this step
- classmethod estimate() StepEstimateFields[source]¶
Time estimate for this step’s execution
- fields(*subfields: GmosSouthStepGraphQLField | GmosSouthDynamicFields | StepConfigInterface | StepEstimateFields | TelescopeConfigFields) GmosSouthStepFields[source]¶
Subfields should come from the GmosSouthStepFields class
- id: GmosSouthStepGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthStepGraphQLField object>¶
Step id
- classmethod instrument_config() GmosSouthDynamicFields[source]¶
Instrument configuration for this step
- observe_class: GmosSouthStepGraphQLField = <gpp_client.generated.custom_typing_fields.GmosSouthStepGraphQLField object>¶
Observe class for this step
- classmethod step_config() StepConfigInterface[source]¶
The sequence step itself
- classmethod telescope_config() TelescopeConfigFields[source]¶
The telescope configuration at this step.
- class gpp_client.generated.custom_fields.GoaPropertiesFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGemini Observatory Archive properties for a particular program.
- alias(alias: str) GoaPropertiesFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GoaPropertiesGraphQLField) GoaPropertiesFields[source]¶
Subfields should come from the GoaPropertiesFields class
- private_header: GoaPropertiesGraphQLField = <gpp_client.generated.custom_typing_fields.GoaPropertiesGraphQLField object>¶
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: GoaPropertiesGraphQLField = <gpp_client.generated.custom_typing_fields.GoaPropertiesGraphQLField object>¶
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: GoaPropertiesGraphQLField = <gpp_client.generated.custom_typing_fields.GoaPropertiesGraphQLField object>¶
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.custom_fields.GroupElementFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGroups contain observations and other groups. Exactly one will be defined.
- alias(alias: str) GroupElementFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- existence: GroupElementGraphQLField = <gpp_client.generated.custom_typing_fields.GroupElementGraphQLField object>¶
- fields(*subfields: GroupElementGraphQLField | GroupFields | ObservationFields) GroupElementFields[source]¶
Subfields should come from the GroupElementFields class
- classmethod group() GroupFields[source]¶
- classmethod observation() ObservationFields[source]¶
- parent_group_id: GroupElementGraphQLField = <gpp_client.generated.custom_typing_fields.GroupElementGraphQLField object>¶
- parent_index: GroupElementGraphQLField = <gpp_client.generated.custom_typing_fields.GroupElementGraphQLField object>¶
- class gpp_client.generated.custom_fields.GroupFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA group of observations and other groups.
- alias(alias: str) GroupFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- calibration_roles: GroupGraphQLField = <gpp_client.generated.custom_typing_fields.GroupGraphQLField object>¶
Calibration roles supported by this group (system groups only). This field is system-managed and not user-editable.
- description: GroupGraphQLField = <gpp_client.generated.custom_typing_fields.GroupGraphQLField object>¶
Optionally, a description.
- classmethod elements(include_deleted: bool) GroupElementFields[source]¶
Contained elements
- existence: GroupGraphQLField = <gpp_client.generated.custom_typing_fields.GroupGraphQLField object>¶
- fields(*subfields: GroupGraphQLField | CalculatedBandedTimeFields | CalculatedCategorizedTimeRangeFields | GroupElementFields | ProgramFields | TimeSpanFields) GroupFields[source]¶
Subfields should come from the GroupFields class
- id: GroupGraphQLField = <gpp_client.generated.custom_typing_fields.GroupGraphQLField object>¶
- classmethod maximum_interval() TimeSpanFields[source]¶
- classmethod minimum_interval() TimeSpanFields[source]¶
Is there a minimum required and/or maximum allowed timespan between observations?
- minimum_required: GroupGraphQLField = <gpp_client.generated.custom_typing_fields.GroupGraphQLField object>¶
How many do we need to complete? If this is null then it means we have to complete them all
- name: GroupGraphQLField = <gpp_client.generated.custom_typing_fields.GroupGraphQLField object>¶
Optionally, a name
- ordered: GroupGraphQLField = <gpp_client.generated.custom_typing_fields.GroupGraphQLField object>¶
Do they need to be completed in order?
- parent_id: GroupGraphQLField = <gpp_client.generated.custom_typing_fields.GroupGraphQLField object>¶
Id of this group’s parent, or null if this group is at the top level.
- parent_index: GroupGraphQLField = <gpp_client.generated.custom_typing_fields.GroupGraphQLField object>¶
Position of this group in its parent group (or at the top level).
- classmethod program() ProgramFields[source]¶
The program in which this group is found.
- same_night: GroupGraphQLField = <gpp_client.generated.custom_typing_fields.GroupGraphQLField object>¶
If true, all observations in this group must be scheduled on the same night. Mutually exclusive with maximumInterval. Only valid for AND groups.
- system: GroupGraphQLField = <gpp_client.generated.custom_typing_fields.GroupGraphQLField object>¶
This group is managed by the system and not user-editable
- classmethod time_estimate_banded() CalculatedBandedTimeFields[source]¶
Prepared time by band ignoring minimumRequired, for observations that can be calculated. In order for an observation to have an estimate, it must be fully defined such that a sequence can be generated for it. All defined observations in every band present in the group are included.
- classmethod time_estimate_range() CalculatedCategorizedTimeRangeFields[source]¶
Remaining execution time estimate range, assuming it can be calculated. In order for an observation to have an estimate, it must be fully defined such that a sequence can be generated for it. If a group has observations that are required and which are not fully defined, the remaining time estimate cannot be calculated.
- class gpp_client.generated.custom_fields.GuideAvailabilityPeriodFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA period of time showing which position angles have guide stars available during the period. The position angles are tested every 10 degrees.
- alias(alias: str) GuideAvailabilityPeriodFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- end: GuideAvailabilityPeriodGraphQLField = <gpp_client.generated.custom_typing_fields.GuideAvailabilityPeriodGraphQLField object>¶
Then end time of the availability period.
- fields(*subfields: GuideAvailabilityPeriodGraphQLField | AngleFields) GuideAvailabilityPeriodFields[source]¶
Subfields should come from the GuideAvailabilityPeriodFields class
- classmethod pos_angles() AngleFields[source]¶
The position angles available during this period.
- start: GuideAvailabilityPeriodGraphQLField = <gpp_client.generated.custom_typing_fields.GuideAvailabilityPeriodGraphQLField object>¶
The start time of the availability period.
- class gpp_client.generated.custom_fields.GuideEnvironmentFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe guide star(s) and related information
- alias(alias: str) GuideEnvironmentFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GuideEnvironmentGraphQLField | AngleFields | GuideTargetFields) GuideEnvironmentFields[source]¶
Subfields should come from the GuideEnvironmentFields class
- classmethod guide_targets() GuideTargetFields[source]¶
A list of GuideProbeTargets, which essentially provides a mapping from guide probes to targets.
- classmethod pos_angle() AngleFields[source]¶
The position angle
- class gpp_client.generated.custom_fields.GuideTargetFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldType that contains a guide probe and guide target information for use in the GuideEnvironment
- alias(alias: str) GuideTargetFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: GuideTargetGraphQLField | NonsiderealFields | SiderealFields | SourceProfileFields) GuideTargetFields[source]¶
Subfields should come from the GuideTargetFields class
- name: GuideTargetGraphQLField = <gpp_client.generated.custom_typing_fields.GuideTargetGraphQLField object>¶
Target name.
- classmethod nonsidereal() NonsiderealFields[source]¶
Nonsidereal tracking information, if this is a nonsidereal target
- probe: GuideTargetGraphQLField = <gpp_client.generated.custom_typing_fields.GuideTargetGraphQLField object>¶
The guide probe
- classmethod sidereal() SiderealFields[source]¶
Sidereal tracking information, if this is a sidereal target
- classmethod source_profile() SourceProfileFields[source]¶
source profile
- class gpp_client.generated.custom_fields.HasNonPartnerFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA PartnerLink employed when a user is explicitly associated with no Partner.
- alias(alias: str) HasNonPartnerFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: HasNonPartnerGraphQLField) HasNonPartnerFields[source]¶
Subfields should come from the HasNonPartnerFields class
- link_type: HasNonPartnerGraphQLField = <gpp_client.generated.custom_typing_fields.HasNonPartnerGraphQLField object>¶
Partner link discriminator.
- class gpp_client.generated.custom_fields.HasPartnerFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA PartnerLink employed when a user is associated with a specific Partner.
- alias(alias: str) HasPartnerFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: HasPartnerGraphQLField) HasPartnerFields[source]¶
Subfields should come from the HasPartnerFields class
- link_type: HasPartnerGraphQLField = <gpp_client.generated.custom_typing_fields.HasPartnerGraphQLField object>¶
Partner link discriminator.
- partner: HasPartnerGraphQLField = <gpp_client.generated.custom_typing_fields.HasPartnerGraphQLField object>¶
The associated partner.
- class gpp_client.generated.custom_fields.HasUnspecifiedPartnerFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA PartnerLink employed when a user’s PartnerLink has not (yet) been made.
- alias(alias: str) HasUnspecifiedPartnerFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: HasUnspecifiedPartnerGraphQLField) HasUnspecifiedPartnerFields[source]¶
Subfields should come from the HasUnspecifiedPartnerFields class
- link_type: HasUnspecifiedPartnerGraphQLField = <gpp_client.generated.custom_typing_fields.HasUnspecifiedPartnerGraphQLField object>¶
Partner link discriminator.
- class gpp_client.generated.custom_fields.HourAngleRangeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) HourAngleRangeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: HourAngleRangeGraphQLField) HourAngleRangeFields[source]¶
Subfields should come from the HourAngleRangeFields class
- max_hours: HourAngleRangeGraphQLField = <gpp_client.generated.custom_typing_fields.HourAngleRangeGraphQLField object>¶
Maximum Hour Angle (hours)
- min_hours: HourAngleRangeGraphQLField = <gpp_client.generated.custom_typing_fields.HourAngleRangeGraphQLField object>¶
Minimum Hour Angle (hours)
- class gpp_client.generated.custom_fields.Igrins2AtomFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldIGRINS-2 atom, a collection of steps that should be executed in their entirety
- alias(alias: str) Igrins2AtomFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- description: Igrins2AtomGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2AtomGraphQLField object>¶
Atom description, if any
- fields(*subfields: Igrins2AtomGraphQLField | Igrins2StepFields) Igrins2AtomFields[source]¶
Subfields should come from the Igrins2AtomFields class
- id: Igrins2AtomGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2AtomGraphQLField object>¶
Atom id
- observe_class: Igrins2AtomGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2AtomGraphQLField object>¶
Observe class for this atom
- classmethod steps() Igrins2StepFields[source]¶
Individual steps that comprise the atom
- class gpp_client.generated.custom_fields.Igrins2DynamicFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldIGRINS-2 dynamic step configuration
- alias(alias: str) Igrins2DynamicFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod exposure() TimeSpanFields[source]¶
IGRINS-2 exposure time
- fields(*subfields: Igrins2DynamicGraphQLField | TimeSpanFields) Igrins2DynamicFields[source]¶
Subfields should come from the Igrins2DynamicFields class
- class gpp_client.generated.custom_fields.Igrins2ExecutionConfigFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldIGRINS-2 Execution Config
- alias(alias: str) Igrins2ExecutionConfigFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: Igrins2ExecutionConfigGraphQLField | Igrins2ExecutionSequenceFields | Igrins2StaticFields) Igrins2ExecutionConfigFields[source]¶
Subfields should come from the Igrins2ExecutionConfigFields class
- classmethod science() Igrins2ExecutionSequenceFields[source]¶
IGRINS-2 science execution
- classmethod static() Igrins2StaticFields[source]¶
IGRINS-2 static configuration
- class gpp_client.generated.custom_fields.Igrins2ExecutionSequenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldNext atom to execute and potential future atoms.
- alias(alias: str) Igrins2ExecutionSequenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: Igrins2ExecutionSequenceGraphQLField | Igrins2AtomFields) Igrins2ExecutionSequenceFields[source]¶
Subfields should come from the Igrins2ExecutionSequenceFields class
- has_more: Igrins2ExecutionSequenceGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2ExecutionSequenceGraphQLField object>¶
Whether there are additional atoms beyond those listed in possibleFuture.
- classmethod next_atom() Igrins2AtomFields[source]¶
Next atom to execute.
- classmethod possible_future() Igrins2AtomFields[source]¶
(Prefix of the) remaining atoms to execute, if any.
- class gpp_client.generated.custom_fields.Igrins2LongSlitFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldIGRINS-2 Long Slit mode
- alias(alias: str) Igrins2LongSlitFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- default_offset_mode: Igrins2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2LongSlitGraphQLField object>¶
Default offset mode
- classmethod default_offsets() OffsetFields[source]¶
Default spatial offsets (ABBA pattern, q = -1.25, +1.25, +1.25, -1.25 arcsec) for NodAlongSlit, or (p = 0, q = 0), (p = 10, q = 10), (p = 0, q = 0) for NodToSky.
- default_save_svc_images: Igrins2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2LongSlitGraphQLField object>¶
Default save SVC images setting
- explicit_offset_mode: Igrins2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2LongSlitGraphQLField object>¶
Optional explicitly specified offset mode. If set it overrides the default.
- classmethod explicit_offsets() OffsetFields[source]¶
Optional explicitly specified spatial offsets. If set, overrides the default.
- explicit_save_svc_images: Igrins2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2LongSlitGraphQLField object>¶
Optional explicitly specified save SVC images setting. If set it overrides the default.
- classmethod exposure_time_mode() ExposureTimeModeFields[source]¶
The exposure time mode used for ITC lookup for the science sequence.
- fields(*subfields: Igrins2LongSlitGraphQLField | ExposureTimeModeFields | OffsetFields | TelluricTypeFields) Igrins2LongSlitFields[source]¶
Subfields should come from the Igrins2LongSlitFields class
- offset_mode: Igrins2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2LongSlitGraphQLField object>¶
The offset mode is either explicitly specified in explicitOffsetMode or else taken from defaultOffsetMode
- classmethod offsets() OffsetFields[source]¶
Spatial offsets, either explicitly specified in explicitOffsets or else taken from defaultOffsets
- save_svc_images: Igrins2LongSlitGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2LongSlitGraphQLField object>¶
Whether to save SVC images, either explicitly specified in explicitSaveSVCImages or else taken from defaultSaveSVCImages
- classmethod telluric_type() TelluricTypeFields[source]¶
Telluric type configuration for this observation.
- class gpp_client.generated.custom_fields.Igrins2StaticFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldIGRINS-2 static configuration
- alias(alias: str) Igrins2StaticFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: Igrins2StaticGraphQLField) Igrins2StaticFields[source]¶
Subfields should come from the Igrins2StaticFields class
- offset_mode: Igrins2StaticGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2StaticGraphQLField object>¶
Offset mode.
- save_svc_images: Igrins2StaticGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2StaticGraphQLField object>¶
Whether to save SVC images.
- class gpp_client.generated.custom_fields.Igrins2StepFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldIGRINS-2 step with potential breakpoint
- alias(alias: str) Igrins2StepFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- breakpoint: Igrins2StepGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2StepGraphQLField object>¶
Whether to pause before the execution of this step
- classmethod estimate() StepEstimateFields[source]¶
Time estimate for this step’s execution
- fields(*subfields: Igrins2StepGraphQLField | Igrins2DynamicFields | StepConfigInterface | StepEstimateFields | TelescopeConfigFields) Igrins2StepFields[source]¶
Subfields should come from the Igrins2StepFields class
- id: Igrins2StepGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2StepGraphQLField object>¶
Step id
- classmethod instrument_config() Igrins2DynamicFields[source]¶
Instrument configuration for this step
- observe_class: Igrins2StepGraphQLField = <gpp_client.generated.custom_typing_fields.Igrins2StepGraphQLField object>¶
Observe class for this step
- classmethod step_config() StepConfigInterface[source]¶
The sequence step itself
- classmethod telescope_config() TelescopeConfigFields[source]¶
The telescope configuration at this step.
- class gpp_client.generated.custom_fields.ImagingConfigOptionFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldDescribes an instrument configuration option for imaging.
- adaptive_optics: ImagingConfigOptionGraphQLField = <gpp_client.generated.custom_typing_fields.ImagingConfigOptionGraphQLField object>¶
- alias(alias: str) ImagingConfigOptionFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ImagingConfigOptionGraphQLField | AngleFields | ImagingConfigOptionGmosNorthFields | ImagingConfigOptionGmosSouthFields) ImagingConfigOptionFields[source]¶
Subfields should come from the ImagingConfigOptionFields class
- filter_label: ImagingConfigOptionGraphQLField = <gpp_client.generated.custom_typing_fields.ImagingConfigOptionGraphQLField object>¶
- classmethod fov() AngleFields[source]¶
- classmethod gmos_north() ImagingConfigOptionGmosNorthFields[source]¶
For GMOS North options, the GMOS North configuration. Null for other instruments.
- classmethod gmos_south() ImagingConfigOptionGmosSouthFields[source]¶
For GMOS South options, the GMOS South configuration. Null for other instruments.
- instrument: ImagingConfigOptionGraphQLField = <gpp_client.generated.custom_typing_fields.ImagingConfigOptionGraphQLField object>¶
- site: ImagingConfigOptionGraphQLField = <gpp_client.generated.custom_typing_fields.ImagingConfigOptionGraphQLField object>¶
- class gpp_client.generated.custom_fields.ImagingConfigOptionGmosNorthFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ImagingConfigOptionGmosNorthFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ImagingConfigOptionGmosNorthGraphQLField) ImagingConfigOptionGmosNorthFields[source]¶
Subfields should come from the ImagingConfigOptionGmosNorthFields class
- filter_: ImagingConfigOptionGmosNorthGraphQLField = <gpp_client.generated.custom_typing_fields.ImagingConfigOptionGmosNorthGraphQLField object>¶
- class gpp_client.generated.custom_fields.ImagingConfigOptionGmosSouthFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ImagingConfigOptionGmosSouthFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ImagingConfigOptionGmosSouthGraphQLField) ImagingConfigOptionGmosSouthFields[source]¶
Subfields should come from the ImagingConfigOptionGmosSouthFields class
- filter_: ImagingConfigOptionGmosSouthGraphQLField = <gpp_client.generated.custom_typing_fields.ImagingConfigOptionGmosSouthGraphQLField object>¶
- class gpp_client.generated.custom_fields.ImagingScienceRequirementsFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ImagingScienceRequirementsFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- broad_filters: ImagingScienceRequirementsGraphQLField = <gpp_client.generated.custom_typing_fields.ImagingScienceRequirementsGraphQLField object>¶
broadFilters, which may be unset by assigning a null value, or ignored by skipping it altogether.
- combined_filters: ImagingScienceRequirementsGraphQLField = <gpp_client.generated.custom_typing_fields.ImagingScienceRequirementsGraphQLField object>¶
combinedFilters, which may be unset by assigning a null value, or ignored by skipping it altogether.
- fields(*subfields: ImagingScienceRequirementsGraphQLField | AngleFields) ImagingScienceRequirementsFields[source]¶
Subfields should come from the ImagingScienceRequirementsFields class
- classmethod minimum_fov() AngleFields[source]¶
minimumFov, which may be unset by assigning a null value, or ignored by skipping it altogether.
- narrow_filters: ImagingScienceRequirementsGraphQLField = <gpp_client.generated.custom_typing_fields.ImagingScienceRequirementsGraphQLField object>¶
narrowFilters, which may be unset by assigning a null value, or ignored by skipping it altogether.
- class gpp_client.generated.custom_fields.ItcGhostIfuFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGHOST IFU ITC results. Each channel is paired with its result set.
- alias(alias: str) ItcGhostIfuFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod blue() ItcResultSetFields[source]¶
- fields(*subfields: ItcGhostIfuGraphQLField | ItcResultSetFields) ItcGhostIfuFields[source]¶
Subfields should come from the ItcGhostIfuFields class
- itc_type: ItcGhostIfuGraphQLField = <gpp_client.generated.custom_typing_fields.ItcGhostIfuGraphQLField object>¶
The type of the Itc results.
- classmethod red() ItcResultSetFields[source]¶
- class gpp_client.generated.custom_fields.ItcGmosNorthImagingFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS North imaging ITC results. Here each filter is paired with its result set.
- alias(alias: str) ItcGmosNorthImagingFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ItcGmosNorthImagingGraphQLField | ItcGmosNorthImagingResultSetFields) ItcGmosNorthImagingFields[source]¶
Subfields should come from the ItcGmosNorthImagingFields class
- classmethod gmos_north_imaging_science() ItcGmosNorthImagingResultSetFields[source]¶
- itc_type: ItcGmosNorthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.ItcGmosNorthImagingGraphQLField object>¶
The type of the Itc results.
- class gpp_client.generated.custom_fields.ItcGmosNorthImagingResultSetFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldCombines a GMOS North filter with an ItcResultSet. In other words, ITC results for all targets but a single filter.
- alias(alias: str) ItcGmosNorthImagingResultSetFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ItcGmosNorthImagingResultSetGraphQLField | ItcResultSetFields) ItcGmosNorthImagingResultSetFields[source]¶
Subfields should come from the ItcGmosNorthImagingResultSetFields class
- filter_: ItcGmosNorthImagingResultSetGraphQLField = <gpp_client.generated.custom_typing_fields.ItcGmosNorthImagingResultSetGraphQLField object>¶
- classmethod results() ItcResultSetFields[source]¶
- class gpp_client.generated.custom_fields.ItcGmosSouthImagingFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldGMOS South imaging ITC results. Here each filter is paired with its result set.
- alias(alias: str) ItcGmosSouthImagingFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ItcGmosSouthImagingGraphQLField | ItcGmosSouthImagingResultSetFields) ItcGmosSouthImagingFields[source]¶
Subfields should come from the ItcGmosSouthImagingFields class
- classmethod gmos_south_imaging_science() ItcGmosSouthImagingResultSetFields[source]¶
- itc_type: ItcGmosSouthImagingGraphQLField = <gpp_client.generated.custom_typing_fields.ItcGmosSouthImagingGraphQLField object>¶
The type of the Itc results.
- class gpp_client.generated.custom_fields.ItcGmosSouthImagingResultSetFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldCombines a GMOS South filter with an ItcResultSet. In other words, ITC results for all targets but a single filter.
- alias(alias: str) ItcGmosSouthImagingResultSetFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ItcGmosSouthImagingResultSetGraphQLField | ItcResultSetFields) ItcGmosSouthImagingResultSetFields[source]¶
Subfields should come from the ItcGmosSouthImagingResultSetFields class
- filter_: ItcGmosSouthImagingResultSetGraphQLField = <gpp_client.generated.custom_typing_fields.ItcGmosSouthImagingResultSetGraphQLField object>¶
- classmethod results() ItcResultSetFields[source]¶
- class gpp_client.generated.custom_fields.ItcIgrins2SpectroscopyFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldITC results for IGRINS-2 spectroscopy observations (no acquisition).
- alias(alias: str) ItcIgrins2SpectroscopyFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ItcIgrins2SpectroscopyGraphQLField | ItcResultSetFields) ItcIgrins2SpectroscopyFields[source]¶
Subfields should come from the ItcIgrins2SpectroscopyFields class
- itc_type: ItcIgrins2SpectroscopyGraphQLField = <gpp_client.generated.custom_typing_fields.ItcIgrins2SpectroscopyGraphQLField object>¶
The type of the Itc results.
- classmethod spectroscopy_science() ItcResultSetFields[source]¶
- class gpp_client.generated.custom_fields.ItcInterface(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldITC results for a particular observation, including relevant instrument configurations and targets. There are specific instances for each ItcType.
- alias(alias: str) ItcInterface[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ItcGraphQLField) ItcInterface[source]¶
Subfields should come from the ItcInterface class
- itc_type: ItcGraphQLField = <gpp_client.generated.custom_typing_fields.ItcGraphQLField object>¶
The type of the Itc results.
- on(type_name: str, *subfields: GraphQLField) ItcInterface[source]¶
- class gpp_client.generated.custom_fields.ItcResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldAn ITC result for a single target.
- alias(alias: str) ItcResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- exposure_count: ItcResultGraphQLField = <gpp_client.generated.custom_typing_fields.ItcResultGraphQLField object>¶
- classmethod exposure_time() TimeSpanFields[source]¶
- fields(*subfields: ItcResultGraphQLField | SignalToNoiseAtFields | TimeSpanFields) ItcResultFields[source]¶
Subfields should come from the ItcResultFields class
- classmethod signal_to_noise_at() SignalToNoiseAtFields[source]¶
- target_id: ItcResultGraphQLField = <gpp_client.generated.custom_typing_fields.ItcResultGraphQLField object>¶
- class gpp_client.generated.custom_fields.ItcResultSetFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldContains the result of calling the ITC for all targets, but a single instrument configuration. Since the observation may contain multiple targets, there may be multiple results. The “result” field contains the selected, representative, result for all targets. If there are multiple successful results, this will be the one that prescribes the longest observation. If there is a mix of failures and successes, the overall “result” will be a failure. The “all” field contains results for all targets regardless.
- alias(alias: str) ItcResultSetFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod all() ItcResultFields[source]¶
- fields(*subfields: ItcResultSetGraphQLField | ItcResultFields) ItcResultSetFields[source]¶
Subfields should come from the ItcResultSetFields class
- index: ItcResultSetGraphQLField = <gpp_client.generated.custom_typing_fields.ItcResultSetGraphQLField object>¶
- classmethod selected() ItcResultFields[source]¶
- class gpp_client.generated.custom_fields.ItcSpectroscopyFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldITC results for spectroscopy observations.
- classmethod acquisition() ItcResultSetFields[source]¶
- alias(alias: str) ItcSpectroscopyFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ItcSpectroscopyGraphQLField | ItcResultSetFields) ItcSpectroscopyFields[source]¶
Subfields should come from the ItcSpectroscopyFields class
- itc_type: ItcSpectroscopyGraphQLField = <gpp_client.generated.custom_typing_fields.ItcSpectroscopyGraphQLField object>¶
The type of the Itc results.
- classmethod spectroscopy_science() ItcResultSetFields[source]¶
- class gpp_client.generated.custom_fields.LargeProgramFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldProposal properties for Large Program CallForProposals.
- aeon_multi_facility: LargeProgramGraphQLField = <gpp_client.generated.custom_typing_fields.LargeProgramGraphQLField object>¶
Whether this proposal is part of the AEON/Multi-facility program.
- alias(alias: str) LargeProgramFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: LargeProgramGraphQLField | TimeSpanFields) LargeProgramFields[source]¶
Subfields should come from the LargeProgramFields class
- jwst_synergy: LargeProgramGraphQLField = <gpp_client.generated.custom_typing_fields.LargeProgramGraphQLField object>¶
Whether this proposal has JWST synergy.
- min_percent_time: LargeProgramGraphQLField = <gpp_client.generated.custom_typing_fields.LargeProgramGraphQLField object>¶
Minimum percentage of observing time (first semester) required to consider this proposal successful.
- min_percent_total_time: LargeProgramGraphQLField = <gpp_client.generated.custom_typing_fields.LargeProgramGraphQLField object>¶
Minimum percentage of the total observing time (over all semesters) required to consider this proposal successful.
- science_subtype: LargeProgramGraphQLField = <gpp_client.generated.custom_typing_fields.LargeProgramGraphQLField object>¶
The science type of this Call for Proposals.
- to_o_activation: LargeProgramGraphQLField = <gpp_client.generated.custom_typing_fields.LargeProgramGraphQLField object>¶
Whether (and how) the observations in this proposal are available for Target of Opportunity triggering.
- classmethod total_time() TimeSpanFields[source]¶
Total time requested (over multiple all semesters) for this proposal.
- class gpp_client.generated.custom_fields.LibraryProgramReferenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) LibraryProgramReferenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- description: LibraryProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.LibraryProgramReferenceGraphQLField object>¶
- fields(*subfields: LibraryProgramReferenceGraphQLField) LibraryProgramReferenceFields[source]¶
Subfields should come from the LibraryProgramReferenceFields class
- instrument: LibraryProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.LibraryProgramReferenceGraphQLField object>¶
- label: LibraryProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.LibraryProgramReferenceGraphQLField object>¶
- type_: LibraryProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.LibraryProgramReferenceGraphQLField object>¶
- class gpp_client.generated.custom_fields.LineFluxIntegratedFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) LineFluxIntegratedFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: LineFluxIntegratedGraphQLField) LineFluxIntegratedFields[source]¶
Subfields should come from the LineFluxIntegratedFields class
- units: LineFluxIntegratedGraphQLField = <gpp_client.generated.custom_typing_fields.LineFluxIntegratedGraphQLField object>¶
- value: LineFluxIntegratedGraphQLField = <gpp_client.generated.custom_typing_fields.LineFluxIntegratedGraphQLField object>¶
- class gpp_client.generated.custom_fields.LineFluxSurfaceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) LineFluxSurfaceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: LineFluxSurfaceGraphQLField) LineFluxSurfaceFields[source]¶
Subfields should come from the LineFluxSurfaceFields class
- units: LineFluxSurfaceGraphQLField = <gpp_client.generated.custom_typing_fields.LineFluxSurfaceGraphQLField object>¶
- value: LineFluxSurfaceGraphQLField = <gpp_client.generated.custom_typing_fields.LineFluxSurfaceGraphQLField object>¶
- class gpp_client.generated.custom_fields.LinkUserResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) LinkUserResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: LinkUserResultGraphQLField | ProgramUserFields) LinkUserResultFields[source]¶
Subfields should come from the LinkUserResultFields class
- classmethod user() ProgramUserFields[source]¶
- class gpp_client.generated.custom_fields.MonitoringProgramReferenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) MonitoringProgramReferenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: MonitoringProgramReferenceGraphQLField) MonitoringProgramReferenceFields[source]¶
Subfields should come from the MonitoringProgramReferenceFields class
- instrument: MonitoringProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.MonitoringProgramReferenceGraphQLField object>¶
- label: MonitoringProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.MonitoringProgramReferenceGraphQLField object>¶
- semester: MonitoringProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.MonitoringProgramReferenceGraphQLField object>¶
- semester_index: MonitoringProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.MonitoringProgramReferenceGraphQLField object>¶
- type_: MonitoringProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.MonitoringProgramReferenceGraphQLField object>¶
- class gpp_client.generated.custom_fields.NonsiderealFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) NonsiderealFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- des: NonsiderealGraphQLField = <gpp_client.generated.custom_typing_fields.NonsiderealGraphQLField object>¶
Human readable designation that discriminates among ephemeris keys of the same type.
- fields(*subfields: NonsiderealGraphQLField) NonsiderealFields[source]¶
Subfields should come from the NonsiderealFields class
- key: NonsiderealGraphQLField = <gpp_client.generated.custom_typing_fields.NonsiderealGraphQLField object>¶
Synthesis of keyType and des
- key_type: NonsiderealGraphQLField = <gpp_client.generated.custom_typing_fields.NonsiderealGraphQLField object>¶
Nonsidereal target lookup type.
- class gpp_client.generated.custom_fields.ObservationFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ObservationFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- calibration_role: ObservationGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationGraphQLField object>¶
The Calibration role of this observation
- classmethod configuration() ConfigurationFields[source]¶
Parameters relevant to approved configurations.
- classmethod configuration_requests() ConfigurationRequestFields[source]¶
Program configuration requests applicable to this observation.
- classmethod constraint_set() ConstraintSetFields[source]¶
The constraint set for the observation
- classmethod execution() ExecutionFields[source]¶
Execution sequence and runtime artifacts
- existence: ObservationGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationGraphQLField object>¶
DELETED or PRESENT
- fields(*subfields: ObservationGraphQLField | AttachmentFields | CalculatedObservationWorkflowFields | ConfigurationFields | ConfigurationRequestFields | ConstraintSetFields | ExecutionFields | ItcInterface | ObservationReferenceFields | ObservingModeFields | PosAngleConstraintFields | ProgramFields | ScienceRequirementsFields | TargetEnvironmentFields | TimeSpanFields | TimingWindowFields) ObservationFields[source]¶
Subfields should come from the ObservationFields class
- group_id: ObservationGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationGraphQLField object>¶
Enclosing group, if any.
- group_index: ObservationGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationGraphQLField object>¶
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.
- id: ObservationGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationGraphQLField object>¶
Observation ID
- index: ObservationGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationGraphQLField object>¶
Observation index, relative to other observations in the same program.
- instrument: ObservationGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationGraphQLField object>¶
The instrument in use for this observation, if the observing mode is set.
- classmethod itc() ItcInterface[source]¶
The ITC result for this observation, assuming it has associated target(s) and a selected observing mode.
- classmethod observation_duration() TimeSpanFields[source]¶
Used in conjunction with observationTime for time-dependentent calulations. If not set, the remaining observation execution time will be used.
- observation_time: ObservationGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationGraphQLField object>¶
Reference time used for execution and visualization and time-dependent calculations (e.g., average parallactic angle and guide star selection)
- observer_notes: ObservationGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationGraphQLField object>¶
Notes for the observer
- classmethod observing_mode() ObservingModeFields[source]¶
The science configuration
- classmethod pos_angle_constraint() PosAngleConstraintFields[source]¶
Position angle constraint, if any.
- classmethod program() ProgramFields[source]¶
The program that contains this observation
- classmethod reference() ObservationReferenceFields[source]¶
Observation reference, if any (requires the existence of a reference for the program itself).
- science_band: ObservationGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationGraphQLField object>¶
Observations are associated with a science band once time has been allocated to a program.
- classmethod science_requirements() ScienceRequirementsFields[source]¶
The top level science requirements
- subtitle: ObservationGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationGraphQLField object>¶
User-supplied observation-identifying detail information
- classmethod target_environment() TargetEnvironmentFields[source]¶
The observation’s target(s)
- classmethod timing_windows() TimingWindowFields[source]¶
Observation timing windows
- title: ObservationGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationGraphQLField object>¶
Observation title generated from id and targets
- classmethod workflow() CalculatedObservationWorkflowFields[source]¶
Obtains the current observation workflow state and valid transitions (and any validation errors). Because this calculation is expensive, it is performed in the background when something relevant changes and may be in a state of flux when queried. The calculation state in the result can be used to determine whether a pending update is expected.
- class gpp_client.generated.custom_fields.ObservationReferenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldObservation reference type, broken into its constituient parts and including a formatted label.
- alias(alias: str) ObservationReferenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ObservationReferenceGraphQLField | ProgramReferenceInterface) ObservationReferenceFields[source]¶
Subfields should come from the ObservationReferenceFields class
- index: ObservationReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationReferenceGraphQLField object>¶
The observation index relative to its program.
- label: ObservationReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationReferenceGraphQLField object>¶
Formatted observation reference label.
- classmethod program() ProgramReferenceInterface[source]¶
The program reference.
- class gpp_client.generated.custom_fields.ObservationSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe matching observation results, limited to a maximum of 1000 entries.
- alias(alias: str) ObservationSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ObservationSelectResultGraphQLField | ObservationFields) ObservationSelectResultFields[source]¶
Subfields should come from the ObservationSelectResultFields class
- has_more: ObservationSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() ObservationFields[source]¶
Matching observations up to the return size limit of 1000
- class gpp_client.generated.custom_fields.ObservationValidationFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldAn observation validation problem
- alias(alias: str) ObservationValidationFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- code: ObservationValidationGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationValidationGraphQLField object>¶
The type of validation problem
- fields(*subfields: ObservationValidationGraphQLField) ObservationValidationFields[source]¶
Subfields should come from the ObservationValidationFields class
- messages: ObservationValidationGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationValidationGraphQLField object>¶
Particular errors for this validation type
- class gpp_client.generated.custom_fields.ObservationWorkflowFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ObservationWorkflowFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ObservationWorkflowGraphQLField | ObservationValidationFields) ObservationWorkflowFields[source]¶
Subfields should come from the ObservationWorkflowFields class
- state: ObservationWorkflowGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationWorkflowGraphQLField object>¶
- valid_transitions: ObservationWorkflowGraphQLField = <gpp_client.generated.custom_typing_fields.ObservationWorkflowGraphQLField object>¶
- classmethod validation_errors() ObservationValidationFields[source]¶
- class gpp_client.generated.custom_fields.ObservingModeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldBase science mode
- alias(alias: str) ObservingModeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ObservingModeGraphQLField | Flamingos2LongSlitFields | GhostIfuFields | GmosNorthImagingFields | GmosNorthLongSlitFields | GmosSouthImagingFields | GmosSouthLongSlitFields | Igrins2LongSlitFields | VisitorFields) ObservingModeFields[source]¶
Subfields should come from the ObservingModeFields class
- classmethod flamingos_2_long_slit() Flamingos2LongSlitFields[source]¶
Flamingos 2 Long Slit mode
- classmethod ghost_ifu() GhostIfuFields[source]¶
GHOST IFU mode
- classmethod gmos_north_imaging() GmosNorthImagingFields[source]¶
GMOS North Imaging mode
- classmethod gmos_north_long_slit() GmosNorthLongSlitFields[source]¶
GMOS North Long Slit mode
- classmethod gmos_south_imaging() GmosSouthImagingFields[source]¶
GMOS South Imaging mode
- classmethod gmos_south_long_slit() GmosSouthLongSlitFields[source]¶
GMOS South Long Slit mode
- classmethod igrins_2_long_slit() Igrins2LongSlitFields[source]¶
IGRINS-2 Long Slit mode
- instrument: ObservingModeGraphQLField = <gpp_client.generated.custom_typing_fields.ObservingModeGraphQLField object>¶
Instrument
- mode: ObservingModeGraphQLField = <gpp_client.generated.custom_typing_fields.ObservingModeGraphQLField object>¶
Mode type
- classmethod visitor() VisitorFields[source]¶
- class gpp_client.generated.custom_fields.ObservingModeGroupFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ObservingModeGroupFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ObservingModeGroupGraphQLField | ObservationSelectResultFields | ObservingModeFields | ProgramFields) ObservingModeGroupFields[source]¶
Subfields should come from the ObservingModeGroupFields class
- classmethod observations(include_deleted: bool, *, offset: Any | None = None, limit: Any | None = None) ObservationSelectResultFields[source]¶
Observations associated with the common value
- classmethod observing_mode() ObservingModeFields[source]¶
Commonly held value across the observations
- classmethod program() ProgramFields[source]¶
Link back to program.
- class gpp_client.generated.custom_fields.ObservingModeGroupSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe matching ObservingModeGroup results, limited to a maximum of 1000 entries.
- alias(alias: str) ObservingModeGroupSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ObservingModeGroupSelectResultGraphQLField | ObservingModeGroupFields) ObservingModeGroupSelectResultFields[source]¶
Subfields should come from the ObservingModeGroupSelectResultFields class
- has_more: ObservingModeGroupSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.ObservingModeGroupSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() ObservingModeGroupFields[source]¶
Matching ObservingModeGroups up to the return size limit of 1000
- class gpp_client.generated.custom_fields.OffsetFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) OffsetFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: OffsetGraphQLField | OffsetPFields | OffsetQFields) OffsetFields[source]¶
Subfields should come from the OffsetFields class
- classmethod p() OffsetPFields[source]¶
Offset in p
- classmethod q() OffsetQFields[source]¶
Offset in q
- class gpp_client.generated.custom_fields.OffsetPFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) OffsetPFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- arcseconds: OffsetPGraphQLField = <gpp_client.generated.custom_typing_fields.OffsetPGraphQLField object>¶
p offset in arcsec
- fields(*subfields: OffsetPGraphQLField) OffsetPFields[source]¶
Subfields should come from the OffsetPFields class
- microarcseconds: OffsetPGraphQLField = <gpp_client.generated.custom_typing_fields.OffsetPGraphQLField object>¶
p offset in µas
- milliarcseconds: OffsetPGraphQLField = <gpp_client.generated.custom_typing_fields.OffsetPGraphQLField object>¶
p offset in mas
- class gpp_client.generated.custom_fields.OffsetQFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) OffsetQFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- arcseconds: OffsetQGraphQLField = <gpp_client.generated.custom_typing_fields.OffsetQGraphQLField object>¶
q offset in arcsec
- fields(*subfields: OffsetQGraphQLField) OffsetQFields[source]¶
Subfields should come from the OffsetQFields class
- microarcseconds: OffsetQGraphQLField = <gpp_client.generated.custom_typing_fields.OffsetQGraphQLField object>¶
q offset in µas
- milliarcseconds: OffsetQGraphQLField = <gpp_client.generated.custom_typing_fields.OffsetQGraphQLField object>¶
q offset in mas
- class gpp_client.generated.custom_fields.OpportunityFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) OpportunityFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: OpportunityGraphQLField | RegionFields) OpportunityFields[source]¶
Subfields should come from the OpportunityFields class
- classmethod region() RegionFields[source]¶
- class gpp_client.generated.custom_fields.ParallaxFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ParallaxFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ParallaxGraphQLField) ParallaxFields[source]¶
Subfields should come from the ParallaxFields class
- microarcseconds: ParallaxGraphQLField = <gpp_client.generated.custom_typing_fields.ParallaxGraphQLField object>¶
Parallax in microarcseconds
- milliarcseconds: ParallaxGraphQLField = <gpp_client.generated.custom_typing_fields.ParallaxGraphQLField object>¶
Parallax in milliarcseconds
- class gpp_client.generated.custom_fields.PartnerLinkInterface(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldRepresents the association of a user with a Partner, if any.
- alias(alias: str) PartnerLinkInterface[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: PartnerLinkGraphQLField) PartnerLinkInterface[source]¶
Subfields should come from the PartnerLinkInterface class
- link_type: PartnerLinkGraphQLField = <gpp_client.generated.custom_typing_fields.PartnerLinkGraphQLField object>¶
Partner link discriminator.
- on(type_name: str, *subfields: GraphQLField) PartnerLinkInterface[source]¶
- class gpp_client.generated.custom_fields.PartnerSplitFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldPartner splits detail how requested time for a Queue or Classical proposal should be distributed amongst Gemini partners.
- alias(alias: str) PartnerSplitFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: PartnerSplitGraphQLField) PartnerSplitFields[source]¶
Subfields should come from the PartnerSplitFields class
- partner: PartnerSplitGraphQLField = <gpp_client.generated.custom_typing_fields.PartnerSplitGraphQLField object>¶
- percent: PartnerSplitGraphQLField = <gpp_client.generated.custom_typing_fields.PartnerSplitGraphQLField object>¶
Percentage of requested time that should be associated with the partner.
- class gpp_client.generated.custom_fields.PoorWeatherFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldProposal properties for Regular Semester (Poor Weather) CallForProposals.
- alias(alias: str) PoorWeatherFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: PoorWeatherGraphQLField) PoorWeatherFields[source]¶
Subfields should come from the PoorWeatherFields class
- science_subtype: PoorWeatherGraphQLField = <gpp_client.generated.custom_typing_fields.PoorWeatherGraphQLField object>¶
The science type of this Call for Proposals.
- class gpp_client.generated.custom_fields.PosAngleConstraintFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldConstraints (if any) on the observation’s position angle.
- alias(alias: str) PosAngleConstraintFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod angle() AngleFields[source]¶
The fixed position angle. This will be kept but ignored for UNBOUNDED and AVERAGE_PARALLACTIC modes.
- fields(*subfields: PosAngleConstraintGraphQLField | AngleFields) PosAngleConstraintFields[source]¶
Subfields should come from the PosAngleConstraintFields class
- mode: PosAngleConstraintGraphQLField = <gpp_client.generated.custom_typing_fields.PosAngleConstraintGraphQLField object>¶
The position angle constraint mode in use. The value will determine whether the angle is respected or ignored.
- class gpp_client.generated.custom_fields.ProgramFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- classmethod active() DateIntervalFields[source]¶
Active period for this program. Observations must be completed during this time interval. By default, if there is an associated proposal tied to a particular Call for Proposals (CfP), the active period will correspond to the Cfp active period.
- alias(alias: str) ProgramFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod all_group_elements(include_deleted: bool) GroupElementFields[source]¶
All group elements (observations and sub-groups) in the program.
- classmethod allocations() AllocationFields[source]¶
All partner time allocations.
- classmethod attachments() AttachmentFields[source]¶
Attachments assocated with the program
- calibration_role: ProgramGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramGraphQLField object>¶
Calibration role of the program
- classmethod configuration_requests(*, offset: Any | None = None, limit: Any | None = None) ConfigurationRequestSelectResultFields[source]¶
All configuration requests associated with the program.
- description: ProgramGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramGraphQLField object>¶
Program description / abstract.
- existence: ProgramGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramGraphQLField object>¶
DELETED or PRESENT
- fields(*subfields: ProgramGraphQLField | AllocationFields | AttachmentFields | BandedTimeFields | CalculatedBandedTimeFields | CalculatedCategorizedTimeRangeFields | ConfigurationRequestSelectResultFields | DateIntervalFields | GoaPropertiesFields | GroupElementFields | ObservationSelectResultFields | ProgramNoteFields | ProgramReferenceInterface | ProgramUserFields | ProposalFields | UserInvitationFields) ProgramFields[source]¶
Subfields should come from the ProgramFields class
- classmethod goa() GoaPropertiesFields[source]¶
Observatory archive properties related to this program.
- classmethod group_elements(include_deleted: bool) GroupElementFields[source]¶
Top-level group elements (observations and sub-groups) in the program.
- id: ProgramGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramGraphQLField object>¶
Program ID
- name: ProgramGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramGraphQLField object>¶
Program name / title.
- classmethod notes(include_deleted: bool) ProgramNoteFields[source]¶
Notes associated with the program, if any.
- classmethod observations(include_deleted: bool, *, offset: Any | None = None, limit: Any | None = None) ObservationSelectResultFields[source]¶
All observations associated with the program.
- classmethod pi() ProgramUserFields[source]¶
Principal Investigator
- classmethod proposal() ProposalFields[source]¶
Program proposal
- proposal_status: ProgramGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramGraphQLField object>¶
Proposal status of the program
- classmethod reference() ProgramReferenceInterface[source]¶
Program reference, if any.
- classmethod time_charge() BandedTimeFields[source]¶
Program-wide time charge, summing all corrected observation time charges.
- classmethod time_estimate_banded() CalculatedBandedTimeFields[source]¶
Prepared time by band ignoring minimumRequired in groups, for observations that can be calculated. In order for an observation to have an estimate, it must be fully defined such that a sequence can be generated for it. All defined observations in every band present in the program are included.
- classmethod time_estimate_range() CalculatedCategorizedTimeRangeFields[source]¶
Remaining execution time estimate range, assuming it can be calculated. In order for an observation to have an estimate, it must be fully defined such that a sequence can be generated for it. If a program has observations that are required and which are not fully defined, the remaining time estimate cannot be calculated.
- type_: ProgramGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramGraphQLField object>¶
Program type
- classmethod user_invitations() UserInvitationFields[source]¶
All user invitations associated with this program.
- classmethod users() ProgramUserFields[source]¶
Users assigned to this science program
- class gpp_client.generated.custom_fields.ProgramNoteFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldProgram notes are arbitrary titled text messages associated with a particular program. Notes may be private, in which case they are only visible to staff.
- alias(alias: str) ProgramNoteFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- existence: ProgramNoteGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramNoteGraphQLField object>¶
DELETED or PRESENT
- fields(*subfields: ProgramNoteGraphQLField | ProgramFields) ProgramNoteFields[source]¶
Subfields should come from the ProgramNoteFields class
- id: ProgramNoteGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramNoteGraphQLField object>¶
This note’s unique id.
- is_private: ProgramNoteGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramNoteGraphQLField object>¶
Whether the note is only available to Gemini staff.
- classmethod program() ProgramFields[source]¶
The program with which this note is associated.
- text: ProgramNoteGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramNoteGraphQLField object>¶
The note text, if any.
- title: ProgramNoteGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramNoteGraphQLField object>¶
The note title.
- class gpp_client.generated.custom_fields.ProgramNoteSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ProgramNoteSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ProgramNoteSelectResultGraphQLField | ProgramNoteFields) ProgramNoteSelectResultFields[source]¶
Subfields should come from the ProgramNoteSelectResultFields class
- has_more: ProgramNoteSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramNoteSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() ProgramNoteFields[source]¶
Matching notes up to the return size limit of 1000.
- class gpp_client.generated.custom_fields.ProgramReferenceInterface(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldDefines the category of program references, where specific implementations exist for calibration, engineering, etc.
- alias(alias: str) ProgramReferenceInterface[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ProgramReferenceGraphQLField) ProgramReferenceInterface[source]¶
Subfields should come from the ProgramReferenceInterface class
- label: ProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramReferenceGraphQLField object>¶
- on(type_name: str, *subfields: GraphQLField) ProgramReferenceInterface[source]¶
- type_: ProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramReferenceGraphQLField object>¶
- class gpp_client.generated.custom_fields.ProgramSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe matching program results, limited to a maximum of 1000 entries.
- alias(alias: str) ProgramSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ProgramSelectResultGraphQLField | ProgramFields) ProgramSelectResultFields[source]¶
Subfields should come from the ProgramSelectResultFields class
- has_more: ProgramSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() ProgramFields[source]¶
Matching programs up to the return size limit of 1000
- class gpp_client.generated.custom_fields.ProgramUserFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldAn assignment of a user to a program.
- affiliation: ProgramUserGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramUserGraphQLField object>¶
Investigator affiliation.
- alias(alias: str) ProgramUserFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- display_name: ProgramUserGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramUserGraphQLField object>¶
Name created preferentially from the fields of the preferred profile, falling back to the Orcid profile if the preferred fields are not set.
- educational_status: ProgramUserGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramUserGraphQLField object>¶
User educational status. PHD/Undergrad/Grad/Other.
- email: ProgramUserGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramUserGraphQLField object>¶
The user’s email address from the preferred profile, falling back to the Orcid profile if the preferred email is not set.
- fields(*subfields: ProgramUserGraphQLField | PartnerLinkInterface | ProgramFields | UserFields | UserInvitationFields | UserProfileFields) ProgramUserFields[source]¶
Subfields should come from the ProgramUserFields class
- gender: ProgramUserGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramUserGraphQLField object>¶
Users’ reported gender.
- has_data_access: ProgramUserGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramUserGraphQLField object>¶
Has access to data.
- id: ProgramUserGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramUserGraphQLField object>¶
- classmethod invitations() UserInvitationFields[source]¶
User invitations, if any, associated with this program user.
- classmethod partner_link() PartnerLinkInterface[source]¶
How the partner is associated with a partner.
- classmethod preferred_profile() UserProfileFields[source]¶
The preferred profile overrides any values that may be in the Orcid profile (user.profile).
- classmethod program() ProgramFields[source]¶
- role: ProgramUserGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramUserGraphQLField object>¶
- thesis: ProgramUserGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramUserGraphQLField object>¶
Flag indicating whether the user’s proposal is part of a thesis.
- classmethod user() UserFields[source]¶
- class gpp_client.generated.custom_fields.ProgramUserSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe matching program user results, limited to a maximum of 1000 entries.
- alias(alias: str) ProgramUserSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ProgramUserSelectResultGraphQLField | ProgramUserFields) ProgramUserSelectResultFields[source]¶
Subfields should come from the ProgramUserSelectResultFields class
- has_more: ProgramUserSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.ProgramUserSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() ProgramUserFields[source]¶
Matching program users up to the return size limit of 1000
- class gpp_client.generated.custom_fields.ProperMotionDeclinationFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ProperMotionDeclinationFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ProperMotionDeclinationGraphQLField) ProperMotionDeclinationFields[source]¶
Subfields should come from the ProperMotionDeclinationFields class
- microarcseconds_per_year: ProperMotionDeclinationGraphQLField = <gpp_client.generated.custom_typing_fields.ProperMotionDeclinationGraphQLField object>¶
Proper motion in properMotion μas/year
- milliarcseconds_per_year: ProperMotionDeclinationGraphQLField = <gpp_client.generated.custom_typing_fields.ProperMotionDeclinationGraphQLField object>¶
Proper motion in properMotion mas/year
- class gpp_client.generated.custom_fields.ProperMotionFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ProperMotionFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod dec() ProperMotionDeclinationFields[source]¶
Proper motion in declination
- fields(*subfields: ProperMotionGraphQLField | ProperMotionDeclinationFields | ProperMotionRAFields) ProperMotionFields[source]¶
Subfields should come from the ProperMotionFields class
- classmethod ra() ProperMotionRAFields[source]¶
Proper motion in RA
- class gpp_client.generated.custom_fields.ProperMotionRAFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ProperMotionRAFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ProperMotionRAGraphQLField) ProperMotionRAFields[source]¶
Subfields should come from the ProperMotionRAFields class
- microarcseconds_per_year: ProperMotionRAGraphQLField = <gpp_client.generated.custom_typing_fields.ProperMotionRAGraphQLField object>¶
Proper motion in properMotion μas/year
- milliarcseconds_per_year: ProperMotionRAGraphQLField = <gpp_client.generated.custom_typing_fields.ProperMotionRAGraphQLField object>¶
Proper motion in properMotion mas/year
- class gpp_client.generated.custom_fields.ProposalFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ProposalFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod call() CallForProposalsFields[source]¶
The corresponding CallForProposals definition itself, if the call id has been set.
- category: ProposalGraphQLField = <gpp_client.generated.custom_typing_fields.ProposalGraphQLField object>¶
Proposal TAC category
- fields(*subfields: ProposalGraphQLField | CallForProposalsFields | ProposalReferenceFields | ProposalTypeInterface) ProposalFields[source]¶
Subfields should come from the ProposalFields class
- classmethod reference() ProposalReferenceFields[source]¶
The proposal reference, assuming the proposal has been submitted and assigned a semester.
- classmethod type_() ProposalTypeInterface[source]¶
Properties of this proposal that are dependent upon the Call for Proposals type.
- class gpp_client.generated.custom_fields.ProposalReferenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ProposalReferenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ProposalReferenceGraphQLField) ProposalReferenceFields[source]¶
Subfields should come from the ProposalReferenceFields class
- label: ProposalReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ProposalReferenceGraphQLField object>¶
- semester: ProposalReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ProposalReferenceGraphQLField object>¶
- semester_index: ProposalReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ProposalReferenceGraphQLField object>¶
- class gpp_client.generated.custom_fields.ProposalStatusMetaFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldMetadata for enum ProposalStatus
- alias(alias: str) ProposalStatusMetaFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ProposalStatusMetaGraphQLField) ProposalStatusMetaFields[source]¶
Subfields should come from the ProposalStatusMetaFields class
- name: ProposalStatusMetaGraphQLField = <gpp_client.generated.custom_typing_fields.ProposalStatusMetaGraphQLField object>¶
- tag: ProposalStatusMetaGraphQLField = <gpp_client.generated.custom_typing_fields.ProposalStatusMetaGraphQLField object>¶
- class gpp_client.generated.custom_fields.ProposalTypeInterface(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldProposal properties that depend on the particular call for proposals associated with this proposal.
- alias(alias: str) ProposalTypeInterface[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ProposalTypeGraphQLField) ProposalTypeInterface[source]¶
Subfields should come from the ProposalTypeInterface class
- on(type_name: str, *subfields: GraphQLField) ProposalTypeInterface[source]¶
- science_subtype: ProposalTypeGraphQLField = <gpp_client.generated.custom_typing_fields.ProposalTypeGraphQLField object>¶
The science type of this Call for Proposals.
- class gpp_client.generated.custom_fields.QueueFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldProposal properties for Regular Semester (Queue) CallForProposals.
- aeon_multi_facility: QueueGraphQLField = <gpp_client.generated.custom_typing_fields.QueueGraphQLField object>¶
Whether this proposal is part of the AEON/Multi-facility program.
- alias(alias: str) QueueFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- consider_for_band_3: QueueGraphQLField = <gpp_client.generated.custom_typing_fields.QueueGraphQLField object>¶
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.
- fields(*subfields: QueueGraphQLField | PartnerSplitFields) QueueFields[source]¶
Subfields should come from the QueueFields class
- jwst_synergy: QueueGraphQLField = <gpp_client.generated.custom_typing_fields.QueueGraphQLField object>¶
Whether this proposal has JWST synergy.
- min_percent_time: QueueGraphQLField = <gpp_client.generated.custom_typing_fields.QueueGraphQLField object>¶
Minimum percentage of observing time required to consider this proposal successful.
- classmethod partner_splits() PartnerSplitFields[source]¶
Describes how time for the program will be apportioned across partners.
- science_subtype: QueueGraphQLField = <gpp_client.generated.custom_typing_fields.QueueGraphQLField object>¶
The science type of this Call for Proposals.
- to_o_activation: QueueGraphQLField = <gpp_client.generated.custom_typing_fields.QueueGraphQLField object>¶
Whether (and how) the observations in this proposal are available for Target of Opportunity triggering.
- us_long_term: QueueGraphQLField = <gpp_client.generated.custom_typing_fields.QueueGraphQLField object>¶
Whether this is a US Long Term proposal.
- class gpp_client.generated.custom_fields.RadialVelocityFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) RadialVelocityFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- centimeters_per_second: RadialVelocityGraphQLField = <gpp_client.generated.custom_typing_fields.RadialVelocityGraphQLField object>¶
Radial velocity in cm/s
- fields(*subfields: RadialVelocityGraphQLField) RadialVelocityFields[source]¶
Subfields should come from the RadialVelocityFields class
- kilometers_per_second: RadialVelocityGraphQLField = <gpp_client.generated.custom_typing_fields.RadialVelocityGraphQLField object>¶
Radial velocity in km/s
- meters_per_second: RadialVelocityGraphQLField = <gpp_client.generated.custom_typing_fields.RadialVelocityGraphQLField object>¶
Radial velocity in m/s
- class gpp_client.generated.custom_fields.RandomTelescopeConfigGeneratorFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) RandomTelescopeConfigGeneratorFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod center() OffsetFields[source]¶
- fields(*subfields: RandomTelescopeConfigGeneratorGraphQLField | AngleFields | OffsetFields) RandomTelescopeConfigGeneratorFields[source]¶
Subfields should come from the RandomTelescopeConfigGeneratorFields class
- seed: RandomTelescopeConfigGeneratorGraphQLField = <gpp_client.generated.custom_typing_fields.RandomTelescopeConfigGeneratorGraphQLField object>¶
- classmethod size() AngleFields[source]¶
- class gpp_client.generated.custom_fields.RecordDatasetResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of recording a new dataset.
- alias(alias: str) RecordDatasetResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod dataset() DatasetFields[source]¶
The new dataset that was added.
- fields(*subfields: RecordDatasetResultGraphQLField | DatasetFields) RecordDatasetResultFields[source]¶
Subfields should come from the RecordDatasetResultFields class
- class gpp_client.generated.custom_fields.RecordFlamingos2VisitResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldResult for recordFlamingos2Visit mutation.
- alias(alias: str) RecordFlamingos2VisitResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: RecordFlamingos2VisitResultGraphQLField | VisitFields) RecordFlamingos2VisitResultFields[source]¶
Subfields should come from the RecordFlamingos2VisitResultFields class
- classmethod visit() VisitFields[source]¶
The newly added visit record itself.
- class gpp_client.generated.custom_fields.RecordGmosNorthVisitResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of recording a GmosNorth visit.
- alias(alias: str) RecordGmosNorthVisitResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: RecordGmosNorthVisitResultGraphQLField | VisitFields) RecordGmosNorthVisitResultFields[source]¶
Subfields should come from the RecordGmosNorthVisitResultFields class
- classmethod visit() VisitFields[source]¶
The newly added visit record itself.
- class gpp_client.generated.custom_fields.RecordGmosSouthVisitResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of recording a GmosSouth visit.
- alias(alias: str) RecordGmosSouthVisitResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: RecordGmosSouthVisitResultGraphQLField | VisitFields) RecordGmosSouthVisitResultFields[source]¶
Subfields should come from the RecordGmosSouthVisitResultFields class
- classmethod visit() VisitFields[source]¶
The newly added visit record itself.
- class gpp_client.generated.custom_fields.RecordIgrins2VisitResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldResult for recordIgrins2Visit mutation.
- alias(alias: str) RecordIgrins2VisitResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: RecordIgrins2VisitResultGraphQLField | VisitFields) RecordIgrins2VisitResultFields[source]¶
Subfields should come from the RecordIgrins2VisitResultFields class
- classmethod visit() VisitFields[source]¶
The newly added visit record itself.
- class gpp_client.generated.custom_fields.RecordVisitResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of recording a new Visit.
- alias(alias: str) RecordVisitResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: RecordVisitResultGraphQLField | VisitFields) RecordVisitResultFields[source]¶
Subfields should come from the RecordVisitResultFields class
- classmethod visit() VisitFields[source]¶
- class gpp_client.generated.custom_fields.RedeemUserInvitationResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) RedeemUserInvitationResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: RedeemUserInvitationResultGraphQLField | UserInvitationFields) RedeemUserInvitationResultFields[source]¶
Subfields should come from the RedeemUserInvitationResultFields class
- classmethod invitation() UserInvitationFields[source]¶
The redeemed invitation.
- class gpp_client.generated.custom_fields.RegionFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) RegionFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod declination_arc() DeclinationArcFields[source]¶
- fields(*subfields: RegionGraphQLField | DeclinationArcFields | RightAscensionArcFields) RegionFields[source]¶
Subfields should come from the RegionFields class
- classmethod right_ascension_arc() RightAscensionArcFields[source]¶
- class gpp_client.generated.custom_fields.ReplaceFlamingos2SequenceResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of a replace sequence mutation, consisting of the newly inserted sequence.
- alias(alias: str) ReplaceFlamingos2SequenceResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ReplaceFlamingos2SequenceResultGraphQLField | Flamingos2AtomFields) ReplaceFlamingos2SequenceResultFields[source]¶
Subfields should come from the ReplaceFlamingos2SequenceResultFields class
- classmethod sequence() Flamingos2AtomFields[source]¶
- class gpp_client.generated.custom_fields.ReplaceGmosNorthSequenceResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of a replace sequence mutation, consisting of the newly inserted sequence.
- alias(alias: str) ReplaceGmosNorthSequenceResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ReplaceGmosNorthSequenceResultGraphQLField | GmosNorthAtomFields) ReplaceGmosNorthSequenceResultFields[source]¶
Subfields should come from the ReplaceGmosNorthSequenceResultFields class
- classmethod sequence() GmosNorthAtomFields[source]¶
- class gpp_client.generated.custom_fields.ReplaceGmosSouthSequenceResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of a replace sequence mutation, consisting of the newly inserted sequence.
- alias(alias: str) ReplaceGmosSouthSequenceResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ReplaceGmosSouthSequenceResultGraphQLField | GmosSouthAtomFields) ReplaceGmosSouthSequenceResultFields[source]¶
Subfields should come from the ReplaceGmosSouthSequenceResultFields class
- classmethod sequence() GmosSouthAtomFields[source]¶
- class gpp_client.generated.custom_fields.ReplaceIgrins2SequenceResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of a replace sequence mutation, consisting of the newly inserted sequence.
- alias(alias: str) ReplaceIgrins2SequenceResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ReplaceIgrins2SequenceResultGraphQLField | Igrins2AtomFields) ReplaceIgrins2SequenceResultFields[source]¶
Subfields should come from the ReplaceIgrins2SequenceResultFields class
- classmethod sequence() Igrins2AtomFields[source]¶
- class gpp_client.generated.custom_fields.ResetAcquisitionResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of resetting the acquisition sequence.
- alias(alias: str) ResetAcquisitionResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ResetAcquisitionResultGraphQLField | ObservationFields) ResetAcquisitionResultFields[source]¶
Subfields should come from the ResetAcquisitionResultFields class
- classmethod observation() ObservationFields[source]¶
The observation whose acquisition was reset.
- class gpp_client.generated.custom_fields.RevokeUserInvitationResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) RevokeUserInvitationResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: RevokeUserInvitationResultGraphQLField | UserInvitationFields) RevokeUserInvitationResultFields[source]¶
Subfields should come from the RevokeUserInvitationResultFields class
- classmethod invitation() UserInvitationFields[source]¶
The revoked invitation.
- class gpp_client.generated.custom_fields.RightAscensionArcFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) RightAscensionArcFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod end() RightAscensionFields[source]¶
- fields(*subfields: RightAscensionArcGraphQLField | RightAscensionFields) RightAscensionArcFields[source]¶
Subfields should come from the RightAscensionArcFields class
- classmethod start() RightAscensionFields[source]¶
- type_: RightAscensionArcGraphQLField = <gpp_client.generated.custom_typing_fields.RightAscensionArcGraphQLField object>¶
- class gpp_client.generated.custom_fields.RightAscensionFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) RightAscensionFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- degrees: RightAscensionGraphQLField = <gpp_client.generated.custom_typing_fields.RightAscensionGraphQLField object>¶
Right Ascension (RA) in degrees
- fields(*subfields: RightAscensionGraphQLField) RightAscensionFields[source]¶
Subfields should come from the RightAscensionFields class
- hms: RightAscensionGraphQLField = <gpp_client.generated.custom_typing_fields.RightAscensionGraphQLField object>¶
SS.SSS format
- Type:
Right Ascension (RA) in HH
- Type:
MM
- hours: RightAscensionGraphQLField = <gpp_client.generated.custom_typing_fields.RightAscensionGraphQLField object>¶
Right Ascension (RA) in hours
- microseconds: RightAscensionGraphQLField = <gpp_client.generated.custom_typing_fields.RightAscensionGraphQLField object>¶
Right Ascension (RA) in µs
- class gpp_client.generated.custom_fields.ScienceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldScience step
- alias(alias: str) ScienceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ScienceGraphQLField) ScienceFields[source]¶
Subfields should come from the ScienceFields class
- step_type: ScienceGraphQLField = <gpp_client.generated.custom_typing_fields.ScienceGraphQLField object>¶
Step type
- class gpp_client.generated.custom_fields.ScienceProgramReferenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ScienceProgramReferenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: ScienceProgramReferenceGraphQLField) ScienceProgramReferenceFields[source]¶
Subfields should come from the ScienceProgramReferenceFields class
- label: ScienceProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ScienceProgramReferenceGraphQLField object>¶
- science_subtype: ScienceProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ScienceProgramReferenceGraphQLField object>¶
- semester: ScienceProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ScienceProgramReferenceGraphQLField object>¶
- semester_index: ScienceProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ScienceProgramReferenceGraphQLField object>¶
- type_: ScienceProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.ScienceProgramReferenceGraphQLField object>¶
- class gpp_client.generated.custom_fields.ScienceRequirementsFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) ScienceRequirementsFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod exposure_time_mode() ExposureTimeModeFields[source]¶
Requested exposure time mode.
- fields(*subfields: ScienceRequirementsGraphQLField | ExposureTimeModeFields | ImagingScienceRequirementsFields | SpectroscopyScienceRequirementsFields) ScienceRequirementsFields[source]¶
Subfields should come from the ScienceRequirementsFields class
- classmethod imaging() ImagingScienceRequirementsFields[source]¶
Imaging requirements, if mode is Imaging, this mode must be set
- mode: ScienceRequirementsGraphQLField = <gpp_client.generated.custom_typing_fields.ScienceRequirementsGraphQLField object>¶
Science mode
- classmethod spectroscopy() SpectroscopyScienceRequirementsFields[source]¶
Spectroscopy requirements, if mode is Spectroscopy, this mode must be set
- class gpp_client.generated.custom_fields.SequenceDigestFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) SequenceDigestFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- atom_count: SequenceDigestGraphQLField = <gpp_client.generated.custom_typing_fields.SequenceDigestGraphQLField object>¶
Total count of anticipated atoms, including the ‘nextAtom’, ‘possibleFuture’ and any remaining atoms not included in ‘possibleFuture’.
- execution_state: SequenceDigestGraphQLField = <gpp_client.generated.custom_typing_fields.SequenceDigestGraphQLField object>¶
Execution state for the sequence. Note, acquisition sequences are never ‘COMPLETED’. The execution state for the observation as a whole is that of the science sequence.
- fields(*subfields: SequenceDigestGraphQLField | CategorizedTimeFields | TelescopeConfigFields) SequenceDigestFields[source]¶
Subfields should come from the SequenceDigestFields class
- observe_class: SequenceDigestGraphQLField = <gpp_client.generated.custom_typing_fields.SequenceDigestGraphQLField object>¶
ObserveClass of the whole sequence.
- classmethod telescope_configs() TelescopeConfigFields[source]¶
TelescopeConfig (offset + guiding) for each step.
- classmethod time_estimate() CategorizedTimeFields[source]¶
Time estimate for the whole sequence.
- class gpp_client.generated.custom_fields.SequenceEventFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldSequence-level events. As commands are issued to execute a sequence, corresponding events are generated.
- alias(alias: str) SequenceEventFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- command: SequenceEventGraphQLField = <gpp_client.generated.custom_typing_fields.SequenceEventGraphQLField object>¶
Sequence event data.
- event_type: SequenceEventGraphQLField = <gpp_client.generated.custom_typing_fields.SequenceEventGraphQLField object>¶
Event type.
- fields(*subfields: SequenceEventGraphQLField | ObservationFields | VisitFields) SequenceEventFields[source]¶
Subfields should come from the SequenceEventFields class
- id: SequenceEventGraphQLField = <gpp_client.generated.custom_typing_fields.SequenceEventGraphQLField object>¶
Event id.
- idempotency_key: SequenceEventGraphQLField = <gpp_client.generated.custom_typing_fields.SequenceEventGraphQLField object>¶
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.
- classmethod observation() ObservationFields[source]¶
Observation whose execution produced this event.
- received: SequenceEventGraphQLField = <gpp_client.generated.custom_typing_fields.SequenceEventGraphQLField object>¶
Time at which this event was received.
- classmethod visit() VisitFields[source]¶
Visit associated with the event.
- class gpp_client.generated.custom_fields.SetAllocationsResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) SetAllocationsResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod allocations() AllocationFields[source]¶
- fields(*subfields: SetAllocationsResultGraphQLField | AllocationFields) SetAllocationsResultFields[source]¶
Subfields should come from the SetAllocationsResultFields class
- class gpp_client.generated.custom_fields.SetGuideTargetNameResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of setting the guide target name for an observation.
- alias(alias: str) SetGuideTargetNameResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: SetGuideTargetNameResultGraphQLField | ObservationFields) SetGuideTargetNameResultFields[source]¶
Subfields should come from the SetGuideTargetNameResultFields class
- classmethod observation() ObservationFields[source]¶
- class gpp_client.generated.custom_fields.SetProgramReferenceResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) SetProgramReferenceResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: SetProgramReferenceResultGraphQLField | ProgramReferenceInterface) SetProgramReferenceResultFields[source]¶
Subfields should come from the SetProgramReferenceResultFields class
- classmethod reference() ProgramReferenceInterface[source]¶
The resulting program reference, if any.
- class gpp_client.generated.custom_fields.SetProposalStatusResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of setting the proposal status.
- alias(alias: str) SetProposalStatusResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: SetProposalStatusResultGraphQLField | ProgramFields) SetProposalStatusResultFields[source]¶
Subfields should come from the SetProposalStatusResultFields class
- classmethod program() ProgramFields[source]¶
The program on which the proposal status was set. Returning the program allows checking the proposal reference, program reference and other values that can be affected by changing the proposal status.
- class gpp_client.generated.custom_fields.SetupTimeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) SetupTimeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: SetupTimeGraphQLField | TimeSpanFields) SetupTimeFields[source]¶
Subfields should come from the SetupTimeFields class
- classmethod full() TimeSpanFields[source]¶
Full setup time estimate, including slew, configuration and target acquisition
- classmethod reacquisition() TimeSpanFields[source]¶
A reduced setup time contemplating reacquiring a previously acquired target
- class gpp_client.generated.custom_fields.SiderealFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) SiderealFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod catalog_info() CatalogInfoFields[source]¶
Catalog info, if any, describing from where the information in this target was obtained
- classmethod dec() DeclinationFields[source]¶
Declination at epoch
- epoch: SiderealGraphQLField = <gpp_client.generated.custom_typing_fields.SiderealGraphQLField object>¶
Epoch, time of base observation
- fields(*subfields: SiderealGraphQLField | CatalogInfoFields | DeclinationFields | ParallaxFields | ProperMotionFields | RadialVelocityFields | RightAscensionFields) SiderealFields[source]¶
Subfields should come from the SiderealFields class
- classmethod parallax() ParallaxFields[source]¶
Parallax
- classmethod proper_motion() ProperMotionFields[source]¶
Proper motion per year in right ascension and declination
- classmethod ra() RightAscensionFields[source]¶
Right ascension at epoch
- classmethod radial_velocity() RadialVelocityFields[source]¶
Radial velocity
- class gpp_client.generated.custom_fields.SignalToNoiseAtFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldCalculated signal to noise at a specific wavelength
- alias(alias: str) SignalToNoiseAtFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: SignalToNoiseAtGraphQLField | WavelengthFields) SignalToNoiseAtFields[source]¶
Subfields should come from the SignalToNoiseAtFields class
- single: SignalToNoiseAtGraphQLField = <gpp_client.generated.custom_typing_fields.SignalToNoiseAtGraphQLField object>¶
Single exposure signal to noise
- total: SignalToNoiseAtGraphQLField = <gpp_client.generated.custom_typing_fields.SignalToNoiseAtGraphQLField object>¶
Total exposure signal to noise
- classmethod wavelength() WavelengthFields[source]¶
Wavelength sn was calculated at
- class gpp_client.generated.custom_fields.SignalToNoiseExposureTimeModeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldSignal to noise exposure time mode
- alias(alias: str) SignalToNoiseExposureTimeModeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod at() WavelengthFields[source]¶
Signal/Noise wavelength
- fields(*subfields: SignalToNoiseExposureTimeModeGraphQLField | WavelengthFields) SignalToNoiseExposureTimeModeFields[source]¶
Subfields should come from the SignalToNoiseExposureTimeModeFields class
- value: SignalToNoiseExposureTimeModeGraphQLField = <gpp_client.generated.custom_typing_fields.SignalToNoiseExposureTimeModeGraphQLField object>¶
Signal/Noise value
- class gpp_client.generated.custom_fields.SiteCoordinateLimitsFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldCoordinate limits per site.
- alias(alias: str) SiteCoordinateLimitsFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: SiteCoordinateLimitsGraphQLField | CoordinateLimitsFields) SiteCoordinateLimitsFields[source]¶
Subfields should come from the SiteCoordinateLimitsFields class
- classmethod north() CoordinateLimitsFields[source]¶
Gemini North coordinate limits.
- classmethod south() CoordinateLimitsFields[source]¶
Gemini South coordinate limits.
- class gpp_client.generated.custom_fields.SlewEventFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldSlew events.
- alias(alias: str) SlewEventFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- event_type: SlewEventGraphQLField = <gpp_client.generated.custom_typing_fields.SlewEventGraphQLField object>¶
Event type.
- fields(*subfields: SlewEventGraphQLField | ObservationFields | VisitFields) SlewEventFields[source]¶
Subfields should come from the SlewEventFields class
- id: SlewEventGraphQLField = <gpp_client.generated.custom_typing_fields.SlewEventGraphQLField object>¶
Event id.
- idempotency_key: SlewEventGraphQLField = <gpp_client.generated.custom_typing_fields.SlewEventGraphQLField object>¶
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.
- classmethod observation() ObservationFields[source]¶
Observation whose execution produced this event.
- received: SlewEventGraphQLField = <gpp_client.generated.custom_typing_fields.SlewEventGraphQLField object>¶
Time at which this event was received.
- slew_stage: SlewEventGraphQLField = <gpp_client.generated.custom_typing_fields.SlewEventGraphQLField object>¶
Slew event data.
- classmethod visit() VisitFields[source]¶
Visit associated with the event.
- class gpp_client.generated.custom_fields.SmartGcalFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldSmartGcal step configuration.
- alias(alias: str) SmartGcalFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: SmartGcalGraphQLField) SmartGcalFields[source]¶
Subfields should come from the SmartGcalFields class
- smart_gcal_type: SmartGcalGraphQLField = <gpp_client.generated.custom_typing_fields.SmartGcalGraphQLField object>¶
- step_type: SmartGcalGraphQLField = <gpp_client.generated.custom_typing_fields.SmartGcalGraphQLField object>¶
Step type
- class gpp_client.generated.custom_fields.SourceProfileFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldSource profile, exactly one of the fields will be defined
- alias(alias: str) SourceProfileFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: SourceProfileGraphQLField | GaussianSourceFields | SpectralDefinitionIntegratedFields | SpectralDefinitionSurfaceFields) SourceProfileFields[source]¶
Subfields should come from the SourceProfileFields class
- classmethod gaussian() GaussianSourceFields[source]¶
gaussian source, integrated units
- classmethod point() SpectralDefinitionIntegratedFields[source]¶
point source, integrated units
- classmethod uniform() SpectralDefinitionSurfaceFields[source]¶
uniform source, surface units
- class gpp_client.generated.custom_fields.SpectralDefinitionIntegratedFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldSpectral definition integrated. Exactly one of the fields will be defined.
- alias(alias: str) SpectralDefinitionIntegratedFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod band_normalized() BandNormalizedIntegratedFields[source]¶
Band normalized spectral definition
- classmethod emission_lines() EmissionLinesIntegratedFields[source]¶
Emission lines spectral definition
- fields(*subfields: SpectralDefinitionIntegratedGraphQLField | BandNormalizedIntegratedFields | EmissionLinesIntegratedFields) SpectralDefinitionIntegratedFields[source]¶
Subfields should come from the SpectralDefinitionIntegratedFields class
- class gpp_client.generated.custom_fields.SpectralDefinitionSurfaceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldSpectral definition surface. Exactly one of the fields will be defined.
- alias(alias: str) SpectralDefinitionSurfaceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod band_normalized() BandNormalizedSurfaceFields[source]¶
Band normalized spectral definition
- classmethod emission_lines() EmissionLinesSurfaceFields[source]¶
Emission lines spectral definition
- fields(*subfields: SpectralDefinitionSurfaceGraphQLField | BandNormalizedSurfaceFields | EmissionLinesSurfaceFields) SpectralDefinitionSurfaceFields[source]¶
Subfields should come from the SpectralDefinitionSurfaceFields class
- class gpp_client.generated.custom_fields.SpectroscopyConfigOptionFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldDescribes an instrument configuration option for spectroscopy.
- adaptive_optics: SpectroscopyConfigOptionGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGraphQLField object>¶
- alias(alias: str) SpectroscopyConfigOptionFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- capability: SpectroscopyConfigOptionGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGraphQLField object>¶
A special capability (if any) that the configuration may have.
- disperser_label: SpectroscopyConfigOptionGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGraphQLField object>¶
- fields(*subfields: SpectroscopyConfigOptionGraphQLField | AngleFields | SpectroscopyConfigOptionFlamingos2Fields | SpectroscopyConfigOptionGhostFields | SpectroscopyConfigOptionGmosNorthFields | SpectroscopyConfigOptionGmosSouthFields | SpectroscopyConfigOptionGnirsFields | WavelengthFields) SpectroscopyConfigOptionFields[source]¶
Subfields should come from the SpectroscopyConfigOptionFields class
- filter_label: SpectroscopyConfigOptionGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGraphQLField object>¶
- classmethod flamingos_2() SpectroscopyConfigOptionFlamingos2Fields[source]¶
For Flamingos2 options, the Flamingos 2configuration. Null for other instruments.
- focal_plane: SpectroscopyConfigOptionGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGraphQLField object>¶
- fpu_label: SpectroscopyConfigOptionGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGraphQLField object>¶
- classmethod ghost() SpectroscopyConfigOptionGhostFields[source]¶
For GHOST options, the GHOST configuration. Null for other instruments.
- classmethod gmos_north() SpectroscopyConfigOptionGmosNorthFields[source]¶
For GMOS North options, the GMOS North configuration. Null for other instruments.
- classmethod gmos_south() SpectroscopyConfigOptionGmosSouthFields[source]¶
For GMOS South options, the GMOS South configuration. Null for other instruments.
- classmethod gnirs() SpectroscopyConfigOptionGnirsFields[source]¶
For GNIRS options, the GNIRS configuration. Null for other instruments.
- instrument: SpectroscopyConfigOptionGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGraphQLField object>¶
- name: SpectroscopyConfigOptionGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGraphQLField object>¶
- resolution: SpectroscopyConfigOptionGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGraphQLField object>¶
- site: SpectroscopyConfigOptionGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGraphQLField object>¶
- classmethod slit_length() AngleFields[source]¶
- classmethod slit_width() AngleFields[source]¶
- classmethod wavelength_coverage() WavelengthFields[source]¶
- classmethod wavelength_max() WavelengthFields[source]¶
- classmethod wavelength_min() WavelengthFields[source]¶
- classmethod wavelength_optimal() WavelengthFields[source]¶
- class gpp_client.generated.custom_fields.SpectroscopyConfigOptionFlamingos2Fields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) SpectroscopyConfigOptionFlamingos2Fields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- disperser: SpectroscopyConfigOptionFlamingos2GraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionFlamingos2GraphQLField object>¶
- fields(*subfields: SpectroscopyConfigOptionFlamingos2GraphQLField) SpectroscopyConfigOptionFlamingos2Fields[source]¶
Subfields should come from the SpectroscopyConfigOptionFlamingos2Fields class
- filter_: SpectroscopyConfigOptionFlamingos2GraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionFlamingos2GraphQLField object>¶
- fpu: SpectroscopyConfigOptionFlamingos2GraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionFlamingos2GraphQLField object>¶
- class gpp_client.generated.custom_fields.SpectroscopyConfigOptionGhostFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) SpectroscopyConfigOptionGhostFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- binning: SpectroscopyConfigOptionGhostGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGhostGraphQLField object>¶
- fields(*subfields: SpectroscopyConfigOptionGhostGraphQLField) SpectroscopyConfigOptionGhostFields[source]¶
Subfields should come from the SpectroscopyConfigOptionGhostFields class
- resolution_mode: SpectroscopyConfigOptionGhostGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGhostGraphQLField object>¶
- class gpp_client.generated.custom_fields.SpectroscopyConfigOptionGmosNorthFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) SpectroscopyConfigOptionGmosNorthFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: SpectroscopyConfigOptionGmosNorthGraphQLField) SpectroscopyConfigOptionGmosNorthFields[source]¶
Subfields should come from the SpectroscopyConfigOptionGmosNorthFields class
- filter_: SpectroscopyConfigOptionGmosNorthGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGmosNorthGraphQLField object>¶
- fpu: SpectroscopyConfigOptionGmosNorthGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGmosNorthGraphQLField object>¶
- grating: SpectroscopyConfigOptionGmosNorthGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGmosNorthGraphQLField object>¶
- class gpp_client.generated.custom_fields.SpectroscopyConfigOptionGmosSouthFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) SpectroscopyConfigOptionGmosSouthFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: SpectroscopyConfigOptionGmosSouthGraphQLField) SpectroscopyConfigOptionGmosSouthFields[source]¶
Subfields should come from the SpectroscopyConfigOptionGmosSouthFields class
- filter_: SpectroscopyConfigOptionGmosSouthGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGmosSouthGraphQLField object>¶
- fpu: SpectroscopyConfigOptionGmosSouthGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGmosSouthGraphQLField object>¶
- grating: SpectroscopyConfigOptionGmosSouthGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGmosSouthGraphQLField object>¶
- class gpp_client.generated.custom_fields.SpectroscopyConfigOptionGnirsFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) SpectroscopyConfigOptionGnirsFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- camera: SpectroscopyConfigOptionGnirsGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGnirsGraphQLField object>¶
- fields(*subfields: SpectroscopyConfigOptionGnirsGraphQLField) SpectroscopyConfigOptionGnirsFields[source]¶
Subfields should come from the SpectroscopyConfigOptionGnirsFields class
- filter_: SpectroscopyConfigOptionGnirsGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGnirsGraphQLField object>¶
- fpu: SpectroscopyConfigOptionGnirsGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGnirsGraphQLField object>¶
- grating: SpectroscopyConfigOptionGnirsGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGnirsGraphQLField object>¶
- prism: SpectroscopyConfigOptionGnirsGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyConfigOptionGnirsGraphQLField object>¶
- class gpp_client.generated.custom_fields.SpectroscopyScienceRequirementsFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) SpectroscopyScienceRequirementsFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- capability: SpectroscopyScienceRequirementsGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyScienceRequirementsGraphQLField object>¶
Spectroscopy Capabilities
- fields(*subfields: SpectroscopyScienceRequirementsGraphQLField | AngleFields | WavelengthFields) SpectroscopyScienceRequirementsFields[source]¶
Subfields should come from the SpectroscopyScienceRequirementsFields class
- focal_plane: SpectroscopyScienceRequirementsGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyScienceRequirementsGraphQLField object>¶
Focal plane choice
- classmethod focal_plane_angle() AngleFields[source]¶
Focal plane angle
- resolution: SpectroscopyScienceRequirementsGraphQLField = <gpp_client.generated.custom_typing_fields.SpectroscopyScienceRequirementsGraphQLField object>¶
Requested resolution
- classmethod wavelength() WavelengthFields[source]¶
Requested central wavelength
- classmethod wavelength_coverage() WavelengthFields[source]¶
Wavelength range
- class gpp_client.generated.custom_fields.SpiralTelescopeConfigGeneratorFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) SpiralTelescopeConfigGeneratorFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod center() OffsetFields[source]¶
- fields(*subfields: SpiralTelescopeConfigGeneratorGraphQLField | AngleFields | OffsetFields) SpiralTelescopeConfigGeneratorFields[source]¶
Subfields should come from the SpiralTelescopeConfigGeneratorFields class
- seed: SpiralTelescopeConfigGeneratorGraphQLField = <gpp_client.generated.custom_typing_fields.SpiralTelescopeConfigGeneratorGraphQLField object>¶
- classmethod size() AngleFields[source]¶
- class gpp_client.generated.custom_fields.StepConfigInterface(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldStep (bias, dark, gcal, science, etc.)
- alias(alias: str) StepConfigInterface[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: StepConfigGraphQLField) StepConfigInterface[source]¶
Subfields should come from the StepConfigInterface class
- on(type_name: str, *subfields: GraphQLField) StepConfigInterface[source]¶
- step_type: StepConfigGraphQLField = <gpp_client.generated.custom_typing_fields.StepConfigGraphQLField object>¶
Step type
- class gpp_client.generated.custom_fields.StepEstimateFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldTime estimate for an individual step, including configuration changes and dataset production.
- alias(alias: str) StepEstimateFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod config_change() AllConfigChangeEstimatesFields[source]¶
Configuration changes required before the step is executed. This will obviously depend not only on the step configuration but also the previous step configuration.
- classmethod detector() AllDetectorEstimatesFields[source]¶
Time for producing the datasets for this step.
- fields(*subfields: StepEstimateGraphQLField | AllConfigChangeEstimatesFields | AllDetectorEstimatesFields | TimeSpanFields) StepEstimateFields[source]¶
Subfields should come from the StepEstimateFields class
- classmethod total() TimeSpanFields[source]¶
Total time estimate for the step.
- class gpp_client.generated.custom_fields.StepEventFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldStep-level events. The execution of a single step will generate multiple events.
- alias(alias: str) StepEventFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod atom() AtomRecordFields[source]¶
Atom associated with this event.
- event_type: StepEventGraphQLField = <gpp_client.generated.custom_typing_fields.StepEventGraphQLField object>¶
Event type.
- fields(*subfields: StepEventGraphQLField | AtomRecordFields | ObservationFields | StepRecordFields | VisitFields) StepEventFields[source]¶
Subfields should come from the StepEventFields class
- id: StepEventGraphQLField = <gpp_client.generated.custom_typing_fields.StepEventGraphQLField object>¶
Event id.
- idempotency_key: StepEventGraphQLField = <gpp_client.generated.custom_typing_fields.StepEventGraphQLField object>¶
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.
- classmethod observation() ObservationFields[source]¶
Observation whose execution produced this event.
- received: StepEventGraphQLField = <gpp_client.generated.custom_typing_fields.StepEventGraphQLField object>¶
Time at which this event was received.
- classmethod step() StepRecordFields[source]¶
Step associated with this event.
- step_stage: StepEventGraphQLField = <gpp_client.generated.custom_typing_fields.StepEventGraphQLField object>¶
Step execution stage.
- classmethod visit() VisitFields[source]¶
Visit associated with the event.
- class gpp_client.generated.custom_fields.StepRecordFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA step as recorded by Observe. There will be one instrument configuration per instrument, all but one of which will be null.
- alias(alias: str) StepRecordFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod atom() AtomRecordFields[source]¶
The atom in which the step was executed.
- classmethod datasets(*, offset: Any | None = None, limit: Any | None = None) DatasetSelectResultFields[source]¶
Datasets associated with this step.
- classmethod estimate() TimeSpanFields[source]¶
Original time estimate for executing this step.
- classmethod events(*, offset: Any | None = None, limit: Any | None = None) ExecutionEventSelectResultFields[source]¶
Execution events associated with this step.
- execution_state: StepRecordGraphQLField = <gpp_client.generated.custom_typing_fields.StepRecordGraphQLField object>¶
The execution state of this step, according to events received (if any) from Observe.
- fields(*subfields: StepRecordGraphQLField | AtomRecordFields | DatasetSelectResultFields | ExecutionEventSelectResultFields | Flamingos2DynamicFields | GhostDynamicFields | GmosNorthDynamicFields | GmosSouthDynamicFields | Igrins2DynamicFields | StepConfigInterface | TelescopeConfigFields | TimeSpanFields | TimestampIntervalFields) StepRecordFields[source]¶
Subfields should come from the StepRecordFields class
- classmethod flamingos_2() Flamingos2DynamicFields[source]¶
Flamingos 2 instrument configuration for this step, if any. This will be null unless the instrument discriminator is “FLAMINGOS2”.
- classmethod ghost() GhostDynamicFields[source]¶
Ghost instrument configuration for this step, if any. This will be null unless the instrument discriminator is “GHOST”.
- classmethod gmos_north() GmosNorthDynamicFields[source]¶
GMOS North instrument configuration for this step, if any. This will be null unless the instrument discriminator is “GMOS_NORTH”.
- classmethod gmos_south() GmosSouthDynamicFields[source]¶
GMOS South instrument configuration for this step, if any. This will be null unless the instrument discriminator is “GMOS_SOUTH”.
- id: StepRecordGraphQLField = <gpp_client.generated.custom_typing_fields.StepRecordGraphQLField object>¶
Step ID.
- classmethod igrins_2() Igrins2DynamicFields[source]¶
IGRINS-2 instrument configuration for this step, if any. This will be null unless the instrument discriminator is “IGRINS2”.
- index: StepRecordGraphQLField = <gpp_client.generated.custom_typing_fields.StepRecordGraphQLField object>¶
Step Index, relative to other step records in the observation.
- instrument: StepRecordGraphQLField = <gpp_client.generated.custom_typing_fields.StepRecordGraphQLField object>¶
Instrument associated with the step. This will indicate which of the instrument-specific dynamic fields (e.g., gmosNorth: GmosNorthDynamic) is defined.
- classmethod interval() TimestampIntervalFields[source]¶
Time interval during which this step executed. This measures the range of time from the first event to the last, whether or not the step ever actually completed.
- observe_class: StepRecordGraphQLField = <gpp_client.generated.custom_typing_fields.StepRecordGraphQLField object>¶
The observe class of this step.
- qa_state: StepRecordGraphQLField = <gpp_client.generated.custom_typing_fields.StepRecordGraphQLField object>¶
QA state based on a combination of dataset QA states. The worst QA state is taken as the overall step QA state. For example, one FAIL dataset will result in the step having a FAIL QA state. Unset QA states are ignored, but if none are set the result will be null.
- classmethod step_config() StepConfigInterface[source]¶
The step configuration, apart from instrument details found in the instrument-specific ‘StepRecord’ implementation.
- classmethod telescope_config() TelescopeConfigFields[source]¶
The telescope configuration for this step.
- class gpp_client.generated.custom_fields.StepRecordSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldStepRecord query results, limited to a maximum of 1000 entries.
- alias(alias: str) StepRecordSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: StepRecordSelectResultGraphQLField | StepRecordFields) StepRecordSelectResultFields[source]¶
Subfields should come from the StepRecordSelectResultFields class
- has_more: StepRecordSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.StepRecordSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() StepRecordFields[source]¶
Matching step records up to the return size limit of 1000.
- class gpp_client.generated.custom_fields.SystemProgramReferenceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) SystemProgramReferenceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: SystemProgramReferenceGraphQLField) SystemProgramReferenceFields[source]¶
Subfields should come from the SystemProgramReferenceFields class
- label: SystemProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.SystemProgramReferenceGraphQLField object>¶
- type_: SystemProgramReferenceGraphQLField = <gpp_client.generated.custom_typing_fields.SystemProgramReferenceGraphQLField object>¶
- class gpp_client.generated.custom_fields.SystemVerificationFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldProposal properties for System Verification CallForProposals.
- alias(alias: str) SystemVerificationFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: SystemVerificationGraphQLField) SystemVerificationFields[source]¶
Subfields should come from the SystemVerificationFields class
- min_percent_time: SystemVerificationGraphQLField = <gpp_client.generated.custom_typing_fields.SystemVerificationGraphQLField object>¶
Minimum percentage of observing time required to consider this proposal successful.
- science_subtype: SystemVerificationGraphQLField = <gpp_client.generated.custom_typing_fields.SystemVerificationGraphQLField object>¶
The science type of this Call for Proposals.
- to_o_activation: SystemVerificationGraphQLField = <gpp_client.generated.custom_typing_fields.SystemVerificationGraphQLField object>¶
Whether (and how) the observations in this proposal are available for Target of Opportunity triggering.
- class gpp_client.generated.custom_fields.TargetEnvironmentFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) TargetEnvironmentFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod asterism(include_deleted: bool) TargetFields[source]¶
All the observation’s science targets, if any
- classmethod base_position(observation_time: Any) CoordinatesFields[source]¶
Explicit (if defined) or computed base position at the specified time, if known.
- classmethod blind_offset_target() TargetFields[source]¶
The target used for blind offset acquisition, if any
- blind_offset_type: TargetEnvironmentGraphQLField = <gpp_client.generated.custom_typing_fields.TargetEnvironmentGraphQLField object>¶
The type of blind offset (automatic or manual) if a blind offset exists.
- classmethod explicit_base() CoordinatesFields[source]¶
When set, overrides the default base position of the target group
- fields(*subfields: TargetEnvironmentGraphQLField | CoordinatesFields | GuideAvailabilityPeriodFields | GuideEnvironmentFields | TargetFields) TargetEnvironmentFields[source]¶
Subfields should come from the TargetEnvironmentFields class
- classmethod first_science_target(include_deleted: bool) TargetFields[source]¶
First, perhaps only, science target in the asterism
- classmethod guide_availability(start: Any, end: Any) GuideAvailabilityPeriodFields[source]¶
Availability of guide stars during a specified time range. There can be multiple GuideAvailabilityPeriod`s returned if availability changes over the time range. In this case, the `end of one period will be the same as the start of the next period.
- classmethod guide_environment() GuideEnvironmentFields[source]¶
The guide target(s) and related information. If a guide target has been set via guideTargetName, that target will be returned. If it not found or not usable, an error will be returned. If no guide target has been set, or it has been invalidated by observation/target changes, Gaia will be searched for the best guide target available.
- classmethod guide_environments(observation_time: Any) GuideEnvironmentFields[source]¶
The guide star(s) and related information
- guide_target_name: TargetEnvironmentGraphQLField = <gpp_client.generated.custom_typing_fields.TargetEnvironmentGraphQLField object>¶
The name of the guide target, if any, set by setGuideTargetName. If the name is no longer valid or a sequence cannot be generated, null will be returned.
- use_blind_offset: TargetEnvironmentGraphQLField = <gpp_client.generated.custom_typing_fields.TargetEnvironmentGraphQLField object>¶
Whether blind offset is enabled for this observation
- class gpp_client.generated.custom_fields.TargetFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldTarget description
- alias(alias: str) TargetFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- calibration_role: TargetGraphQLField = <gpp_client.generated.custom_typing_fields.TargetGraphQLField object>¶
calibration role
- disposition: TargetGraphQLField = <gpp_client.generated.custom_typing_fields.TargetGraphQLField object>¶
Target disposition. See TargetDisposition for more information.
- existence: TargetGraphQLField = <gpp_client.generated.custom_typing_fields.TargetGraphQLField object>¶
DELETED or PRESENT
- fields(*subfields: TargetGraphQLField | NonsiderealFields | OpportunityFields | ProgramFields | SiderealFields | SourceProfileFields) TargetFields[source]¶
Subfields should come from the TargetFields class
- id: TargetGraphQLField = <gpp_client.generated.custom_typing_fields.TargetGraphQLField object>¶
Target ID
- name: TargetGraphQLField = <gpp_client.generated.custom_typing_fields.TargetGraphQLField object>¶
Target name.
- classmethod nonsidereal() NonsiderealFields[source]¶
Nonsidereal tracking information, if this is a nonsidereal target
- classmethod opportunity() OpportunityFields[source]¶
Target of opportunity range information, if this a TOO target
- classmethod program(include_deleted: bool) ProgramFields[source]¶
Program that contains this target
- classmethod sidereal() SiderealFields[source]¶
Sidereal tracking information, if this is a sidereal target
- classmethod source_profile() SourceProfileFields[source]¶
source profile
- class gpp_client.generated.custom_fields.TargetGroupFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) TargetGroupFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: TargetGroupGraphQLField | ObservationSelectResultFields | ProgramFields | TargetFields) TargetGroupFields[source]¶
Subfields should come from the TargetGroupFields class
- classmethod observations(include_deleted: bool, *, offset: Any | None = None, limit: Any | None = None) ObservationSelectResultFields[source]¶
Observations associated with the common value
- classmethod program() ProgramFields[source]¶
Link back to program.
- classmethod target() TargetFields[source]¶
Commonly held value across the observations
- class gpp_client.generated.custom_fields.TargetGroupSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe matching targetGroup results, limited to a maximum of 1000 entries.
- alias(alias: str) TargetGroupSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: TargetGroupSelectResultGraphQLField | TargetGroupFields) TargetGroupSelectResultFields[source]¶
Subfields should come from the TargetGroupSelectResultFields class
- has_more: TargetGroupSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.TargetGroupSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() TargetGroupFields[source]¶
Matching targetGroups up to the return size limit of 1000
- class gpp_client.generated.custom_fields.TargetSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe matching target results, limited to a maximum of 1000 entries.
- alias(alias: str) TargetSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: TargetSelectResultGraphQLField | TargetFields) TargetSelectResultFields[source]¶
Subfields should come from the TargetSelectResultFields class
- has_more: TargetSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.TargetSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() TargetFields[source]¶
Matching targets up to the return size limit of 1000
- class gpp_client.generated.custom_fields.TelescopeConfigFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) TelescopeConfigFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: TelescopeConfigGraphQLField | OffsetFields) TelescopeConfigFields[source]¶
Subfields should come from the TelescopeConfigFields class
- guiding: TelescopeConfigGraphQLField = <gpp_client.generated.custom_typing_fields.TelescopeConfigGraphQLField object>¶
Guide State (whether guiding is enabled for this step)
- classmethod offset() OffsetFields[source]¶
Offset
- class gpp_client.generated.custom_fields.TelescopeConfigGeneratorFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldAn offset generator produces a series of offsets according to generator-specific parameters. Only (at most) one of enumerated, random, spiral or uniform will be defined. All others will be null. The generatorType corresponds to the entry (if any) that is defined. If the generator type of NONE, then none of the entries will be defined.
- alias(alias: str) TelescopeConfigGeneratorFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod enumerated() EnumeratedTelescopeConfigGeneratorFields[source]¶
- fields(*subfields: TelescopeConfigGeneratorGraphQLField | EnumeratedTelescopeConfigGeneratorFields | RandomTelescopeConfigGeneratorFields | SpiralTelescopeConfigGeneratorFields | UniformTelescopeConfigGeneratorFields) TelescopeConfigGeneratorFields[source]¶
Subfields should come from the TelescopeConfigGeneratorFields class
- generator_type: TelescopeConfigGeneratorGraphQLField = <gpp_client.generated.custom_typing_fields.TelescopeConfigGeneratorGraphQLField object>¶
- classmethod random() RandomTelescopeConfigGeneratorFields[source]¶
- classmethod spiral() SpiralTelescopeConfigGeneratorFields[source]¶
- classmethod uniform() UniformTelescopeConfigGeneratorFields[source]¶
- class gpp_client.generated.custom_fields.TelluricTypeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldTelluric calibration type
- alias(alias: str) TelluricTypeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: TelluricTypeGraphQLField) TelluricTypeFields[source]¶
Subfields should come from the TelluricTypeFields class
- star_types: TelluricTypeGraphQLField = <gpp_client.generated.custom_typing_fields.TelluricTypeGraphQLField object>¶
- tag: TelluricTypeGraphQLField = <gpp_client.generated.custom_typing_fields.TelluricTypeGraphQLField object>¶
- class gpp_client.generated.custom_fields.TimeAndCountExposureTimeModeFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldTime and Count exposure time mode.
- alias(alias: str) TimeAndCountExposureTimeModeFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod at() WavelengthFields[source]¶
S/N at Wavelength.
- count: TimeAndCountExposureTimeModeGraphQLField = <gpp_client.generated.custom_typing_fields.TimeAndCountExposureTimeModeGraphQLField object>¶
Exposure count.
- fields(*subfields: TimeAndCountExposureTimeModeGraphQLField | TimeSpanFields | WavelengthFields) TimeAndCountExposureTimeModeFields[source]¶
Subfields should come from the TimeAndCountExposureTimeModeFields class
- classmethod time() TimeSpanFields[source]¶
Exposure time.
- class gpp_client.generated.custom_fields.TimeChargeCorrectionFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA manual correction to time accounting calculations. Note that the application of a correction is bounded by a zero time span and the maximum time span.
- alias(alias: str) TimeChargeCorrectionFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod amount() TimeSpanFields[source]¶
The amount of time to add or subtract (respecting the min and max time span).
- charge_class: TimeChargeCorrectionGraphQLField = <gpp_client.generated.custom_typing_fields.TimeChargeCorrectionGraphQLField object>¶
The charge class to be corrected.
- comment: TimeChargeCorrectionGraphQLField = <gpp_client.generated.custom_typing_fields.TimeChargeCorrectionGraphQLField object>¶
Optional justification for the correction.
- created: TimeChargeCorrectionGraphQLField = <gpp_client.generated.custom_typing_fields.TimeChargeCorrectionGraphQLField object>¶
When the correction was made.
- fields(*subfields: TimeChargeCorrectionGraphQLField | TimeSpanFields | UserFields) TimeChargeCorrectionFields[source]¶
Subfields should come from the TimeChargeCorrectionFields class
- op: TimeChargeCorrectionGraphQLField = <gpp_client.generated.custom_typing_fields.TimeChargeCorrectionGraphQLField object>¶
The operation (add or subtract) to perform.
- classmethod user() UserFields[source]¶
The user responsible for the change.
- class gpp_client.generated.custom_fields.TimeChargeDaylightDiscountFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA time charge discount that is applied when part of the observation is executed outside of nautical twilight boundaries. The portion that occurs during day time is not charged.
- alias(alias: str) TimeChargeDaylightDiscountFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod amount() TimeSpanFields[source]¶
Time amount to discount from the program.
- comment: TimeChargeDaylightDiscountGraphQLField = <gpp_client.generated.custom_typing_fields.TimeChargeDaylightDiscountGraphQLField object>¶
Additional detail.
- fields(*subfields: TimeChargeDaylightDiscountGraphQLField | TimeSpanFields | TimestampIntervalFields) TimeChargeDaylightDiscountFields[source]¶
Subfields should come from the TimeChargeDaylightDiscountFields class
- classmethod interval() TimestampIntervalFields[source]¶
The interval during which this discount applies.
- site: TimeChargeDaylightDiscountGraphQLField = <gpp_client.generated.custom_typing_fields.TimeChargeDaylightDiscountGraphQLField object>¶
The site where the observation was executed.
- class gpp_client.generated.custom_fields.TimeChargeDiscountInterface(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldDescribes a time charge discount, broken out by charge class. For each class, the associated time is subtracted and then added to uncharged.
- alias(alias: str) TimeChargeDiscountInterface[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod amount() TimeSpanFields[source]¶
Time amount to discount from the program.
- comment: TimeChargeDiscountGraphQLField = <gpp_client.generated.custom_typing_fields.TimeChargeDiscountGraphQLField object>¶
Additional detail.
- fields(*subfields: TimeChargeDiscountGraphQLField | TimeSpanFields | TimestampIntervalFields) TimeChargeDiscountInterface[source]¶
Subfields should come from the TimeChargeDiscountInterface class
- classmethod interval() TimestampIntervalFields[source]¶
The interval during which this discount applies.
- on(type_name: str, *subfields: GraphQLField) TimeChargeDiscountInterface[source]¶
- class gpp_client.generated.custom_fields.TimeChargeInvoiceFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldDetailed time accounting information for a visit, showing the raw execution time along with any automatically applied discounts (e.g., for bad weather) and manual adjustments made by staff.
- alias(alias: str) TimeChargeInvoiceFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod corrections() TimeChargeCorrectionFields[source]¶
Any manual corrections to the execution time.
- classmethod discounts() TimeChargeDiscountInterface[source]¶
Automatic discounts for weather loss, fault reports, and non-passing datasets.
- classmethod execution_time() CategorizedTimeFields[source]¶
Raw execution time.
- fields(*subfields: TimeChargeInvoiceGraphQLField | CategorizedTimeFields | TimeChargeCorrectionFields | TimeChargeDiscountInterface) TimeChargeInvoiceFields[source]¶
Subfields should come from the TimeChargeInvoiceFields class
- classmethod final_charge() CategorizedTimeFields[source]¶
Final time charge once discounts and corrections have been applied to the initial ‘executionTime’.
- class gpp_client.generated.custom_fields.TimeChargeNoDataDiscountFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA time charge discount that is applied when no data is collected during the entirety of the visit.
- alias(alias: str) TimeChargeNoDataDiscountFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod amount() TimeSpanFields[source]¶
Time amount to discount from the program.
- comment: TimeChargeNoDataDiscountGraphQLField = <gpp_client.generated.custom_typing_fields.TimeChargeNoDataDiscountGraphQLField object>¶
Additional detail.
- fields(*subfields: TimeChargeNoDataDiscountGraphQLField | TimeSpanFields | TimestampIntervalFields) TimeChargeNoDataDiscountFields[source]¶
Subfields should come from the TimeChargeNoDataDiscountFields class
- classmethod interval() TimestampIntervalFields[source]¶
The interval during which this discount applies.
- class gpp_client.generated.custom_fields.TimeChargeOverlapDiscountFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA time charge discount that is applied when part of the observation is executed after an overlapping chargeable observation is started. For example, when writing out datasets while slewing to a new target.
- alias(alias: str) TimeChargeOverlapDiscountFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod amount() TimeSpanFields[source]¶
Time amount to discount from the program.
- comment: TimeChargeOverlapDiscountGraphQLField = <gpp_client.generated.custom_typing_fields.TimeChargeOverlapDiscountGraphQLField object>¶
Additional detail.
- fields(*subfields: TimeChargeOverlapDiscountGraphQLField | ObservationFields | TimeSpanFields | TimestampIntervalFields) TimeChargeOverlapDiscountFields[source]¶
Subfields should come from the TimeChargeOverlapDiscountFields class
- classmethod interval() TimestampIntervalFields[source]¶
The interval during which this discount applies.
- classmethod observation() ObservationFields[source]¶
The overlapping observation.
- class gpp_client.generated.custom_fields.TimeChargeQaDiscountFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) TimeChargeQaDiscountFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod amount() TimeSpanFields[source]¶
Time amount to discount from the program.
- comment: TimeChargeQaDiscountGraphQLField = <gpp_client.generated.custom_typing_fields.TimeChargeQaDiscountGraphQLField object>¶
Additional detail.
- classmethod datasets() DatasetFields[source]¶
Datasets associated with the discount.
- fields(*subfields: TimeChargeQaDiscountGraphQLField | DatasetFields | TimeSpanFields | TimestampIntervalFields) TimeChargeQaDiscountFields[source]¶
Subfields should come from the TimeChargeQaDiscountFields class
- classmethod interval() TimestampIntervalFields[source]¶
The interval during which this discount applies.
- class gpp_client.generated.custom_fields.TimeSpanFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldEquivalent time amount in several unit options (e.g., 120 seconds or 2 minutes)
- alias(alias: str) TimeSpanFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: TimeSpanGraphQLField) TimeSpanFields[source]¶
Subfields should come from the TimeSpanFields class
- hours: TimeSpanGraphQLField = <gpp_client.generated.custom_typing_fields.TimeSpanGraphQLField object>¶
TimeSpan in hours
- iso: TimeSpanGraphQLField = <gpp_client.generated.custom_typing_fields.TimeSpanGraphQLField object>¶
TimeSpan as an ISO-8601 string
- microseconds: TimeSpanGraphQLField = <gpp_client.generated.custom_typing_fields.TimeSpanGraphQLField object>¶
TimeSpan in µs
- milliseconds: TimeSpanGraphQLField = <gpp_client.generated.custom_typing_fields.TimeSpanGraphQLField object>¶
TimeSpan in ms
- minutes: TimeSpanGraphQLField = <gpp_client.generated.custom_typing_fields.TimeSpanGraphQLField object>¶
TimeSpan in minutes
- seconds: TimeSpanGraphQLField = <gpp_client.generated.custom_typing_fields.TimeSpanGraphQLField object>¶
TimeSpan in seconds
- class gpp_client.generated.custom_fields.TimestampIntervalFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldTime interval marked by a start ‘Timestamp’ (inclusive) and an end ‘Timestamp’ (exclusive).
- alias(alias: str) TimestampIntervalFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod duration() TimeSpanFields[source]¶
Duration of the interval.
- end: TimestampIntervalGraphQLField = <gpp_client.generated.custom_typing_fields.TimestampIntervalGraphQLField object>¶
End time of the interval (exclusive).
- fields(*subfields: TimestampIntervalGraphQLField | TimeSpanFields) TimestampIntervalFields[source]¶
Subfields should come from the TimestampIntervalFields class
- start: TimestampIntervalGraphQLField = <gpp_client.generated.custom_typing_fields.TimestampIntervalGraphQLField object>¶
Start time of the interval (inclusive).
- class gpp_client.generated.custom_fields.TimingWindowEndAfterFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldTiming window end after a period of time.
- classmethod after() TimeSpanFields[source]¶
Window duration.
- alias(alias: str) TimingWindowEndAfterFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: TimingWindowEndAfterGraphQLField | TimeSpanFields | TimingWindowRepeatFields) TimingWindowEndAfterFields[source]¶
Subfields should come from the TimingWindowEndAfterFields class
- classmethod repeat() TimingWindowRepeatFields[source]¶
Window repetetion. If absent, will not repeat.
- class gpp_client.generated.custom_fields.TimingWindowEndAtFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldTiming window end at a specified date and time.
- alias(alias: str) TimingWindowEndAtFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- at_utc: TimingWindowEndAtGraphQLField = <gpp_client.generated.custom_typing_fields.TimingWindowEndAtGraphQLField object>¶
Window end date and time, in UTC.
- fields(*subfields: TimingWindowEndAtGraphQLField) TimingWindowEndAtFields[source]¶
Subfields should come from the TimingWindowEndAtFields class
- class gpp_client.generated.custom_fields.TimingWindowFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) TimingWindowFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- end: TimingWindowEndUnion = <gpp_client.generated.custom_typing_fields.TimingWindowEndUnion object>¶
Window end. If absent, the window will never end.
- fields(*subfields: TimingWindowGraphQLField | TimingWindowEndUnion) TimingWindowFields[source]¶
Subfields should come from the TimingWindowFields class
- inclusion: TimingWindowGraphQLField = <gpp_client.generated.custom_typing_fields.TimingWindowGraphQLField object>¶
Whether this is an INCLUDE or EXCLUDE window.
- start_utc: TimingWindowGraphQLField = <gpp_client.generated.custom_typing_fields.TimingWindowGraphQLField object>¶
Window start time, in UTC.
- class gpp_client.generated.custom_fields.TimingWindowRepeatFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldTiming window repetition
- alias(alias: str) TimingWindowRepeatFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: TimingWindowRepeatGraphQLField | TimeSpanFields) TimingWindowRepeatFields[source]¶
Subfields should come from the TimingWindowRepeatFields class
- classmethod period() TimeSpanFields[source]¶
Repeat period, counting from the start of the window.
- times: TimingWindowRepeatGraphQLField = <gpp_client.generated.custom_typing_fields.TimingWindowRepeatGraphQLField object>¶
Repetition times. If absent, will repeat forever.
- class gpp_client.generated.custom_fields.UniformTelescopeConfigGeneratorFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldDefines a region of the sky using two corners. Exposures are then distributed across this region as evenly as possible.
- alias(alias: str) UniformTelescopeConfigGeneratorFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod corner_a() OffsetFields[source]¶
- classmethod corner_b() OffsetFields[source]¶
- fields(*subfields: UniformTelescopeConfigGeneratorGraphQLField | OffsetFields) UniformTelescopeConfigGeneratorFields[source]¶
Subfields should come from the UniformTelescopeConfigGeneratorFields class
- class gpp_client.generated.custom_fields.UnlinkUserResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) UnlinkUserResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: UnlinkUserResultGraphQLField) UnlinkUserResultFields[source]¶
Subfields should come from the UnlinkUserResultFields class
- result: UnlinkUserResultGraphQLField = <gpp_client.generated.custom_typing_fields.UnlinkUserResultGraphQLField object>¶
Returns true if the user was unlinked, false if no such link existed.
- class gpp_client.generated.custom_fields.UnnormalizedSedFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldUn-normalized spectral energy distribution. Exactly one of the definitions will be non-null.
- alias(alias: str) UnnormalizedSedFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- black_body_temp_k: UnnormalizedSedGraphQLField = <gpp_client.generated.custom_typing_fields.UnnormalizedSedGraphQLField object>¶
- cool_star: UnnormalizedSedGraphQLField = <gpp_client.generated.custom_typing_fields.UnnormalizedSedGraphQLField object>¶
- fields(*subfields: UnnormalizedSedGraphQLField | FluxDensityEntryFields) UnnormalizedSedFields[source]¶
Subfields should come from the UnnormalizedSedFields class
- classmethod flux_densities() FluxDensityEntryFields[source]¶
- flux_densities_attachment: UnnormalizedSedGraphQLField = <gpp_client.generated.custom_typing_fields.UnnormalizedSedGraphQLField object>¶
- galaxy: UnnormalizedSedGraphQLField = <gpp_client.generated.custom_typing_fields.UnnormalizedSedGraphQLField object>¶
- hii_region: UnnormalizedSedGraphQLField = <gpp_client.generated.custom_typing_fields.UnnormalizedSedGraphQLField object>¶
- planet: UnnormalizedSedGraphQLField = <gpp_client.generated.custom_typing_fields.UnnormalizedSedGraphQLField object>¶
- planetary_nebula: UnnormalizedSedGraphQLField = <gpp_client.generated.custom_typing_fields.UnnormalizedSedGraphQLField object>¶
- power_law: UnnormalizedSedGraphQLField = <gpp_client.generated.custom_typing_fields.UnnormalizedSedGraphQLField object>¶
- quasar: UnnormalizedSedGraphQLField = <gpp_client.generated.custom_typing_fields.UnnormalizedSedGraphQLField object>¶
- stellar_library: UnnormalizedSedGraphQLField = <gpp_client.generated.custom_typing_fields.UnnormalizedSedGraphQLField object>¶
- class gpp_client.generated.custom_fields.UpdateAsterismsResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of updating the selected observations, up to LIMIT or the maximum of (1000). If hasMore is true, additional observations were modified and not included here.
- alias(alias: str) UpdateAsterismsResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: UpdateAsterismsResultGraphQLField | ObservationFields) UpdateAsterismsResultFields[source]¶
Subfields should come from the UpdateAsterismsResultFields class
- has_more: UpdateAsterismsResultGraphQLField = <gpp_client.generated.custom_typing_fields.UpdateAsterismsResultGraphQLField object>¶
true when there were additional edits that were not returned.
- classmethod observations() ObservationFields[source]¶
The edited observations, up to the specified LIMIT or the default maximum of 1000.
- class gpp_client.generated.custom_fields.UpdateAttachmentsResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of updating the selected attachments, up to LIMIT or the maximum of (1000). If hasMore is true, additional attachments were modified and not included here.
- alias(alias: str) UpdateAttachmentsResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod attachments() AttachmentFields[source]¶
The edited attachments, up to the specified LIMIT or the default maximum of 1000.
- fields(*subfields: UpdateAttachmentsResultGraphQLField | AttachmentFields) UpdateAttachmentsResultFields[source]¶
Subfields should come from the UpdateAttachmentsResultFields class
- has_more: UpdateAttachmentsResultGraphQLField = <gpp_client.generated.custom_typing_fields.UpdateAttachmentsResultGraphQLField object>¶
true when there were additional edits that were not returned.
- class gpp_client.generated.custom_fields.UpdateCallsForProposalsResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of updating the selected calls for proposals, up to LIMIT or the maximum of 1000. If hasMore is true, additional calls were modified and not included here.
- alias(alias: str) UpdateCallsForProposalsResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod calls_for_proposals() CallForProposalsFields[source]¶
The edited observations, up to the specified LIMIT or the default maximum of 1000.
- fields(*subfields: UpdateCallsForProposalsResultGraphQLField | CallForProposalsFields) UpdateCallsForProposalsResultFields[source]¶
Subfields should come from the UpdateCallsForProposalsResultFields class
- has_more: UpdateCallsForProposalsResultGraphQLField = <gpp_client.generated.custom_typing_fields.UpdateCallsForProposalsResultGraphQLField object>¶
true when there were additional edits that were not returned.
- class gpp_client.generated.custom_fields.UpdateConfigurationRequestsResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of updating the selected observations, up to LIMIT or the maximum of (1000). If hasMore is true, additional observations were modified and not included here.
- alias(alias: str) UpdateConfigurationRequestsResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: UpdateConfigurationRequestsResultGraphQLField | ConfigurationRequestFields) UpdateConfigurationRequestsResultFields[source]¶
Subfields should come from the UpdateConfigurationRequestsResultFields class
- has_more: UpdateConfigurationRequestsResultGraphQLField = <gpp_client.generated.custom_typing_fields.UpdateConfigurationRequestsResultGraphQLField object>¶
true when there were additional edits that were not returned.
- classmethod requests() ConfigurationRequestFields[source]¶
The edited observations, up to the specified LIMIT or the default maximum of 1000.
- class gpp_client.generated.custom_fields.UpdateDatasetsResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of updating the selected datasets, up to LIMIT or the maximum of (1000). If hasMore is true, additional datasets were modified and not included here.
- alias(alias: str) UpdateDatasetsResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod datasets() DatasetFields[source]¶
The edited datasets, up to the specified LIMIT or the default maximum of 1000.
- fields(*subfields: UpdateDatasetsResultGraphQLField | DatasetFields) UpdateDatasetsResultFields[source]¶
Subfields should come from the UpdateDatasetsResultFields class
- has_more: UpdateDatasetsResultGraphQLField = <gpp_client.generated.custom_typing_fields.UpdateDatasetsResultGraphQLField object>¶
true when there were additional edits that were not returned.
- class gpp_client.generated.custom_fields.UpdateGroupsResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) UpdateGroupsResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: UpdateGroupsResultGraphQLField | GroupFields) UpdateGroupsResultFields[source]¶
Subfields should come from the UpdateGroupsResultFields class
- classmethod groups() GroupFields[source]¶
The edited groups, up to the specified LIMIT or the default maximum of 1000.
- has_more: UpdateGroupsResultGraphQLField = <gpp_client.generated.custom_typing_fields.UpdateGroupsResultGraphQLField object>¶
true when there were additional edits that were not returned.
- class gpp_client.generated.custom_fields.UpdateObservationsResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of updating the selected observations, up to LIMIT or the maximum of (1000). If hasMore is true, additional observations were modified and not included here.
- alias(alias: str) UpdateObservationsResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: UpdateObservationsResultGraphQLField | ObservationFields) UpdateObservationsResultFields[source]¶
Subfields should come from the UpdateObservationsResultFields class
- has_more: UpdateObservationsResultGraphQLField = <gpp_client.generated.custom_typing_fields.UpdateObservationsResultGraphQLField object>¶
true when there were additional edits that were not returned.
- classmethod observations() ObservationFields[source]¶
The edited observations, up to the specified LIMIT or the default maximum of 1000.
- class gpp_client.generated.custom_fields.UpdateProgramNotesResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of updating the selected notes, up to LIMIT or the maximum of (1000). If hasMore is true, additional notes were modified and not included here.
- alias(alias: str) UpdateProgramNotesResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: UpdateProgramNotesResultGraphQLField | ProgramNoteFields) UpdateProgramNotesResultFields[source]¶
Subfields should come from the UpdateProgramNotesResultFields class
- has_more: UpdateProgramNotesResultGraphQLField = <gpp_client.generated.custom_typing_fields.UpdateProgramNotesResultGraphQLField object>¶
true when there were additional edits that were not returned.
- classmethod program_notes() ProgramNoteFields[source]¶
The edited notes, up to the specified LIMIT or the default maximum of 1000.
- class gpp_client.generated.custom_fields.UpdateProgramUsersResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of calling ‘updateProgramUsers’, up to ‘LIMIT’ or the maximum of 1000. If ‘hasMore’ is true, additional program users were modified but not included in the result.
- alias(alias: str) UpdateProgramUsersResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: UpdateProgramUsersResultGraphQLField | ProgramUserFields) UpdateProgramUsersResultFields[source]¶
Subfields should come from the UpdateProgramUsersResultFields class
- has_more: UpdateProgramUsersResultGraphQLField = <gpp_client.generated.custom_typing_fields.UpdateProgramUsersResultGraphQLField object>¶
Whether there were additional updated program users that were not returned.
- classmethod program_users() ProgramUserFields[source]¶
The first program users that were updated (up to the LIMIT specified in the mutation).
- class gpp_client.generated.custom_fields.UpdateProgramsResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of updating the selected programs, up to LIMIT or the maximum of (1000). If hasMore is true, additional programs were modified and not included here.
- alias(alias: str) UpdateProgramsResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: UpdateProgramsResultGraphQLField | ProgramFields) UpdateProgramsResultFields[source]¶
Subfields should come from the UpdateProgramsResultFields class
- has_more: UpdateProgramsResultGraphQLField = <gpp_client.generated.custom_typing_fields.UpdateProgramsResultGraphQLField object>¶
true when there were additional edits that were not returned.
- classmethod programs() ProgramFields[source]¶
The edited programs, up to the specified LIMIT or the default maximum of 1000.
- class gpp_client.generated.custom_fields.UpdateProposalResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of updating a proposal
- alias(alias: str) UpdateProposalResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: UpdateProposalResultGraphQLField | ProposalFields) UpdateProposalResultFields[source]¶
Subfields should come from the UpdateProposalResultFields class
- classmethod proposal() ProposalFields[source]¶
The updated proposal.
- class gpp_client.generated.custom_fields.UpdateTargetsResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldThe result of updating the selected targets, up to LIMIT or the maximum of (1000). If hasMore is true, additional targets were modified and not included here.
- alias(alias: str) UpdateTargetsResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: UpdateTargetsResultGraphQLField | TargetFields) UpdateTargetsResultFields[source]¶
Subfields should come from the UpdateTargetsResultFields class
- has_more: UpdateTargetsResultGraphQLField = <gpp_client.generated.custom_typing_fields.UpdateTargetsResultGraphQLField object>¶
true when there were additional edits that were not returned.
- classmethod targets() TargetFields[source]¶
The edited targets, up to the specified LIMIT or the default maximum of 1000.
- class gpp_client.generated.custom_fields.UserFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) UserFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: UserGraphQLField | UserProfileFields) UserFields[source]¶
Subfields should come from the UserFields class
- id: UserGraphQLField = <gpp_client.generated.custom_typing_fields.UserGraphQLField object>¶
- orcid_id: UserGraphQLField = <gpp_client.generated.custom_typing_fields.UserGraphQLField object>¶
- classmethod profile() UserProfileFields[source]¶
- service_name: UserGraphQLField = <gpp_client.generated.custom_typing_fields.UserGraphQLField object>¶
- type_: UserGraphQLField = <gpp_client.generated.custom_typing_fields.UserGraphQLField object>¶
- class gpp_client.generated.custom_fields.UserInvitationFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldInvitation
- alias(alias: str) UserInvitationFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod email() EmailFields[source]¶
The email sent for the invitation.
- fields(*subfields: UserInvitationGraphQLField | EmailFields | ProgramUserFields | UserFields) UserInvitationFields[source]¶
Subfields should come from the UserInvitationFields class
- id: UserInvitationGraphQLField = <gpp_client.generated.custom_typing_fields.UserInvitationGraphQLField object>¶
Id
- classmethod issuer() UserFields[source]¶
User who issued the invitation.
- classmethod program_user() ProgramUserFields[source]¶
The ProgramUser associated with the invitation.
- recipient_email: UserInvitationGraphQLField = <gpp_client.generated.custom_typing_fields.UserInvitationGraphQLField object>¶
Recipient email address.
- status: UserInvitationGraphQLField = <gpp_client.generated.custom_typing_fields.UserInvitationGraphQLField object>¶
Invitation status.
- class gpp_client.generated.custom_fields.UserProfileFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) UserProfileFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- credit_name: UserProfileGraphQLField = <gpp_client.generated.custom_typing_fields.UserProfileGraphQLField object>¶
- email: UserProfileGraphQLField = <gpp_client.generated.custom_typing_fields.UserProfileGraphQLField object>¶
- family_name: UserProfileGraphQLField = <gpp_client.generated.custom_typing_fields.UserProfileGraphQLField object>¶
- fields(*subfields: UserProfileGraphQLField) UserProfileFields[source]¶
Subfields should come from the UserProfileFields class
- given_name: UserProfileGraphQLField = <gpp_client.generated.custom_typing_fields.UserProfileGraphQLField object>¶
- class gpp_client.generated.custom_fields.VisitFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA visit is recorded whenever any part of an observation is attempted. There is a specific static configuration for each instrument, only one of which is defined. The same static configuration holds for the entire visit.
- alias(alias: str) VisitFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod atom_records(*, offset: Any | None = None, limit: Any | None = None) AtomRecordSelectResultFields[source]¶
Executed (or at least partially executed) atom records for this visit.
- created: VisitGraphQLField = <gpp_client.generated.custom_typing_fields.VisitGraphQLField object>¶
Created by Observe at time.
- classmethod datasets(*, offset: Any | None = None, limit: Any | None = None) DatasetSelectResultFields[source]¶
Datasets associated with this visit.
- classmethod events(*, offset: Any | None = None, limit: Any | None = None) ExecutionEventSelectResultFields[source]¶
Execution events associated with this visit.
- fields(*subfields: VisitGraphQLField | AtomRecordSelectResultFields | DatasetSelectResultFields | ExecutionEventSelectResultFields | Flamingos2StaticFields | GmosNorthStaticFields | GmosSouthStaticFields | Igrins2StaticFields | ObservationFields | TimeChargeInvoiceFields | TimestampIntervalFields) VisitFields[source]¶
Subfields should come from the VisitFields class
- classmethod flamingos_2() Flamingos2StaticFields[source]¶
Flamingos 2 static instrument configuration, for Flamingos 2 visits. See the instrument discriminator. This will be null unless the instrument is FLAMINGOS2.
- classmethod gmos_north() GmosNorthStaticFields[source]¶
GmosNorth static instrument configuration, for GMOS North visits. See the instrument discriminator. This will be null unless the instrument is GMOS_NORTH.
- classmethod gmos_south() GmosSouthStaticFields[source]¶
GmosSouth static instrument configuration, for GMOS South visits. See the instrument discriminator. This will be null unless the instrument is GMOS_SOUTH.
- id: VisitGraphQLField = <gpp_client.generated.custom_typing_fields.VisitGraphQLField object>¶
Visit id.
- idempotency_key: VisitGraphQLField = <gpp_client.generated.custom_typing_fields.VisitGraphQLField object>¶
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.
- classmethod igrins_2() Igrins2StaticFields[source]¶
IGRINS-2 static instrument configuration, for IGRINS-2 visits. See the instrument discriminator. This will be null unless the instrument is IGRINS2.
- instrument: VisitGraphQLField = <gpp_client.generated.custom_typing_fields.VisitGraphQLField object>¶
Instrument in use for this visit. This serves as a discriminator between the various specific static instrument configuration types (e.g., gmosNorth: GmosNorthStatic.)
- classmethod interval() TimestampIntervalFields[source]¶
Time interval during which this visit executed.
- classmethod observation() ObservationFields[source]¶
Observation associated with this visit.
- site: VisitGraphQLField = <gpp_client.generated.custom_typing_fields.VisitGraphQLField object>¶
Site of the visit.
- classmethod time_charge_invoice() TimeChargeInvoiceFields[source]¶
Time accounting details for this visit.
- class gpp_client.generated.custom_fields.VisitSelectResultFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldMatching visit results, limited to a maximum of 1000 entries.
- alias(alias: str) VisitSelectResultFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- fields(*subfields: VisitSelectResultGraphQLField | VisitFields) VisitSelectResultFields[source]¶
Subfields should come from the VisitSelectResultFields class
- has_more: VisitSelectResultGraphQLField = <gpp_client.generated.custom_typing_fields.VisitSelectResultGraphQLField object>¶
true when there were additional matches that were not returned.
- classmethod matches() VisitFields[source]¶
Matching visits up to the return size limit of 1000.
- class gpp_client.generated.custom_fields.VisitorFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) VisitorFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- classmethod central_wavelength() WavelengthFields[source]¶
- fields(*subfields: VisitorGraphQLField | AngleFields | WavelengthFields) VisitorFields[source]¶
Subfields should come from the VisitorFields class
- classmethod guide_star_min_sep() AngleFields[source]¶
- mode: VisitorGraphQLField = <gpp_client.generated.custom_typing_fields.VisitorGraphQLField object>¶
- class gpp_client.generated.custom_fields.WavelengthDitherFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLFieldA WavelengthDither is expressed in the same units as Wavelength but constrained to positive values. It expresses an “offset” to a given Wavelength.
- alias(alias: str) WavelengthDitherFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- angstroms: WavelengthDitherGraphQLField = <gpp_client.generated.custom_typing_fields.WavelengthDitherGraphQLField object>¶
Wavelength dither in Å
- fields(*subfields: WavelengthDitherGraphQLField) WavelengthDitherFields[source]¶
Subfields should come from the WavelengthDitherFields class
- micrometers: WavelengthDitherGraphQLField = <gpp_client.generated.custom_typing_fields.WavelengthDitherGraphQLField object>¶
Wavelength dither in µm
- nanometers: WavelengthDitherGraphQLField = <gpp_client.generated.custom_typing_fields.WavelengthDitherGraphQLField object>¶
Wavelength dither in nm
- picometers: WavelengthDitherGraphQLField = <gpp_client.generated.custom_typing_fields.WavelengthDitherGraphQLField object>¶
Wavelength dither in pm
- class gpp_client.generated.custom_fields.WavelengthFields(field_name: str, arguments: dict[str, dict[str, Any]] | None = None)[source]¶
Bases:
GraphQLField- alias(alias: str) WavelengthFields[source]¶
Sets an alias for the GraphQL field and returns the instance.
- angstroms: WavelengthGraphQLField = <gpp_client.generated.custom_typing_fields.WavelengthGraphQLField object>¶
Wavelength in Å
- fields(*subfields: WavelengthGraphQLField) WavelengthFields[source]¶
Subfields should come from the WavelengthFields class
- micrometers: WavelengthGraphQLField = <gpp_client.generated.custom_typing_fields.WavelengthGraphQLField object>¶
Wavelength in µm
- nanometers: WavelengthGraphQLField = <gpp_client.generated.custom_typing_fields.WavelengthGraphQLField object>¶
Wavelength in nm
- picometers: WavelengthGraphQLField = <gpp_client.generated.custom_typing_fields.WavelengthGraphQLField object>¶
Wavelength in pm