restconf_monitoring

package
v0.0.0-...-50def94 Latest Latest
Warning

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

Go to latest
Published: Nov 2, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

This module contains monitoring information for the RESTCONF protocol.

Copyright (c) 2016 IETF Trust and the persons identified as authors of the code. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info).

This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type RestconfState

type RestconfState struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Contains a list of protocol capability URIs.
	Capabilities RestconfState_Capabilities

	// Container representing the notification event streams supported by the
	// server.
	Streams RestconfState_Streams
}

RestconfState Contains RESTCONF protocol monitoring information.

func (*RestconfState) GetEntityData

func (restconfState *RestconfState) GetEntityData() *types.CommonEntityData

type RestconfState_Capabilities

type RestconfState_Capabilities struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// A RESTCONF protocol capability URI. The type is slice of string.
	Capability []interface{}
}

RestconfState_Capabilities Contains a list of protocol capability URIs

func (*RestconfState_Capabilities) GetEntityData

func (capabilities *RestconfState_Capabilities) GetEntityData() *types.CommonEntityData

type RestconfState_Streams

type RestconfState_Streams struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Each entry describes an event stream supported by the server. The type is
	// slice of RestconfState_Streams_Stream.
	Stream []*RestconfState_Streams_Stream
}

RestconfState_Streams Container representing the notification event streams supported by the server.

func (*RestconfState_Streams) GetEntityData

func (streams *RestconfState_Streams) GetEntityData() *types.CommonEntityData

type RestconfState_Streams_Stream

type RestconfState_Streams_Stream struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. The stream name. The type is string.
	Name interface{}

	// Description of stream content. The type is string.
	Description interface{}

	// Indicates if replay buffer supported for this stream. If 'true', then the
	// server MUST support the 'start-time' and 'stop-time' query parameters for
	// this stream. The type is bool. The default value is false.
	ReplaySupport interface{}

	// Indicates the time the replay log for this stream was created. The type is
	// string with pattern:
	// \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-]\d{2}:\d{2}).
	ReplayLogCreationTime interface{}

	// The server will create an entry in this list for each encoding format that
	// is supported for this stream. The media type 'text/event-stream' is
	// expected for all event streams. This list identifies the sub-types
	// supported for this stream. The type is slice of
	// RestconfState_Streams_Stream_Access.
	Access []*RestconfState_Streams_Stream_Access
}

RestconfState_Streams_Stream Each entry describes an event stream supported by the server.

func (*RestconfState_Streams_Stream) GetEntityData

func (stream *RestconfState_Streams_Stream) GetEntityData() *types.CommonEntityData

type RestconfState_Streams_Stream_Access

type RestconfState_Streams_Stream_Access struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. This is the secondary encoding format within the
	// 'text/event-stream' encoding used by all streams. The type 'xml' is
	// supported for XML encoding. The type 'json' is supported for JSON encoding.
	// The type is string.
	Encoding interface{}

	// Contains a URL that represents the entry point for establishing
	// notification delivery via server sent events. The type is string. This
	// attribute is mandatory.
	Location interface{}
}

RestconfState_Streams_Stream_Access The server will create an entry in this list for each encoding format that is supported for this stream. The media type 'text/event-stream' is expected for all event streams. This list identifies the sub-types supported for this stream.

func (*RestconfState_Streams_Stream_Access) GetEntityData

Jump to

Keyboard shortcuts

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