Interface Cluster

This Cluster supports an interface to a Node. It provides commands for retrieving unstructured diagnostic logs from a Node that may be used to aid in diagnostics. It will often be the case that unstructured diagnostic logs will be Node-wide and not specific to any subset of Endpoints. When present, this Cluster shall be implemented once for the Node. The Node SHOULD also implement the BDX Initiator and BDX Sender roles as defined in the BDX Protocol.

See

MatterSpecification.v13.Core § 11.11

interface Cluster {
    attributes: {};
    base: undefined;
    commands: {
        retrieveLogsRequest: Command<TypeFromFields<{
            intent: FieldType<DiagnosticLogs.Intent>;
            requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
            transferFileDesignator: OptionalFieldType<string>;
        }>, TypeFromFields<{
            logContent: FieldType<Uint8Array>;
            status: FieldType<DiagnosticLogs.Status>;
            timeSinceBoot: OptionalFieldType<number | bigint>;
            utcTimeStamp: OptionalFieldType<number | bigint>;
        }>, any>;
    };
    events: {};
    extensions: undefined;
    features: {};
    id: Branded<50, "ClusterId">;
    name: "DiagnosticLogs";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        commands: {
            retrieveLogsRequest: Command<TypeFromFields<{
                intent: FieldType<DiagnosticLogs.Intent>;
                requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
                transferFileDesignator: OptionalFieldType<string>;
            }>, TypeFromFields<{
                logContent: FieldType<Uint8Array>;
                status: FieldType<DiagnosticLogs.Status>;
                timeSinceBoot: OptionalFieldType<number | bigint>;
                utcTimeStamp: OptionalFieldType<number | bigint>;
            }>, any>;
        };
        id: 50;
        name: "DiagnosticLogs";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        commands: {
            retrieveLogsRequest: Command<TypeFromFields<{
                intent: FieldType<DiagnosticLogs.Intent>;
                requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
                transferFileDesignator: OptionalFieldType<string>;
            }>, TypeFromFields<{
                logContent: FieldType<Uint8Array>;
                status: FieldType<DiagnosticLogs.Status>;
                timeSinceBoot: OptionalFieldType<number | bigint>;
                utcTimeStamp: OptionalFieldType<number | bigint>;
            }>, any>;
        };
        id: 50;
        name: "DiagnosticLogs";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        commands: {
            retrieveLogsRequest: Command<TypeFromFields<{
                intent: FieldType<DiagnosticLogs.Intent>;
                requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
                transferFileDesignator: OptionalFieldType<string>;
            }>, TypeFromFields<{
                logContent: FieldType<Uint8Array>;
                status: FieldType<DiagnosticLogs.Status>;
                timeSinceBoot: OptionalFieldType<number | bigint>;
                utcTimeStamp: OptionalFieldType<number | bigint>;
            }>, any>;
        };
        id: 50;
        name: "DiagnosticLogs";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        commands: {
            retrieveLogsRequest: Command<TypeFromFields<{
                intent: FieldType<DiagnosticLogs.Intent>;
                requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
                transferFileDesignator: OptionalFieldType<string>;
            }>, TypeFromFields<{
                logContent: FieldType<Uint8Array>;
                status: FieldType<DiagnosticLogs.Status>;
                timeSinceBoot: OptionalFieldType<number | bigint>;
                utcTimeStamp: OptionalFieldType<number | bigint>;
            }>, any>;
        };
        id: 50;
        name: "DiagnosticLogs";
        revision: 1;
    }>, SelectionT>;
}

Hierarchy (view full)

Identity<typeof DiagnosticLogs.ClusterInstance>
- Cluster

Index

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: {}

base

base: undefined

commands

commands: {
    retrieveLogsRequest: Command<TypeFromFields<{
        intent: FieldType<DiagnosticLogs.Intent>;
        requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
        transferFileDesignator: OptionalFieldType<string>;
    }>, TypeFromFields<{
        logContent: FieldType<Uint8Array>;
        status: FieldType<DiagnosticLogs.Status>;
        timeSinceBoot: OptionalFieldType<number | bigint>;
        utcTimeStamp: OptionalFieldType<number | bigint>;
    }>, any>;
}

Type declaration

ReadonlyretrieveLogsRequest: Command<TypeFromFields<{
    intent: FieldType<DiagnosticLogs.Intent>;
    requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
    transferFileDesignator: OptionalFieldType<string>;
}>, TypeFromFields<{
    logContent: FieldType<Uint8Array>;
    status: FieldType<DiagnosticLogs.Status>;
    timeSinceBoot: OptionalFieldType<number | bigint>;
    utcTimeStamp: OptionalFieldType<number | bigint>;
}>, any>
Reception of this command starts the process of retrieving diagnostic logs from a Node.

See
MatterSpecification.v13.Core § 11.11.5.1

events

events: {}

extensions

extensions: undefined

features

features: {}

id

id: Branded<50, "ClusterId">

name

revision

supportedFeatures

supportedFeatures: {}

unknown

Methods

alter

alter<const AlterationsT>(alterations): WithAlterations<Of<{
    commands: {
        retrieveLogsRequest: Command<TypeFromFields<{
            intent: FieldType<DiagnosticLogs.Intent>;
            requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
            transferFileDesignator: OptionalFieldType<string>;
        }>, TypeFromFields<{
            logContent: FieldType<Uint8Array>;
            status: FieldType<DiagnosticLogs.Status>;
            timeSinceBoot: OptionalFieldType<number | bigint>;
            utcTimeStamp: OptionalFieldType<number | bigint>;
        }>, any>;
    };
    id: 50;
    name: "DiagnosticLogs";
    revision: 1;
}>, AlterationsT>
Modify elements using ElementModifier.alter.
Type Parameters
- const AlterationsT extends Alterations<Of<{
      commands: {
          retrieveLogsRequest: Command<TypeFromFields<{
              intent: FieldType<DiagnosticLogs.Intent>;
              requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
              transferFileDesignator: OptionalFieldType<string>;
          }>, TypeFromFields<{
              logContent: FieldType<Uint8Array>;
              status: FieldType<DiagnosticLogs.Status>;
              timeSinceBoot: OptionalFieldType<number | bigint>;
              utcTimeStamp: OptionalFieldType<number | bigint>;
          }>, any>;
      };
      id: 50;
      name: "DiagnosticLogs";
      revision: 1;
  }>>
Parameters
- alterations: AlterationsT
Returns WithAlterations<Of<{
    commands: {
        retrieveLogsRequest: Command<TypeFromFields<{
            intent: FieldType<DiagnosticLogs.Intent>;
            requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
            transferFileDesignator: OptionalFieldType<string>;
        }>, TypeFromFields<{
            logContent: FieldType<Uint8Array>;
            status: FieldType<DiagnosticLogs.Status>;
            timeSinceBoot: OptionalFieldType<number | bigint>;
            utcTimeStamp: OptionalFieldType<number | bigint>;
        }>, any>;
    };
    id: 50;
    name: "DiagnosticLogs";
    revision: 1;
}>, AlterationsT>
Inherited from Identity.alter
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:37

enable

enable<const FlagsT>(flags): WithFlags<Of<{
    commands: {
        retrieveLogsRequest: Command<TypeFromFields<{
            intent: FieldType<DiagnosticLogs.Intent>;
            requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
            transferFileDesignator: OptionalFieldType<string>;
        }>, TypeFromFields<{
            logContent: FieldType<Uint8Array>;
            status: FieldType<DiagnosticLogs.Status>;
            timeSinceBoot: OptionalFieldType<number | bigint>;
            utcTimeStamp: OptionalFieldType<number | bigint>;
        }>, any>;
    };
    id: 50;
    name: "DiagnosticLogs";
    revision: 1;
}>, FlagsT>
Modify elements using ElementModifier.enable.
Type Parameters
- const FlagsT extends ElementFlags<Of<{
      commands: {
          retrieveLogsRequest: Command<TypeFromFields<{
              intent: FieldType<DiagnosticLogs.Intent>;
              requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
              transferFileDesignator: OptionalFieldType<string>;
          }>, TypeFromFields<{
              logContent: FieldType<Uint8Array>;
              status: FieldType<DiagnosticLogs.Status>;
              timeSinceBoot: OptionalFieldType<number | bigint>;
              utcTimeStamp: OptionalFieldType<number | bigint>;
          }>, any>;
      };
      id: 50;
      name: "DiagnosticLogs";
      revision: 1;
  }>>
Parameters
- flags: FlagsT
Returns WithFlags<Of<{
    commands: {
        retrieveLogsRequest: Command<TypeFromFields<{
            intent: FieldType<DiagnosticLogs.Intent>;
            requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
            transferFileDesignator: OptionalFieldType<string>;
        }>, TypeFromFields<{
            logContent: FieldType<Uint8Array>;
            status: FieldType<DiagnosticLogs.Status>;
            timeSinceBoot: OptionalFieldType<number | bigint>;
            utcTimeStamp: OptionalFieldType<number | bigint>;
        }>, any>;
    };
    id: 50;
    name: "DiagnosticLogs";
    revision: 1;
}>, FlagsT>
Inherited from Identity.enable
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:45

set

set<const ValuesT>(values): WithValues<Of<{
    commands: {
        retrieveLogsRequest: Command<TypeFromFields<{
            intent: FieldType<DiagnosticLogs.Intent>;
            requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
            transferFileDesignator: OptionalFieldType<string>;
        }>, TypeFromFields<{
            logContent: FieldType<Uint8Array>;
            status: FieldType<DiagnosticLogs.Status>;
            timeSinceBoot: OptionalFieldType<number | bigint>;
            utcTimeStamp: OptionalFieldType<number | bigint>;
        }>, any>;
    };
    id: 50;
    name: "DiagnosticLogs";
    revision: 1;
}>, ValuesT>
Modify elements using ElementModifier.set.
Type Parameters
- const ValuesT extends {}
Parameters
- values: ValuesT
Returns WithValues<Of<{
    commands: {
        retrieveLogsRequest: Command<TypeFromFields<{
            intent: FieldType<DiagnosticLogs.Intent>;
            requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
            transferFileDesignator: OptionalFieldType<string>;
        }>, TypeFromFields<{
            logContent: FieldType<Uint8Array>;
            status: FieldType<DiagnosticLogs.Status>;
            timeSinceBoot: OptionalFieldType<number | bigint>;
            utcTimeStamp: OptionalFieldType<number | bigint>;
        }>, any>;
    };
    id: 50;
    name: "DiagnosticLogs";
    revision: 1;
}>, ValuesT>
Inherited from Identity.set
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:41

with

with<const SelectionT>(...selection): Of<Of<{
    commands: {
        retrieveLogsRequest: Command<TypeFromFields<{
            intent: FieldType<DiagnosticLogs.Intent>;
            requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
            transferFileDesignator: OptionalFieldType<string>;
        }>, TypeFromFields<{
            logContent: FieldType<Uint8Array>;
            status: FieldType<DiagnosticLogs.Status>;
            timeSinceBoot: OptionalFieldType<number | bigint>;
            utcTimeStamp: OptionalFieldType<number | bigint>;
        }>, any>;
    };
    id: 50;
    name: "DiagnosticLogs";
    revision: 1;
}>, SelectionT>
Select features using ClusterComposer.compose.
Type Parameters
- const SelectionT extends FeatureSelection<Of<{
      commands: {
          retrieveLogsRequest: Command<TypeFromFields<{
              intent: FieldType<DiagnosticLogs.Intent>;
              requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
              transferFileDesignator: OptionalFieldType<string>;
          }>, TypeFromFields<{
              logContent: FieldType<Uint8Array>;
              status: FieldType<DiagnosticLogs.Status>;
              timeSinceBoot: OptionalFieldType<number | bigint>;
              utcTimeStamp: OptionalFieldType<number | bigint>;
          }>, any>;
      };
      id: 50;
      name: "DiagnosticLogs";
      revision: 1;
  }>>
Parameters
- Rest...selection: SelectionT
Returns Of<Of<{
    commands: {
        retrieveLogsRequest: Command<TypeFromFields<{
            intent: FieldType<DiagnosticLogs.Intent>;
            requestedProtocol: FieldType<DiagnosticLogs.TransferProtocol>;
            transferFileDesignator: OptionalFieldType<string>;
        }>, TypeFromFields<{
            logContent: FieldType<Uint8Array>;
            status: FieldType<DiagnosticLogs.Status>;
            timeSinceBoot: OptionalFieldType<number | bigint>;
            utcTimeStamp: OptionalFieldType<number | bigint>;
        }>, any>;
    };
    id: 50;
    name: "DiagnosticLogs";
    revision: 1;
}>, SelectionT>
Inherited from Identity.with
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:33

Interface Cluster

See

Hierarchy (view full)

Index

Properties

Methods

Properties

attributes

base

commands

Type declaration

See

events

extensions

features

id

name

revision

supportedFeatures

unknown

Methods

alter

Type Parameters

Parameters

enable

Type Parameters

Parameters

set

Type Parameters

Parameters

with

Type Parameters

Parameters

Settings

On This Page