data_kiosk_2023_11_15_models

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 14, 2023 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (

	// QueryProcessingStatusCANCELLED captures enum value "CANCELLED"
	QueryProcessingStatusCANCELLED string = "CANCELLED"

	// QueryProcessingStatusDONE captures enum value "DONE"
	QueryProcessingStatusDONE string = "DONE"

	// QueryProcessingStatusFATAL captures enum value "FATAL"
	QueryProcessingStatusFATAL string = "FATAL"

	// QueryProcessingStatusINPROGRESS captures enum value "IN_PROGRESS"
	QueryProcessingStatusINPROGRESS string = "IN_PROGRESS"

	// QueryProcessingStatusINQUEUE captures enum value "IN_QUEUE"
	QueryProcessingStatusINQUEUE string = "IN_QUEUE"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateQueryResponse

type CreateQueryResponse struct {

	// The identifier for the query. This identifier is unique only in combination with a selling partner account ID.
	// Required: true
	QueryID *string `json:"queryId"`
}

CreateQueryResponse The response for the `createQuery` operation.

swagger:model CreateQueryResponse

func (*CreateQueryResponse) ContextValidate

func (m *CreateQueryResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this create query response based on context it is used

func (*CreateQueryResponse) MarshalBinary

func (m *CreateQueryResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateQueryResponse) UnmarshalBinary

func (m *CreateQueryResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateQueryResponse) Validate

func (m *CreateQueryResponse) Validate(formats strfmt.Registry) error

Validate validates this create query response

type CreateQuerySpecification

type CreateQuerySpecification struct {

	// A token to fetch a certain page of query results when there are multiple pages of query results available. The value of this token must be fetched from the `pagination.nextToken` field of the `Query` object, and the `query` field for this object must also be set to the `query` field of the same `Query` object. A `Query` object can be retrieved from either the `getQueries` or `getQuery` operation. In the absence of this token value, the first page of query results will be requested.
	PaginationToken string `json:"paginationToken,omitempty"`

	// The GraphQL query to submit. A query must be at most 8000 characters after unnecessary whitespace is removed.
	// Required: true
	Query *string `json:"query"`
}

CreateQuerySpecification Information required to create the query.

swagger:model CreateQuerySpecification

func (*CreateQuerySpecification) ContextValidate

func (m *CreateQuerySpecification) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this create query specification based on context it is used

func (*CreateQuerySpecification) MarshalBinary

func (m *CreateQuerySpecification) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateQuerySpecification) UnmarshalBinary

func (m *CreateQuerySpecification) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateQuerySpecification) Validate

func (m *CreateQuerySpecification) Validate(formats strfmt.Registry) error

Validate validates this create query specification

type Error

type Error struct {

	// An error code that identifies the type of error that occurred.
	// Required: true
	Code *string `json:"code"`

	// Additional details that can help the caller understand or fix the issue.
	Details string `json:"details,omitempty"`

	// A message that describes the error condition in a human-readable form.
	// Required: true
	Message *string `json:"message"`
}

Error Error response returned when the request is unsuccessful.

swagger:model Error

func (*Error) ContextValidate

func (m *Error) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error based on context it is used

func (*Error) MarshalBinary

func (m *Error) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error) UnmarshalBinary

func (m *Error) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error) Validate

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

type ErrorList

type ErrorList struct {

	// errors
	// Required: true
	Errors []*Error `json:"errors"`
}

ErrorList A list of error responses returned when a request is unsuccessful.

swagger:model ErrorList

func (*ErrorList) ContextValidate

func (m *ErrorList) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this error list based on the context it is used

func (*ErrorList) MarshalBinary

func (m *ErrorList) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorList) UnmarshalBinary

func (m *ErrorList) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorList) Validate

func (m *ErrorList) Validate(formats strfmt.Registry) error

Validate validates this error list

type GetDocumentResponse

type GetDocumentResponse struct {

	// The identifier for the Data Kiosk document. This identifier is unique only in combination with a selling partner account ID.
	// Required: true
	DocumentID *string `json:"documentId"`

	// A presigned URL that can be used to retrieve the Data Kiosk document. This URL expires after 5 minutes. If the Data Kiosk document is compressed, the `Content-Encoding` header will indicate the compression algorithm.
	//
	// **Note:** Most HTTP clients are capable of automatically decompressing downloaded files based on the `Content-Encoding` header.
	// Required: true
	DocumentURL *string `json:"documentUrl"`
}

GetDocumentResponse The response for the `getDocument` operation.

swagger:model GetDocumentResponse

func (*GetDocumentResponse) ContextValidate

func (m *GetDocumentResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this get document response based on context it is used

func (*GetDocumentResponse) MarshalBinary

func (m *GetDocumentResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetDocumentResponse) UnmarshalBinary

func (m *GetDocumentResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetDocumentResponse) Validate

func (m *GetDocumentResponse) Validate(formats strfmt.Registry) error

Validate validates this get document response

type GetQueriesResponse

type GetQueriesResponse struct {

	// pagination
	Pagination *GetQueriesResponsePagination `json:"pagination,omitempty"`

	// The Data Kiosk queries.
	// Required: true
	Queries QueryList `json:"queries"`
}

GetQueriesResponse The response for the `getQueries` operation.

swagger:model GetQueriesResponse

func (*GetQueriesResponse) ContextValidate

func (m *GetQueriesResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get queries response based on the context it is used

func (*GetQueriesResponse) MarshalBinary

func (m *GetQueriesResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetQueriesResponse) UnmarshalBinary

func (m *GetQueriesResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetQueriesResponse) Validate

func (m *GetQueriesResponse) Validate(formats strfmt.Registry) error

Validate validates this get queries response

type GetQueriesResponsePagination

type GetQueriesResponsePagination struct {

	// A token that can be used to fetch the next page of results.
	NextToken string `json:"nextToken,omitempty"`
}

GetQueriesResponsePagination When a request has results that are not included in this response, pagination occurs. This means the results are divided into pages. To retrieve the next page, you must pass the `nextToken` as the `paginationToken` query parameter in the subsequent `getQueries` request. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `pageSize` which can be modified between calls to `getQueries`. When there are no more pages to fetch, the `nextToken` field will be absent.

swagger:model GetQueriesResponsePagination

func (*GetQueriesResponsePagination) ContextValidate

func (m *GetQueriesResponsePagination) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this get queries response pagination based on context it is used

func (*GetQueriesResponsePagination) MarshalBinary

func (m *GetQueriesResponsePagination) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetQueriesResponsePagination) UnmarshalBinary

func (m *GetQueriesResponsePagination) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetQueriesResponsePagination) Validate

func (m *GetQueriesResponsePagination) Validate(formats strfmt.Registry) error

Validate validates this get queries response pagination

type Query

type Query struct {

	// The date and time when the query was created, in ISO 8601 date time format.
	// Required: true
	// Format: date-time
	CreatedTime *strfmt.DateTime `json:"createdTime"`

	// The data document identifier. This identifier is only present when there is data available as a result of the query. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the `getDocument` operation to get the information required to retrieve the data document's contents.
	DataDocumentID string `json:"dataDocumentId,omitempty"`

	// The error document identifier. This identifier is only present when an error occurs during query processing. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the `getDocument` operation to get the information required to retrieve the error document's contents.
	ErrorDocumentID string `json:"errorDocumentId,omitempty"`

	// pagination
	Pagination *QueryPagination `json:"pagination,omitempty"`

	// The date and time when the query processing completed, in ISO 8601 date time format.
	// Format: date-time
	ProcessingEndTime strfmt.DateTime `json:"processingEndTime,omitempty"`

	// The date and time when the query processing started, in ISO 8601 date time format.
	// Format: date-time
	ProcessingStartTime strfmt.DateTime `json:"processingStartTime,omitempty"`

	// The processing status of the query.
	// Required: true
	// Enum: [CANCELLED DONE FATAL IN_PROGRESS IN_QUEUE]
	ProcessingStatus *string `json:"processingStatus"`

	// The submitted query.
	// Required: true
	Query *string `json:"query"`

	// The query identifier. This identifier is unique only in combination with a selling partner account ID.
	// Required: true
	QueryID *string `json:"queryId"`
}

Query Detailed information about the query.

swagger:model Query

func (*Query) ContextValidate

func (m *Query) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this query based on the context it is used

func (*Query) MarshalBinary

func (m *Query) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Query) UnmarshalBinary

func (m *Query) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Query) Validate

func (m *Query) Validate(formats strfmt.Registry) error

Validate validates this query

type QueryList

type QueryList []*Query

QueryList A list of queries.

swagger:model QueryList

func (QueryList) ContextValidate

func (m QueryList) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this query list based on the context it is used

func (QueryList) Validate

func (m QueryList) Validate(formats strfmt.Registry) error

Validate validates this query list

type QueryPagination

type QueryPagination struct {

	// A token that can be used to fetch the next page of results.
	NextToken string `json:"nextToken,omitempty"`
}

QueryPagination When a query produces results that are not included in the data document, pagination occurs. This means the results are divided into pages. To retrieve the next page, you must pass a `CreateQuerySpecification` object with `paginationToken` set to this object's `nextToken` and with `query` set to this object's `query` in the subsequent `createQuery` request. When there are no more pages to fetch, the `nextToken` field will be absent.

swagger:model QueryPagination

func (*QueryPagination) ContextValidate

func (m *QueryPagination) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this query pagination based on context it is used

func (*QueryPagination) MarshalBinary

func (m *QueryPagination) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*QueryPagination) UnmarshalBinary

func (m *QueryPagination) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*QueryPagination) Validate

func (m *QueryPagination) Validate(formats strfmt.Registry) error

Validate validates this query pagination

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL