streams

package
v1.4.0 Latest Latest
Warning

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

 Go to latest Published: Jun 17, 2026 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client for streams API.

func (*Client) GetActivityStreams 

func (a *Client) GetActivityStreams(params *GetActivityStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetActivityStreamsOK, error)

GetActivityStreamsgets activity streams.

Returns the given activity's streams. Requires activity:read scope. Requires activity:read_all scope for Only Me activities..

This method does not support injected context. However, timeout and opentracing contexts are honored whenever enabled.

If you need to pass a specific context, use Client.GetActivityStreamsContext instead.

func (*Client) GetActivityStreamsContext added in v1.4.0 

func (a *Client) GetActivityStreamsContext(ctx context.Context, params *GetActivityStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetActivityStreamsOK, error)

GetActivityStreamsContextgets activity streams.

Returns the given activity's streams. Requires activity:read scope. Requires activity:read_all scope for Only Me activities..

Do not use the deprecated [GetActivityStreamsParams.Context] with this method: it would be ignored.

func (*Client) GetRouteStreams 

func (a *Client) GetRouteStreams(params *GetRouteStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetRouteStreamsOK, error)

GetRouteStreamsgets route streams.

Returns the given route's streams. Requires read_all scope for private routes..

This method does not support injected context. However, timeout and opentracing contexts are honored whenever enabled.

If you need to pass a specific context, use Client.GetRouteStreamsContext instead.

func (*Client) GetRouteStreamsContext added in v1.4.0 

func (a *Client) GetRouteStreamsContext(ctx context.Context, params *GetRouteStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetRouteStreamsOK, error)

GetRouteStreamsContextgets route streams.

Returns the given route's streams. Requires read_all scope for private routes..

Do not use the deprecated [GetRouteStreamsParams.Context] with this method: it would be ignored.

func (*Client) GetSegmentEffortStreams 

func (a *Client) GetSegmentEffortStreams(params *GetSegmentEffortStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetSegmentEffortStreamsOK, error)

GetSegmentEffortStreamsgets segment effort streams.

Returns a set of streams for a segment effort completed by the authenticated athlete. Requires read_all scope..

This method does not support injected context. However, timeout and opentracing contexts are honored whenever enabled.

If you need to pass a specific context, use Client.GetSegmentEffortStreamsContext instead.

func (*Client) GetSegmentEffortStreamsContext added in v1.4.0 

func (a *Client) GetSegmentEffortStreamsContext(ctx context.Context, params *GetSegmentEffortStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetSegmentEffortStreamsOK, error)

GetSegmentEffortStreamsContextgets segment effort streams.

Returns a set of streams for a segment effort completed by the authenticated athlete. Requires read_all scope..

Do not use the deprecated [GetSegmentEffortStreamsParams.Context] with this method: it would be ignored.

func (*Client) GetSegmentStreams 

func (a *Client) GetSegmentStreams(params *GetSegmentStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetSegmentStreamsOK, error)

GetSegmentStreamsgets segment streams.

Returns the given segment's streams. Requires read_all scope for private segments..

This method does not support injected context. However, timeout and opentracing contexts are honored whenever enabled.

If you need to pass a specific context, use Client.GetSegmentStreamsContext instead.

func (*Client) GetSegmentStreamsContext added in v1.4.0 

func (a *Client) GetSegmentStreamsContext(ctx context.Context, params *GetSegmentStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetSegmentStreamsOK, error)

GetSegmentStreamsContextgets segment streams.

Returns the given segment's streams. Requires read_all scope for private segments..

Do not use the deprecated [GetSegmentStreamsParams.Context] with this method: it would be ignored.

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ContextualTransport)

SetTransport changes the transport on the client

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption may be used to customize the behavior of Client methods.

type ClientService 

type ClientService interface {

	// GetActivityStreams get activity streams.
	GetActivityStreams(params *GetActivityStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetActivityStreamsOK, error)

	// GetActivityStreamsContext get activity streams.
	GetActivityStreamsContext(ctx context.Context, params *GetActivityStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetActivityStreamsOK, error)

	// GetRouteStreams get route streams.
	GetRouteStreams(params *GetRouteStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetRouteStreamsOK, error)

	// GetRouteStreamsContext get route streams.
	GetRouteStreamsContext(ctx context.Context, params *GetRouteStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetRouteStreamsOK, error)

	// GetSegmentEffortStreams get segment effort streams.
	GetSegmentEffortStreams(params *GetSegmentEffortStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetSegmentEffortStreamsOK, error)

	// GetSegmentEffortStreamsContext get segment effort streams.
	GetSegmentEffortStreamsContext(ctx context.Context, params *GetSegmentEffortStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetSegmentEffortStreamsOK, error)

	// GetSegmentStreams get segment streams.
	GetSegmentStreams(params *GetSegmentStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetSegmentStreamsOK, error)

	// GetSegmentStreamsContext get segment streams.
	GetSegmentStreamsContext(ctx context.Context, params *GetSegmentStreamsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetSegmentStreamsOK, error)

	SetTransport(transport runtime.ContextualTransport)
}

ClientService is the interface for Client methods.

func New 

func New(transport runtime.ContextualTransport, formats strfmt.Registry) ClientService

New creates a new streams API client.

func NewClientWithBasicAuth 

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new streams API client with basic auth credentials.

It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken 

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new streams API client with a bearer token for authentication.

It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type GetActivityStreamsDefault 

type GetActivityStreamsDefault struct {
	Payload *models.Fault
	// contains filtered or unexported fields
}

GetActivityStreamsDefault describes a response with status code -1, with default header values.

Unexpected error.

func NewGetActivityStreamsDefault 

func NewGetActivityStreamsDefault(code int) *GetActivityStreamsDefault

NewGetActivityStreamsDefault creates a GetActivityStreamsDefault with default headers values

func (*GetActivityStreamsDefault) Code 

func (o *GetActivityStreamsDefault) Code() int

Code gets the status code for the get activity streams default response

func (*GetActivityStreamsDefault) Error 

func (o *GetActivityStreamsDefault) Error() string

func (*GetActivityStreamsDefault) GetPayload 

func (o *GetActivityStreamsDefault) GetPayload() *models.Fault

func (*GetActivityStreamsDefault) IsClientError 

func (o *GetActivityStreamsDefault) IsClientError() bool

IsClientError returns true when this get activity streams default response has a 4xx status code

func (*GetActivityStreamsDefault) IsCode 

func (o *GetActivityStreamsDefault) IsCode(code int) bool

IsCode returns true when this get activity streams default response a status code equal to that given

func (*GetActivityStreamsDefault) IsRedirect 

func (o *GetActivityStreamsDefault) IsRedirect() bool

IsRedirect returns true when this get activity streams default response has a 3xx status code

func (*GetActivityStreamsDefault) IsServerError 

func (o *GetActivityStreamsDefault) IsServerError() bool

IsServerError returns true when this get activity streams default response has a 5xx status code

func (*GetActivityStreamsDefault) IsSuccess 

func (o *GetActivityStreamsDefault) IsSuccess() bool

IsSuccess returns true when this get activity streams default response has a 2xx status code

func (*GetActivityStreamsDefault) String 

func (o *GetActivityStreamsDefault) String() string

type GetActivityStreamsOK 

type GetActivityStreamsOK struct {
	Payload *models.StreamSet
}

GetActivityStreamsOK describes a response with status code 200, with default header values.

The set of requested streams.

func NewGetActivityStreamsOK 

func NewGetActivityStreamsOK() *GetActivityStreamsOK

NewGetActivityStreamsOK creates a GetActivityStreamsOK with default headers values

func (*GetActivityStreamsOK) Code 

func (o *GetActivityStreamsOK) Code() int

Code gets the status code for the get activity streams o k response

func (*GetActivityStreamsOK) Error 

func (o *GetActivityStreamsOK) Error() string

func (*GetActivityStreamsOK) GetPayload 

func (o *GetActivityStreamsOK) GetPayload() *models.StreamSet

func (*GetActivityStreamsOK) IsClientError 

func (o *GetActivityStreamsOK) IsClientError() bool

IsClientError returns true when this get activity streams o k response has a 4xx status code

func (*GetActivityStreamsOK) IsCode 

func (o *GetActivityStreamsOK) IsCode(code int) bool

IsCode returns true when this get activity streams o k response a status code equal to that given

func (*GetActivityStreamsOK) IsRedirect 

func (o *GetActivityStreamsOK) IsRedirect() bool

IsRedirect returns true when this get activity streams o k response has a 3xx status code

func (*GetActivityStreamsOK) IsServerError 

func (o *GetActivityStreamsOK) IsServerError() bool

IsServerError returns true when this get activity streams o k response has a 5xx status code

func (*GetActivityStreamsOK) IsSuccess 

func (o *GetActivityStreamsOK) IsSuccess() bool

IsSuccess returns true when this get activity streams o k response has a 2xx status code

func (*GetActivityStreamsOK) String 

func (o *GetActivityStreamsOK) String() string

type GetActivityStreamsParams 

type GetActivityStreamsParams struct {

	/* ID.

	   The identifier of the activity.

	   Format: int64
	*/
	ID int64

	/* KeyByType.

	   Must be true.

	   Default: true
	*/
	KeyByType bool

	/* Keys.

	   Desired stream types.
	*/
	Keys []string

	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetActivityStreamsParams contains all the parameters to send to the API endpoint 

for the get activity streams operation.

Typically these are written to a http.Request.

func NewGetActivityStreamsParams 

func NewGetActivityStreamsParams() *GetActivityStreamsParams

NewGetActivityStreamsParams creates a new GetActivityStreamsParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetActivityStreamsParamsWithContext deprecated 

func NewGetActivityStreamsParamsWithContext(ctx context.Context) *GetActivityStreamsParams

NewGetActivityStreamsParamsWithContext creates a new GetActivityStreamsParams object with the ability to set a context for a request.

Deprecated: use the operation call with context to pass the context instead of GetActivityStreamsParams.

func NewGetActivityStreamsParamsWithHTTPClient 

func NewGetActivityStreamsParamsWithHTTPClient(client *http.Client) *GetActivityStreamsParams

NewGetActivityStreamsParamsWithHTTPClient creates a new GetActivityStreamsParams object with the ability to set a custom HTTPClient for a request.

func NewGetActivityStreamsParamsWithTimeout 

func NewGetActivityStreamsParamsWithTimeout(timeout time.Duration) *GetActivityStreamsParams

NewGetActivityStreamsParamsWithTimeout creates a new GetActivityStreamsParams object with the ability to set a timeout on a request.

func (*GetActivityStreamsParams) SetContext deprecated 

func (o *GetActivityStreamsParams) SetContext(ctx context.Context)

SetContext adds the context to the get activity streams params.

Deprecated: use the operation call with context to pass the context instead of GetActivityStreamsParams.

func (*GetActivityStreamsParams) SetDefaults 

func (o *GetActivityStreamsParams) SetDefaults()

SetDefaults hydrates default values in the get activity streams params (not the query body).

All values with no default are reset to their zero value.

func (*GetActivityStreamsParams) SetHTTPClient 

func (o *GetActivityStreamsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get activity streams params.

func (*GetActivityStreamsParams) SetID 

func (o *GetActivityStreamsParams) SetID(id int64)

SetID adds the id to the get activity streams params.

func (*GetActivityStreamsParams) SetKeyByType 

func (o *GetActivityStreamsParams) SetKeyByType(keyByType bool)

SetKeyByType adds the keyByType to the get activity streams params.

func (*GetActivityStreamsParams) SetKeys 

func (o *GetActivityStreamsParams) SetKeys(keys []string)

SetKeys adds the keys to the get activity streams params.

func (*GetActivityStreamsParams) SetTimeout 

func (o *GetActivityStreamsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get activity streams params.

func (*GetActivityStreamsParams) WithContext deprecated 

func (o *GetActivityStreamsParams) WithContext(ctx context.Context) *GetActivityStreamsParams

WithContext adds the context to the get activity streams params.

Deprecated: use the operation call with context to pass the context instead of GetActivityStreamsParams.

func (*GetActivityStreamsParams) WithDefaults 

func (o *GetActivityStreamsParams) WithDefaults() *GetActivityStreamsParams

WithDefaults hydrates default values in the get activity streams params (not the query body).

All values with no default are reset to their zero value.

func (*GetActivityStreamsParams) WithHTTPClient 

func (o *GetActivityStreamsParams) WithHTTPClient(client *http.Client) *GetActivityStreamsParams

WithHTTPClient adds the HTTPClient to the get activity streams params.

func (*GetActivityStreamsParams) WithID 

func (o *GetActivityStreamsParams) WithID(id int64) *GetActivityStreamsParams

WithID adds the id to the get activity streams params.

func (*GetActivityStreamsParams) WithKeyByType 

func (o *GetActivityStreamsParams) WithKeyByType(keyByType bool) *GetActivityStreamsParams

WithKeyByType adds the keyByType to the get activity streams params.

func (*GetActivityStreamsParams) WithKeys 

func (o *GetActivityStreamsParams) WithKeys(keys []string) *GetActivityStreamsParams

WithKeys adds the keys to the get activity streams params.

func (*GetActivityStreamsParams) WithTimeout 

func (o *GetActivityStreamsParams) WithTimeout(timeout time.Duration) *GetActivityStreamsParams

WithTimeout adds the timeout to the get activity streams params.

func (*GetActivityStreamsParams) WriteToRequest 

func (o *GetActivityStreamsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a runtime.ClientRequest.

type GetActivityStreamsReader 

type GetActivityStreamsReader struct {
	// contains filtered or unexported fields
}

GetActivityStreamsReader is a Reader for the GetActivityStreams structure.

func (*GetActivityStreamsReader) ReadResponse 

func (o *GetActivityStreamsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (any, error)

ReadResponse reads a server response into the received o.

type GetRouteStreamsDefault 

type GetRouteStreamsDefault struct {
	Payload *models.Fault
	// contains filtered or unexported fields
}

GetRouteStreamsDefault describes a response with status code -1, with default header values.

Unexpected error.

func NewGetRouteStreamsDefault 

func NewGetRouteStreamsDefault(code int) *GetRouteStreamsDefault

NewGetRouteStreamsDefault creates a GetRouteStreamsDefault with default headers values

func (*GetRouteStreamsDefault) Code 

func (o *GetRouteStreamsDefault) Code() int

Code gets the status code for the get route streams default response

func (*GetRouteStreamsDefault) Error 

func (o *GetRouteStreamsDefault) Error() string

func (*GetRouteStreamsDefault) GetPayload 

func (o *GetRouteStreamsDefault) GetPayload() *models.Fault

func (*GetRouteStreamsDefault) IsClientError 

func (o *GetRouteStreamsDefault) IsClientError() bool

IsClientError returns true when this get route streams default response has a 4xx status code

func (*GetRouteStreamsDefault) IsCode 

func (o *GetRouteStreamsDefault) IsCode(code int) bool

IsCode returns true when this get route streams default response a status code equal to that given

func (*GetRouteStreamsDefault) IsRedirect 

func (o *GetRouteStreamsDefault) IsRedirect() bool

IsRedirect returns true when this get route streams default response has a 3xx status code

func (*GetRouteStreamsDefault) IsServerError 

func (o *GetRouteStreamsDefault) IsServerError() bool

IsServerError returns true when this get route streams default response has a 5xx status code

func (*GetRouteStreamsDefault) IsSuccess 

func (o *GetRouteStreamsDefault) IsSuccess() bool

IsSuccess returns true when this get route streams default response has a 2xx status code

func (*GetRouteStreamsDefault) String 

func (o *GetRouteStreamsDefault) String() string

type GetRouteStreamsOK 

type GetRouteStreamsOK struct {
	Payload *models.StreamSet
}

GetRouteStreamsOK describes a response with status code 200, with default header values.

The set of requested streams.

func NewGetRouteStreamsOK 

func NewGetRouteStreamsOK() *GetRouteStreamsOK

NewGetRouteStreamsOK creates a GetRouteStreamsOK with default headers values

func (*GetRouteStreamsOK) Code 

func (o *GetRouteStreamsOK) Code() int

Code gets the status code for the get route streams o k response

func (*GetRouteStreamsOK) Error 

func (o *GetRouteStreamsOK) Error() string

func (*GetRouteStreamsOK) GetPayload 

func (o *GetRouteStreamsOK) GetPayload() *models.StreamSet

func (*GetRouteStreamsOK) IsClientError 

func (o *GetRouteStreamsOK) IsClientError() bool

IsClientError returns true when this get route streams o k response has a 4xx status code

func (*GetRouteStreamsOK) IsCode 

func (o *GetRouteStreamsOK) IsCode(code int) bool

IsCode returns true when this get route streams o k response a status code equal to that given

func (*GetRouteStreamsOK) IsRedirect 

func (o *GetRouteStreamsOK) IsRedirect() bool

IsRedirect returns true when this get route streams o k response has a 3xx status code

func (*GetRouteStreamsOK) IsServerError 

func (o *GetRouteStreamsOK) IsServerError() bool

IsServerError returns true when this get route streams o k response has a 5xx status code

func (*GetRouteStreamsOK) IsSuccess 

func (o *GetRouteStreamsOK) IsSuccess() bool

IsSuccess returns true when this get route streams o k response has a 2xx status code

func (*GetRouteStreamsOK) String 

func (o *GetRouteStreamsOK) String() string

type GetRouteStreamsParams 

type GetRouteStreamsParams struct {

	/* ID.

	   The identifier of the route.

	   Format: int64
	*/
	ID int64

	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetRouteStreamsParams contains all the parameters to send to the API endpoint 

for the get route streams operation.

Typically these are written to a http.Request.

func NewGetRouteStreamsParams 

func NewGetRouteStreamsParams() *GetRouteStreamsParams

NewGetRouteStreamsParams creates a new GetRouteStreamsParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetRouteStreamsParamsWithContext deprecated 

func NewGetRouteStreamsParamsWithContext(ctx context.Context) *GetRouteStreamsParams

NewGetRouteStreamsParamsWithContext creates a new GetRouteStreamsParams object with the ability to set a context for a request.

Deprecated: use the operation call with context to pass the context instead of GetRouteStreamsParams.

func NewGetRouteStreamsParamsWithHTTPClient 

func NewGetRouteStreamsParamsWithHTTPClient(client *http.Client) *GetRouteStreamsParams

NewGetRouteStreamsParamsWithHTTPClient creates a new GetRouteStreamsParams object with the ability to set a custom HTTPClient for a request.

func NewGetRouteStreamsParamsWithTimeout 

func NewGetRouteStreamsParamsWithTimeout(timeout time.Duration) *GetRouteStreamsParams

NewGetRouteStreamsParamsWithTimeout creates a new GetRouteStreamsParams object with the ability to set a timeout on a request.

func (*GetRouteStreamsParams) SetContext deprecated 

func (o *GetRouteStreamsParams) SetContext(ctx context.Context)

SetContext adds the context to the get route streams params.

Deprecated: use the operation call with context to pass the context instead of GetRouteStreamsParams.

func (*GetRouteStreamsParams) SetDefaults 

func (o *GetRouteStreamsParams) SetDefaults()

SetDefaults hydrates default values in the get route streams params (not the query body).

All values with no default are reset to their zero value.

func (*GetRouteStreamsParams) SetHTTPClient 

func (o *GetRouteStreamsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get route streams params.

func (*GetRouteStreamsParams) SetID 

func (o *GetRouteStreamsParams) SetID(id int64)

SetID adds the id to the get route streams params.

func (*GetRouteStreamsParams) SetTimeout 

func (o *GetRouteStreamsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get route streams params.

func (*GetRouteStreamsParams) WithContext deprecated 

func (o *GetRouteStreamsParams) WithContext(ctx context.Context) *GetRouteStreamsParams

WithContext adds the context to the get route streams params.

Deprecated: use the operation call with context to pass the context instead of GetRouteStreamsParams.

func (*GetRouteStreamsParams) WithDefaults 

func (o *GetRouteStreamsParams) WithDefaults() *GetRouteStreamsParams

WithDefaults hydrates default values in the get route streams params (not the query body).

All values with no default are reset to their zero value.

func (*GetRouteStreamsParams) WithHTTPClient 

func (o *GetRouteStreamsParams) WithHTTPClient(client *http.Client) *GetRouteStreamsParams

WithHTTPClient adds the HTTPClient to the get route streams params.

func (*GetRouteStreamsParams) WithID 

func (o *GetRouteStreamsParams) WithID(id int64) *GetRouteStreamsParams

WithID adds the id to the get route streams params.

func (*GetRouteStreamsParams) WithTimeout 

func (o *GetRouteStreamsParams) WithTimeout(timeout time.Duration) *GetRouteStreamsParams

WithTimeout adds the timeout to the get route streams params.

func (*GetRouteStreamsParams) WriteToRequest 

func (o *GetRouteStreamsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a runtime.ClientRequest.

type GetRouteStreamsReader 

type GetRouteStreamsReader struct {
	// contains filtered or unexported fields
}

GetRouteStreamsReader is a Reader for the GetRouteStreams structure.

func (*GetRouteStreamsReader) ReadResponse 

func (o *GetRouteStreamsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (any, error)

ReadResponse reads a server response into the received o.

type GetSegmentEffortStreamsDefault 

type GetSegmentEffortStreamsDefault struct {
	Payload *models.Fault
	// contains filtered or unexported fields
}

GetSegmentEffortStreamsDefault describes a response with status code -1, with default header values.

Unexpected error.

func NewGetSegmentEffortStreamsDefault 

func NewGetSegmentEffortStreamsDefault(code int) *GetSegmentEffortStreamsDefault

NewGetSegmentEffortStreamsDefault creates a GetSegmentEffortStreamsDefault with default headers values

func (*GetSegmentEffortStreamsDefault) Code 

func (o *GetSegmentEffortStreamsDefault) Code() int

Code gets the status code for the get segment effort streams default response

func (*GetSegmentEffortStreamsDefault) Error 

func (o *GetSegmentEffortStreamsDefault) Error() string

func (*GetSegmentEffortStreamsDefault) GetPayload 

func (o *GetSegmentEffortStreamsDefault) GetPayload() *models.Fault

func (*GetSegmentEffortStreamsDefault) IsClientError 

func (o *GetSegmentEffortStreamsDefault) IsClientError() bool

IsClientError returns true when this get segment effort streams default response has a 4xx status code

func (*GetSegmentEffortStreamsDefault) IsCode 

func (o *GetSegmentEffortStreamsDefault) IsCode(code int) bool

IsCode returns true when this get segment effort streams default response a status code equal to that given

func (*GetSegmentEffortStreamsDefault) IsRedirect 

func (o *GetSegmentEffortStreamsDefault) IsRedirect() bool

IsRedirect returns true when this get segment effort streams default response has a 3xx status code

func (*GetSegmentEffortStreamsDefault) IsServerError 

func (o *GetSegmentEffortStreamsDefault) IsServerError() bool

IsServerError returns true when this get segment effort streams default response has a 5xx status code

func (*GetSegmentEffortStreamsDefault) IsSuccess 

func (o *GetSegmentEffortStreamsDefault) IsSuccess() bool

IsSuccess returns true when this get segment effort streams default response has a 2xx status code

func (*GetSegmentEffortStreamsDefault) String 

func (o *GetSegmentEffortStreamsDefault) String() string

type GetSegmentEffortStreamsOK 

type GetSegmentEffortStreamsOK struct {
	Payload *models.StreamSet
}

GetSegmentEffortStreamsOK describes a response with status code 200, with default header values.

The set of requested streams.

func NewGetSegmentEffortStreamsOK 

func NewGetSegmentEffortStreamsOK() *GetSegmentEffortStreamsOK

NewGetSegmentEffortStreamsOK creates a GetSegmentEffortStreamsOK with default headers values

func (*GetSegmentEffortStreamsOK) Code 

func (o *GetSegmentEffortStreamsOK) Code() int

Code gets the status code for the get segment effort streams o k response

func (*GetSegmentEffortStreamsOK) Error 

func (o *GetSegmentEffortStreamsOK) Error() string

func (*GetSegmentEffortStreamsOK) GetPayload 

func (o *GetSegmentEffortStreamsOK) GetPayload() *models.StreamSet

func (*GetSegmentEffortStreamsOK) IsClientError 

func (o *GetSegmentEffortStreamsOK) IsClientError() bool

IsClientError returns true when this get segment effort streams o k response has a 4xx status code

func (*GetSegmentEffortStreamsOK) IsCode 

func (o *GetSegmentEffortStreamsOK) IsCode(code int) bool

IsCode returns true when this get segment effort streams o k response a status code equal to that given

func (*GetSegmentEffortStreamsOK) IsRedirect 

func (o *GetSegmentEffortStreamsOK) IsRedirect() bool

IsRedirect returns true when this get segment effort streams o k response has a 3xx status code

func (*GetSegmentEffortStreamsOK) IsServerError 

func (o *GetSegmentEffortStreamsOK) IsServerError() bool

IsServerError returns true when this get segment effort streams o k response has a 5xx status code

func (*GetSegmentEffortStreamsOK) IsSuccess 

func (o *GetSegmentEffortStreamsOK) IsSuccess() bool

IsSuccess returns true when this get segment effort streams o k response has a 2xx status code

func (*GetSegmentEffortStreamsOK) String 

func (o *GetSegmentEffortStreamsOK) String() string

type GetSegmentEffortStreamsParams 

type GetSegmentEffortStreamsParams struct {

	/* ID.

	   The identifier of the segment effort.

	   Format: int64
	*/
	ID int64

	/* KeyByType.

	   Must be true.

	   Default: true
	*/
	KeyByType bool

	/* Keys.

	   The types of streams to return.
	*/
	Keys []string

	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetSegmentEffortStreamsParams contains all the parameters to send to the API endpoint 

for the get segment effort streams operation.

Typically these are written to a http.Request.

func NewGetSegmentEffortStreamsParams 

func NewGetSegmentEffortStreamsParams() *GetSegmentEffortStreamsParams

NewGetSegmentEffortStreamsParams creates a new GetSegmentEffortStreamsParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetSegmentEffortStreamsParamsWithContext deprecated 

func NewGetSegmentEffortStreamsParamsWithContext(ctx context.Context) *GetSegmentEffortStreamsParams

NewGetSegmentEffortStreamsParamsWithContext creates a new GetSegmentEffortStreamsParams object with the ability to set a context for a request.

Deprecated: use the operation call with context to pass the context instead of GetSegmentEffortStreamsParams.

func NewGetSegmentEffortStreamsParamsWithHTTPClient 

func NewGetSegmentEffortStreamsParamsWithHTTPClient(client *http.Client) *GetSegmentEffortStreamsParams

NewGetSegmentEffortStreamsParamsWithHTTPClient creates a new GetSegmentEffortStreamsParams object with the ability to set a custom HTTPClient for a request.

func NewGetSegmentEffortStreamsParamsWithTimeout 

func NewGetSegmentEffortStreamsParamsWithTimeout(timeout time.Duration) *GetSegmentEffortStreamsParams

NewGetSegmentEffortStreamsParamsWithTimeout creates a new GetSegmentEffortStreamsParams object with the ability to set a timeout on a request.

func (*GetSegmentEffortStreamsParams) SetContext deprecated 

func (o *GetSegmentEffortStreamsParams) SetContext(ctx context.Context)

SetContext adds the context to the get segment effort streams params.

Deprecated: use the operation call with context to pass the context instead of GetSegmentEffortStreamsParams.

func (*GetSegmentEffortStreamsParams) SetDefaults 

func (o *GetSegmentEffortStreamsParams) SetDefaults()

SetDefaults hydrates default values in the get segment effort streams params (not the query body).

All values with no default are reset to their zero value.

func (*GetSegmentEffortStreamsParams) SetHTTPClient 

func (o *GetSegmentEffortStreamsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get segment effort streams params.

func (*GetSegmentEffortStreamsParams) SetID 

func (o *GetSegmentEffortStreamsParams) SetID(id int64)

SetID adds the id to the get segment effort streams params.

func (*GetSegmentEffortStreamsParams) SetKeyByType 

func (o *GetSegmentEffortStreamsParams) SetKeyByType(keyByType bool)

SetKeyByType adds the keyByType to the get segment effort streams params.

func (*GetSegmentEffortStreamsParams) SetKeys 

func (o *GetSegmentEffortStreamsParams) SetKeys(keys []string)

SetKeys adds the keys to the get segment effort streams params.

func (*GetSegmentEffortStreamsParams) SetTimeout 

func (o *GetSegmentEffortStreamsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get segment effort streams params.

func (*GetSegmentEffortStreamsParams) WithContext deprecated 

func (o *GetSegmentEffortStreamsParams) WithContext(ctx context.Context) *GetSegmentEffortStreamsParams

WithContext adds the context to the get segment effort streams params.

Deprecated: use the operation call with context to pass the context instead of GetSegmentEffortStreamsParams.

func (*GetSegmentEffortStreamsParams) WithDefaults 

func (o *GetSegmentEffortStreamsParams) WithDefaults() *GetSegmentEffortStreamsParams

WithDefaults hydrates default values in the get segment effort streams params (not the query body).

All values with no default are reset to their zero value.

func (*GetSegmentEffortStreamsParams) WithHTTPClient 

func (o *GetSegmentEffortStreamsParams) WithHTTPClient(client *http.Client) *GetSegmentEffortStreamsParams

WithHTTPClient adds the HTTPClient to the get segment effort streams params.

func (*GetSegmentEffortStreamsParams) WithID 

func (o *GetSegmentEffortStreamsParams) WithID(id int64) *GetSegmentEffortStreamsParams

WithID adds the id to the get segment effort streams params.

func (*GetSegmentEffortStreamsParams) WithKeyByType 

func (o *GetSegmentEffortStreamsParams) WithKeyByType(keyByType bool) *GetSegmentEffortStreamsParams

WithKeyByType adds the keyByType to the get segment effort streams params.

func (*GetSegmentEffortStreamsParams) WithKeys 

func (o *GetSegmentEffortStreamsParams) WithKeys(keys []string) *GetSegmentEffortStreamsParams

WithKeys adds the keys to the get segment effort streams params.

func (*GetSegmentEffortStreamsParams) WithTimeout 

func (o *GetSegmentEffortStreamsParams) WithTimeout(timeout time.Duration) *GetSegmentEffortStreamsParams

WithTimeout adds the timeout to the get segment effort streams params.

func (*GetSegmentEffortStreamsParams) WriteToRequest 

func (o *GetSegmentEffortStreamsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a runtime.ClientRequest.

type GetSegmentEffortStreamsReader 

type GetSegmentEffortStreamsReader struct {
	// contains filtered or unexported fields
}

GetSegmentEffortStreamsReader is a Reader for the GetSegmentEffortStreams structure.

func (*GetSegmentEffortStreamsReader) ReadResponse 

func (o *GetSegmentEffortStreamsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (any, error)

ReadResponse reads a server response into the received o.

type GetSegmentStreamsDefault 

type GetSegmentStreamsDefault struct {
	Payload *models.Fault
	// contains filtered or unexported fields
}

GetSegmentStreamsDefault describes a response with status code -1, with default header values.

Unexpected error.

func NewGetSegmentStreamsDefault 

func NewGetSegmentStreamsDefault(code int) *GetSegmentStreamsDefault

NewGetSegmentStreamsDefault creates a GetSegmentStreamsDefault with default headers values

func (*GetSegmentStreamsDefault) Code 

func (o *GetSegmentStreamsDefault) Code() int

Code gets the status code for the get segment streams default response

func (*GetSegmentStreamsDefault) Error 

func (o *GetSegmentStreamsDefault) Error() string

func (*GetSegmentStreamsDefault) GetPayload 

func (o *GetSegmentStreamsDefault) GetPayload() *models.Fault

func (*GetSegmentStreamsDefault) IsClientError 

func (o *GetSegmentStreamsDefault) IsClientError() bool

IsClientError returns true when this get segment streams default response has a 4xx status code

func (*GetSegmentStreamsDefault) IsCode 

func (o *GetSegmentStreamsDefault) IsCode(code int) bool

IsCode returns true when this get segment streams default response a status code equal to that given

func (*GetSegmentStreamsDefault) IsRedirect 

func (o *GetSegmentStreamsDefault) IsRedirect() bool

IsRedirect returns true when this get segment streams default response has a 3xx status code

func (*GetSegmentStreamsDefault) IsServerError 

func (o *GetSegmentStreamsDefault) IsServerError() bool

IsServerError returns true when this get segment streams default response has a 5xx status code

func (*GetSegmentStreamsDefault) IsSuccess 

func (o *GetSegmentStreamsDefault) IsSuccess() bool

IsSuccess returns true when this get segment streams default response has a 2xx status code

func (*GetSegmentStreamsDefault) String 

func (o *GetSegmentStreamsDefault) String() string

type GetSegmentStreamsOK 

type GetSegmentStreamsOK struct {
	Payload *models.StreamSet
}

GetSegmentStreamsOK describes a response with status code 200, with default header values.

The set of requested streams.

func NewGetSegmentStreamsOK 

func NewGetSegmentStreamsOK() *GetSegmentStreamsOK

NewGetSegmentStreamsOK creates a GetSegmentStreamsOK with default headers values

func (*GetSegmentStreamsOK) Code 

func (o *GetSegmentStreamsOK) Code() int

Code gets the status code for the get segment streams o k response

func (*GetSegmentStreamsOK) Error 

func (o *GetSegmentStreamsOK) Error() string

func (*GetSegmentStreamsOK) GetPayload 

func (o *GetSegmentStreamsOK) GetPayload() *models.StreamSet

func (*GetSegmentStreamsOK) IsClientError 

func (o *GetSegmentStreamsOK) IsClientError() bool

IsClientError returns true when this get segment streams o k response has a 4xx status code

func (*GetSegmentStreamsOK) IsCode 

func (o *GetSegmentStreamsOK) IsCode(code int) bool

IsCode returns true when this get segment streams o k response a status code equal to that given

func (*GetSegmentStreamsOK) IsRedirect 

func (o *GetSegmentStreamsOK) IsRedirect() bool

IsRedirect returns true when this get segment streams o k response has a 3xx status code

func (*GetSegmentStreamsOK) IsServerError 

func (o *GetSegmentStreamsOK) IsServerError() bool

IsServerError returns true when this get segment streams o k response has a 5xx status code

func (*GetSegmentStreamsOK) IsSuccess 

func (o *GetSegmentStreamsOK) IsSuccess() bool

IsSuccess returns true when this get segment streams o k response has a 2xx status code

func (*GetSegmentStreamsOK) String 

func (o *GetSegmentStreamsOK) String() string

type GetSegmentStreamsParams 

type GetSegmentStreamsParams struct {

	/* ID.

	   The identifier of the segment.

	   Format: int64
	*/
	ID int64

	/* KeyByType.

	   Must be true.

	   Default: true
	*/
	KeyByType bool

	/* Keys.

	   The types of streams to return.
	*/
	Keys []string

	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetSegmentStreamsParams contains all the parameters to send to the API endpoint 

for the get segment streams operation.

Typically these are written to a http.Request.

func NewGetSegmentStreamsParams 

func NewGetSegmentStreamsParams() *GetSegmentStreamsParams

NewGetSegmentStreamsParams creates a new GetSegmentStreamsParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetSegmentStreamsParamsWithContext deprecated 

func NewGetSegmentStreamsParamsWithContext(ctx context.Context) *GetSegmentStreamsParams

NewGetSegmentStreamsParamsWithContext creates a new GetSegmentStreamsParams object with the ability to set a context for a request.

Deprecated: use the operation call with context to pass the context instead of GetSegmentStreamsParams.

func NewGetSegmentStreamsParamsWithHTTPClient 

func NewGetSegmentStreamsParamsWithHTTPClient(client *http.Client) *GetSegmentStreamsParams

NewGetSegmentStreamsParamsWithHTTPClient creates a new GetSegmentStreamsParams object with the ability to set a custom HTTPClient for a request.

func NewGetSegmentStreamsParamsWithTimeout 

func NewGetSegmentStreamsParamsWithTimeout(timeout time.Duration) *GetSegmentStreamsParams

NewGetSegmentStreamsParamsWithTimeout creates a new GetSegmentStreamsParams object with the ability to set a timeout on a request.

func (*GetSegmentStreamsParams) SetContext deprecated 

func (o *GetSegmentStreamsParams) SetContext(ctx context.Context)

SetContext adds the context to the get segment streams params.

Deprecated: use the operation call with context to pass the context instead of GetSegmentStreamsParams.

func (*GetSegmentStreamsParams) SetDefaults 

func (o *GetSegmentStreamsParams) SetDefaults()

SetDefaults hydrates default values in the get segment streams params (not the query body).

All values with no default are reset to their zero value.

func (*GetSegmentStreamsParams) SetHTTPClient 

func (o *GetSegmentStreamsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get segment streams params.

func (*GetSegmentStreamsParams) SetID 

func (o *GetSegmentStreamsParams) SetID(id int64)

SetID adds the id to the get segment streams params.

func (*GetSegmentStreamsParams) SetKeyByType 

func (o *GetSegmentStreamsParams) SetKeyByType(keyByType bool)

SetKeyByType adds the keyByType to the get segment streams params.

func (*GetSegmentStreamsParams) SetKeys 

func (o *GetSegmentStreamsParams) SetKeys(keys []string)

SetKeys adds the keys to the get segment streams params.

func (*GetSegmentStreamsParams) SetTimeout 

func (o *GetSegmentStreamsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get segment streams params.

func (*GetSegmentStreamsParams) WithContext deprecated 

func (o *GetSegmentStreamsParams) WithContext(ctx context.Context) *GetSegmentStreamsParams

WithContext adds the context to the get segment streams params.

Deprecated: use the operation call with context to pass the context instead of GetSegmentStreamsParams.

func (*GetSegmentStreamsParams) WithDefaults 

func (o *GetSegmentStreamsParams) WithDefaults() *GetSegmentStreamsParams

WithDefaults hydrates default values in the get segment streams params (not the query body).

All values with no default are reset to their zero value.

func (*GetSegmentStreamsParams) WithHTTPClient 

func (o *GetSegmentStreamsParams) WithHTTPClient(client *http.Client) *GetSegmentStreamsParams

WithHTTPClient adds the HTTPClient to the get segment streams params.

func (*GetSegmentStreamsParams) WithID 

func (o *GetSegmentStreamsParams) WithID(id int64) *GetSegmentStreamsParams

WithID adds the id to the get segment streams params.

func (*GetSegmentStreamsParams) WithKeyByType 

func (o *GetSegmentStreamsParams) WithKeyByType(keyByType bool) *GetSegmentStreamsParams

WithKeyByType adds the keyByType to the get segment streams params.

func (*GetSegmentStreamsParams) WithKeys 

func (o *GetSegmentStreamsParams) WithKeys(keys []string) *GetSegmentStreamsParams

WithKeys adds the keys to the get segment streams params.

func (*GetSegmentStreamsParams) WithTimeout 

func (o *GetSegmentStreamsParams) WithTimeout(timeout time.Duration) *GetSegmentStreamsParams

WithTimeout adds the timeout to the get segment streams params.

func (*GetSegmentStreamsParams) WriteToRequest 

func (o *GetSegmentStreamsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a runtime.ClientRequest.

type GetSegmentStreamsReader 

type GetSegmentStreamsReader struct {
	// contains filtered or unexported fields
}

GetSegmentStreamsReader is a Reader for the GetSegmentStreams structure.

func (*GetSegmentStreamsReader) ReadResponse 

func (o *GetSegmentStreamsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (any, error)

ReadResponse reads a server response into the received o.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.