class Schedule
A Schedule is used to apply a particular scheduling configuration to a metric. If a metric name matches a schedule's patterns, then the metric adopts the configuration specified by the schedule.
Generated from protobuf message <code>opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule</code>
Hierarchy
- class \Google\Protobuf\Internal\Message
- class \Opentelemetry\Proto\Metrics\Experimental\MetricConfigResponse\Schedule extends \Google\Protobuf\Internal\Message
Expanded class hierarchy of Schedule
File
-
vendor/
open-telemetry/ gen-otlp-protobuf/ Opentelemetry/ Proto/ Metrics/ Experimental/ MetricConfigResponse/ Schedule.php, line 18
Namespace
Opentelemetry\Proto\Metrics\Experimental\MetricConfigResponseView source
class Schedule extends \Google\Protobuf\Internal\Message {
/**
* Metrics with names that match a rule in the inclusion_patterns are
* targeted by this schedule. Metrics that match the exclusion_patterns
* are not targeted for this schedule, even if they match an inclusion
* pattern.
*
* Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule.Pattern exclusion_patterns = 1;</code>
*/
private $exclusion_patterns;
/**
* Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule.Pattern inclusion_patterns = 2;</code>
*/
private $inclusion_patterns;
/**
* Describes the collection period for each metric in seconds.
* A period of 0 means to not export.
*
* Generated from protobuf field <code>int32 period_sec = 3;</code>
*/
protected $period_sec = 0;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type \Opentelemetry\Proto\Metrics\Experimental\MetricConfigResponse\Schedule\Pattern[]|\Google\Protobuf\Internal\RepeatedField $exclusion_patterns
* Metrics with names that match a rule in the inclusion_patterns are
* targeted by this schedule. Metrics that match the exclusion_patterns
* are not targeted for this schedule, even if they match an inclusion
* pattern.
* @type \Opentelemetry\Proto\Metrics\Experimental\MetricConfigResponse\Schedule\Pattern[]|\Google\Protobuf\Internal\RepeatedField $inclusion_patterns
* @type int $period_sec
* Describes the collection period for each metric in seconds.
* A period of 0 means to not export.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Opentelemetry\Proto\Metrics\Experimental\MetricsConfigService::initOnce();
parent::__construct($data);
}
/**
* Metrics with names that match a rule in the inclusion_patterns are
* targeted by this schedule. Metrics that match the exclusion_patterns
* are not targeted for this schedule, even if they match an inclusion
* pattern.
*
* Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule.Pattern exclusion_patterns = 1;</code>
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getExclusionPatterns() {
return $this->exclusion_patterns;
}
/**
* Metrics with names that match a rule in the inclusion_patterns are
* targeted by this schedule. Metrics that match the exclusion_patterns
* are not targeted for this schedule, even if they match an inclusion
* pattern.
*
* Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule.Pattern exclusion_patterns = 1;</code>
* @param \Opentelemetry\Proto\Metrics\Experimental\MetricConfigResponse\Schedule\Pattern[]|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setExclusionPatterns($var) {
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Opentelemetry\Proto\Metrics\Experimental\MetricConfigResponse\Schedule\Pattern::class);
$this->exclusion_patterns = $arr;
return $this;
}
/**
* Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule.Pattern inclusion_patterns = 2;</code>
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getInclusionPatterns() {
return $this->inclusion_patterns;
}
/**
* Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule.Pattern inclusion_patterns = 2;</code>
* @param \Opentelemetry\Proto\Metrics\Experimental\MetricConfigResponse\Schedule\Pattern[]|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setInclusionPatterns($var) {
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Opentelemetry\Proto\Metrics\Experimental\MetricConfigResponse\Schedule\Pattern::class);
$this->inclusion_patterns = $arr;
return $this;
}
/**
* Describes the collection period for each metric in seconds.
* A period of 0 means to not export.
*
* Generated from protobuf field <code>int32 period_sec = 3;</code>
* @return int
*/
public function getPeriodSec() {
return $this->period_sec;
}
/**
* Describes the collection period for each metric in seconds.
* A period of 0 means to not export.
*
* Generated from protobuf field <code>int32 period_sec = 3;</code>
* @param int $var
* @return $this
*/
public function setPeriodSec($var) {
GPBUtil::checkInt32($var);
$this->period_sec = $var;
return $this;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
Message::$desc | private | property | @ignore | |
Message::$unknown | private | property | ||
Message::appendHelper | private | function | ||
Message::byteSize | public | function | @ignore | |
Message::clear | public | function | Clear all containing fields. | |
Message::convertJsonValueToProtoValue | private | function | ||
Message::defaultValue | private | function | @ignore | |
Message::discardUnknownFields | public | function | Clear all unknown fields previously parsed. | |
Message::existField | private | function | @ignore | |
Message::fieldByteSize | private | function | @ignore | |
Message::fieldDataOnlyByteSize | private | function | @ignore | |
Message::fieldDataOnlyJsonByteSize | private | function | @ignore | |
Message::fieldJsonByteSize | private | function | @ignore | |
Message::hasOneof | protected | function | ||
Message::initWithDescriptor | private | function | @ignore | |
Message::initWithGeneratedPool | private | function | @ignore | |
Message::jsonByteSize | public | function | @ignore | |
Message::kvUpdateHelper | private | function | ||
Message::mergeFrom | public | function | Merges the contents of the specified message into current message. | |
Message::mergeFromArray | protected | function | Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties. |
|
Message::mergeFromArrayJsonImpl | private | function | ||
Message::mergeFromJsonArray | protected | function | ||
Message::mergeFromJsonString | public | function | Parses a json string to protobuf message. | |
Message::mergeFromString | public | function | Parses a protocol buffer contained in a string. | |
Message::normalizeArrayElementsToMessageType | private static | function | Tries to normalize the elements in $value into a provided protobuf wrapper type $class. If $value is any type other than array, we do not do any conversion, and instead rely on the existing protobuf type checking. If $value is an array, we process… |
|
Message::normalizeToMessageType | private static | function | Tries to normalize $value into a provided protobuf wrapper type $class. If $value is any type other than an object, we attempt to construct an instance of $class and assign $value to it using the setValue method shared by all wrapper types. |
|
Message::parseFieldFromStream | private | function | @ignore | |
Message::parseFieldFromStreamNoTag | private static | function | @ignore | |
Message::parseFromJsonStream | public | function | @ignore | |
Message::parseFromStream | public | function | @ignore | |
Message::readOneof | protected | function | ||
Message::readWrapperValue | protected | function | ||
Message::repeatedFieldDataOnlyByteSize | private | function | @ignore | |
Message::serializeFieldToJsonStream | private | function | @ignore | |
Message::serializeFieldToStream | private | function | @ignore | |
Message::serializeMapFieldToStream | private | function | @ignore | |
Message::serializeRepeatedFieldToStream | private | function | @ignore | |
Message::serializeSingularFieldToStream | private | function | @ignore | |
Message::serializeToJsonStream | public | function | @ignore | |
Message::serializeToJsonString | public | function | Serialize the message to json string. | |
Message::serializeToStream | public | function | @ignore | |
Message::serializeToString | public | function | Serialize the message to string. | |
Message::skipField | private | function | @ignore | |
Message::whichOneof | protected | function | ||
Message::writeOneof | protected | function | ||
Message::writeWrapperValue | protected | function | ||
Message::__debugInfo | public | function | ||
Schedule::$exclusion_patterns | private | property | Metrics with names that match a rule in the inclusion_patterns are targeted by this schedule. Metrics that match the exclusion_patterns are not targeted for this schedule, even if they match an inclusion pattern. |
|
Schedule::$inclusion_patterns | private | property | Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule.Pattern inclusion_patterns = 2;</code> | |
Schedule::$period_sec | protected | property | Describes the collection period for each metric in seconds. A period of 0 means to not export. |
|
Schedule::getExclusionPatterns | public | function | Metrics with names that match a rule in the inclusion_patterns are targeted by this schedule. Metrics that match the exclusion_patterns are not targeted for this schedule, even if they match an inclusion pattern. |
|
Schedule::getInclusionPatterns | public | function | Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule.Pattern inclusion_patterns = 2;</code> | |
Schedule::getPeriodSec | public | function | Describes the collection period for each metric in seconds. A period of 0 means to not export. |
|
Schedule::setExclusionPatterns | public | function | Metrics with names that match a rule in the inclusion_patterns are targeted by this schedule. Metrics that match the exclusion_patterns are not targeted for this schedule, even if they match an inclusion pattern. |
|
Schedule::setInclusionPatterns | public | function | Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule.Pattern inclusion_patterns = 2;</code> | |
Schedule::setPeriodSec | public | function | Describes the collection period for each metric in seconds. A period of 0 means to not export. |
|
Schedule::__construct | public | function | Constructor. | Overrides Message::__construct |