class MetricConfigResponse
Generated from protobuf message <code>opentelemetry.proto.metrics.experimental.MetricConfigResponse</code>
Hierarchy
- class \Google\Protobuf\Internal\Message
- class \Opentelemetry\Proto\Metrics\Experimental\MetricConfigResponse extends \Google\Protobuf\Internal\Message
Expanded class hierarchy of MetricConfigResponse
File
-
vendor/
open-telemetry/ gen-otlp-protobuf/ Opentelemetry/ Proto/ Metrics/ Experimental/ MetricConfigResponse.php, line 14
Namespace
Opentelemetry\Proto\Metrics\ExperimentalView source
class MetricConfigResponse extends \Google\Protobuf\Internal\Message {
/**
* Optional. The fingerprint associated with this MetricConfigResponse. Each
* change in configs yields a different fingerprint. The resource SHOULD copy
* this value to MetricConfigRequest.last_known_fingerprint for the next
* configuration request. If there are no changes between fingerprint and
* MetricConfigRequest.last_known_fingerprint, then all other fields besides
* fingerprint in the response are optional, or the same as the last update if
* present.
* The exact mechanics of generating the fingerprint is up to the
* implementation. However, a fingerprint must be deterministically determined
* by the configurations -- the same configuration will generate the same
* fingerprint on any instance of an implementation. Hence using a timestamp is
* unacceptable, but a deterministic hash is fine.
*
* Generated from protobuf field <code>bytes fingerprint = 1;</code>
*/
protected $fingerprint = '';
/**
* A single metric may match multiple schedules. In such cases, the schedule
* that specifies the smallest period is applied.
* Note, for optimization purposes, it is recommended to use as few schedules
* as possible to capture all required metric updates. Where you can be
* conservative, do take full advantage of the inclusion/exclusion patterns to
* capture as much of your targeted metrics.
*
* Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule schedules = 2;</code>
*/
private $schedules;
/**
* Optional. The client is suggested to wait this long (in seconds) before
* pinging the configuration service again.
*
* Generated from protobuf field <code>int32 suggested_wait_time_sec = 3;</code>
*/
protected $suggested_wait_time_sec = 0;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $fingerprint
* Optional. The fingerprint associated with this MetricConfigResponse. Each
* change in configs yields a different fingerprint. The resource SHOULD copy
* this value to MetricConfigRequest.last_known_fingerprint for the next
* configuration request. If there are no changes between fingerprint and
* MetricConfigRequest.last_known_fingerprint, then all other fields besides
* fingerprint in the response are optional, or the same as the last update if
* present.
* The exact mechanics of generating the fingerprint is up to the
* implementation. However, a fingerprint must be deterministically determined
* by the configurations -- the same configuration will generate the same
* fingerprint on any instance of an implementation. Hence using a timestamp is
* unacceptable, but a deterministic hash is fine.
* @type \Opentelemetry\Proto\Metrics\Experimental\MetricConfigResponse\Schedule[]|\Google\Protobuf\Internal\RepeatedField $schedules
* A single metric may match multiple schedules. In such cases, the schedule
* that specifies the smallest period is applied.
* Note, for optimization purposes, it is recommended to use as few schedules
* as possible to capture all required metric updates. Where you can be
* conservative, do take full advantage of the inclusion/exclusion patterns to
* capture as much of your targeted metrics.
* @type int $suggested_wait_time_sec
* Optional. The client is suggested to wait this long (in seconds) before
* pinging the configuration service again.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Opentelemetry\Proto\Metrics\Experimental\MetricsConfigService::initOnce();
parent::__construct($data);
}
/**
* Optional. The fingerprint associated with this MetricConfigResponse. Each
* change in configs yields a different fingerprint. The resource SHOULD copy
* this value to MetricConfigRequest.last_known_fingerprint for the next
* configuration request. If there are no changes between fingerprint and
* MetricConfigRequest.last_known_fingerprint, then all other fields besides
* fingerprint in the response are optional, or the same as the last update if
* present.
* The exact mechanics of generating the fingerprint is up to the
* implementation. However, a fingerprint must be deterministically determined
* by the configurations -- the same configuration will generate the same
* fingerprint on any instance of an implementation. Hence using a timestamp is
* unacceptable, but a deterministic hash is fine.
*
* Generated from protobuf field <code>bytes fingerprint = 1;</code>
* @return string
*/
public function getFingerprint() {
return $this->fingerprint;
}
/**
* Optional. The fingerprint associated with this MetricConfigResponse. Each
* change in configs yields a different fingerprint. The resource SHOULD copy
* this value to MetricConfigRequest.last_known_fingerprint for the next
* configuration request. If there are no changes between fingerprint and
* MetricConfigRequest.last_known_fingerprint, then all other fields besides
* fingerprint in the response are optional, or the same as the last update if
* present.
* The exact mechanics of generating the fingerprint is up to the
* implementation. However, a fingerprint must be deterministically determined
* by the configurations -- the same configuration will generate the same
* fingerprint on any instance of an implementation. Hence using a timestamp is
* unacceptable, but a deterministic hash is fine.
*
* Generated from protobuf field <code>bytes fingerprint = 1;</code>
* @param string $var
* @return $this
*/
public function setFingerprint($var) {
GPBUtil::checkString($var, False);
$this->fingerprint = $var;
return $this;
}
/**
* A single metric may match multiple schedules. In such cases, the schedule
* that specifies the smallest period is applied.
* Note, for optimization purposes, it is recommended to use as few schedules
* as possible to capture all required metric updates. Where you can be
* conservative, do take full advantage of the inclusion/exclusion patterns to
* capture as much of your targeted metrics.
*
* Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule schedules = 2;</code>
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getSchedules() {
return $this->schedules;
}
/**
* A single metric may match multiple schedules. In such cases, the schedule
* that specifies the smallest period is applied.
* Note, for optimization purposes, it is recommended to use as few schedules
* as possible to capture all required metric updates. Where you can be
* conservative, do take full advantage of the inclusion/exclusion patterns to
* capture as much of your targeted metrics.
*
* Generated from protobuf field <code>repeated .opentelemetry.proto.metrics.experimental.MetricConfigResponse.Schedule schedules = 2;</code>
* @param \Opentelemetry\Proto\Metrics\Experimental\MetricConfigResponse\Schedule[]|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setSchedules($var) {
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Opentelemetry\Proto\Metrics\Experimental\MetricConfigResponse\Schedule::class);
$this->schedules = $arr;
return $this;
}
/**
* Optional. The client is suggested to wait this long (in seconds) before
* pinging the configuration service again.
*
* Generated from protobuf field <code>int32 suggested_wait_time_sec = 3;</code>
* @return int
*/
public function getSuggestedWaitTimeSec() {
return $this->suggested_wait_time_sec;
}
/**
* Optional. The client is suggested to wait this long (in seconds) before
* pinging the configuration service again.
*
* Generated from protobuf field <code>int32 suggested_wait_time_sec = 3;</code>
* @param int $var
* @return $this
*/
public function setSuggestedWaitTimeSec($var) {
GPBUtil::checkInt32($var);
$this->suggested_wait_time_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 | ||
MetricConfigResponse::$fingerprint | protected | property | Optional. The fingerprint associated with this MetricConfigResponse. Each change in configs yields a different fingerprint. The resource SHOULD copy this value to MetricConfigRequest.last_known_fingerprint for the next configuration request. If there… |
|
MetricConfigResponse::$schedules | private | property | A single metric may match multiple schedules. In such cases, the schedule that specifies the smallest period is applied. Note, for optimization purposes, it is recommended to use as few schedules as possible to capture all required metric updates.… |
|
MetricConfigResponse::$suggested_wait_time_sec | protected | property | Optional. The client is suggested to wait this long (in seconds) before pinging the configuration service again. |
|
MetricConfigResponse::getFingerprint | public | function | Optional. The fingerprint associated with this MetricConfigResponse. Each change in configs yields a different fingerprint. The resource SHOULD copy this value to MetricConfigRequest.last_known_fingerprint for the next configuration request. If there… |
|
MetricConfigResponse::getSchedules | public | function | A single metric may match multiple schedules. In such cases, the schedule that specifies the smallest period is applied. Note, for optimization purposes, it is recommended to use as few schedules as possible to capture all required metric updates.… |
|
MetricConfigResponse::getSuggestedWaitTimeSec | public | function | Optional. The client is suggested to wait this long (in seconds) before pinging the configuration service again. |
|
MetricConfigResponse::setFingerprint | public | function | Optional. The fingerprint associated with this MetricConfigResponse. Each change in configs yields a different fingerprint. The resource SHOULD copy this value to MetricConfigRequest.last_known_fingerprint for the next configuration request. If there… |
|
MetricConfigResponse::setSchedules | public | function | A single metric may match multiple schedules. In such cases, the schedule that specifies the smallest period is applied. Note, for optimization purposes, it is recommended to use as few schedules as possible to capture all required metric updates.… |
|
MetricConfigResponse::setSuggestedWaitTimeSec | public | function | Optional. The client is suggested to wait this long (in seconds) before pinging the configuration service again. |
|
MetricConfigResponse::__construct | public | function | Constructor. | Overrides Message::__construct |