Represents information regarding an operation.

Generated from protobuf message google.api.servicecontrol.v1.Operation

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 

Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::clear()
     

    Clear all containing fields.

    • return
    public Google\Protobuf\Internal\Message::discardUnknownFields()
     

    Clear all unknown fields previously parsed.

    • return
    public getConsumerId()
     

    Identity of the consumer who is using the service.

    This field should be filled in for the operations initiated by a
    consumer, but not for service-initiated operations that are
    not related to a specific consumer.
    This can be in one of the following formats:
    project:,
    project_number:,
    api_key:.

    Generated from protobuf field string consumer_id = 3;

    • return string
    public getEndTime()
     

    End time of the operation.

    Required when the operation is used in
    [ServiceController.Report][google.api.servicecontrol.v1.ServiceController.Report],
    but optional when the operation is used in
    [ServiceController.Check][google.api.servicecontrol.v1.ServiceController.Check].

    Generated from protobuf field .google.protobuf.Timestamp end_time = 5;

    public getImportance()
     

    DO NOT USE. This is an experimental field.

    Generated from protobuf field .google.api.servicecontrol.v1.Operation.Importance importance = 11;

    • return int
    public getLabels()
     

    Labels describing the operation. Only the following labels are allowed:

    • Labels describing monitored resources as defined in
      the service configuration.
    • Default labels of metric values. When specified, labels defined in the
      metric value override these default.
    • The following labels defined by Google Cloud Platform:
      • cloud.googleapis.com/location describing the location where the
        operation happened,
      • servicecontrol.googleapis.com/user_agent describing the user agent
        of the API request,
      • servicecontrol.googleapis.com/service_agent describing the service
        used to handle the API request (e.g. ESP),
      • servicecontrol.googleapis.com/platform describing the platform
        where the API is served (e.g. GAE, GCE, GKE).

    Generated from protobuf field map<string, string> labels = 6;

    public getLogEntries()
     

    Represents information to be logged.

    Generated from protobuf field repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

    public getMetricValueSets()
     

    Represents information about this operation. Each MetricValueSet
    corresponds to a metric defined in the service configuration.

    The data type used in the MetricValueSet must agree with
    the data type specified in the metric definition.
    Within a single operation, it is not allowed to have more than one
    MetricValue instances that have the same metric names and identical
    label value combinations. If a request has such duplicated MetricValue
    instances, the entire request is rejected with
    an invalid argument error.

    Generated from protobuf field repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

    public getOperationId()
     

    Identity of the operation. This must be unique within the scope of the
    service that generated the operation. If the service calls
    Check() and Report() on the same operation, the two calls should carry
    the same id.

    UUID version 4 is recommended, though not required.
    In scenarios where an operation is computed from existing information
    and an idempotent id is desirable for deduplication purpose, UUID version 5
    is recommended. See RFC 4122 for details.

    Generated from protobuf field string operation_id = 1;

    • return string
    public getOperationName()
     

    Fully qualified name of the operation. Reserved for future use.

    Generated from protobuf field string operation_name = 2;

    • return string
    public getStartTime()
     

    Required. Start time of the operation.

    Generated from protobuf field .google.protobuf.Timestamp start_time = 4;

    public Google\Protobuf\Internal\Message::jsonByteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
     

    Merges the contents of the specified message into current message.

    This method merges the contents of the specified message into the
    current message. Singular fields that are set in the specified message
    overwrite the corresponding fields in the current message. Repeated
    fields are appended. Map fields key-value pairs are overwritten.
    Singular/Oneof sub-messages are recursively merged. All overwritten
    sub-messages are deep-copied.

    • return
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
     

    Parses a json string to protobuf message.

    This function takes a string in the json wire format, matching the
    encoding output by serializeToJsonString().
    See mergeFrom() for merging behavior, if the field is already set in the
    specified message.

    • return
    • throws Exception Invalid data.
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
     

    Parses a protocol buffer contained in a string.

    This function takes a string in the (non-human-readable) binary wire
    format, matching the encoding output by serializeToString().
    See mergeFrom() for merging behavior, if the field is already set in the
    specified message.

    • return
    • throws Exception Invalid data.
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
     
    • ignore
    public Google\Protobuf\Internal\Message::parseFromStream( $input)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonString()
     

    Serialize the message to json string.

    • return string Serialized json protobuf data.
    public Google\Protobuf\Internal\Message::serializeToStream( $output)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToString()
     

    Serialize the message to string.

    • return string Serialized binary protobuf data.
    public setConsumerId( $var)
     

    Identity of the consumer who is using the service.

    This field should be filled in for the operations initiated by a
    consumer, but not for service-initiated operations that are
    not related to a specific consumer.
    This can be in one of the following formats:
    project:,
    project_number:,
    api_key:.

    Generated from protobuf field string consumer_id = 3;

    • return $this
    public setEndTime( $var)
     

    End time of the operation.

    Required when the operation is used in
    [ServiceController.Report][google.api.servicecontrol.v1.ServiceController.Report],
    but optional when the operation is used in
    [ServiceController.Check][google.api.servicecontrol.v1.ServiceController.Check].

    Generated from protobuf field .google.protobuf.Timestamp end_time = 5;

    • return $this
    public setImportance( $var)
     

    DO NOT USE. This is an experimental field.

    Generated from protobuf field .google.api.servicecontrol.v1.Operation.Importance importance = 11;

    • return $this
    public setLabels( $var)
     

    Labels describing the operation. Only the following labels are allowed:

    • Labels describing monitored resources as defined in
      the service configuration.
    • Default labels of metric values. When specified, labels defined in the
      metric value override these default.
    • The following labels defined by Google Cloud Platform:
      • cloud.googleapis.com/location describing the location where the
        operation happened,
      • servicecontrol.googleapis.com/user_agent describing the user agent
        of the API request,
      • servicecontrol.googleapis.com/service_agent describing the service
        used to handle the API request (e.g. ESP),
      • servicecontrol.googleapis.com/platform describing the platform
        where the API is served (e.g. GAE, GCE, GKE).

    Generated from protobuf field map<string, string> labels = 6;

    • return $this
    public setLogEntries( $var)
     

    Represents information to be logged.

    Generated from protobuf field repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

    • return $this
    public setMetricValueSets( $var)
     

    Represents information about this operation. Each MetricValueSet
    corresponds to a metric defined in the service configuration.

    The data type used in the MetricValueSet must agree with
    the data type specified in the metric definition.
    Within a single operation, it is not allowed to have more than one
    MetricValue instances that have the same metric names and identical
    label value combinations. If a request has such duplicated MetricValue
    instances, the entire request is rejected with
    an invalid argument error.

    Generated from protobuf field repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

    • return $this
    public setOperationId( $var)
     

    Identity of the operation. This must be unique within the scope of the
    service that generated the operation. If the service calls
    Check() and Report() on the same operation, the two calls should carry
    the same id.

    UUID version 4 is recommended, though not required.
    In scenarios where an operation is computed from existing information
    and an idempotent id is desirable for deduplication purpose, UUID version 5
    is recommended. See RFC 4122 for details.

    Generated from protobuf field string operation_id = 1;

    • return $this
    public setOperationName( $var)
     

    Fully qualified name of the operation. Reserved for future use.

    Generated from protobuf field string operation_name = 2;

    • return $this
    public setStartTime( $var)
     

    Required. Start time of the operation.

    Generated from protobuf field .google.protobuf.Timestamp start_time = 4;

    • return $this
    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
     

    Populates the message from a user-supplied PHP array. Array keys
    correspond to Message properties and nested message properties.

    Example:

    $message->mergeFromArray([
        'name' => 'This is a message name',
        'interval' => [
             'startTime' => time() - 60,
             'endTime' => time(),
        ]
    ]);
    

    This method will trigger an error if it is passed data that cannot
    be converted to the correct type. For example, a StringValue field
    must receive data that is either a string or a StringValue object.

    • return
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
    protected Google\Protobuf\Internal\Message::readOneof( $number)
    protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
    protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
    protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
    protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
    Properties
    private $consumer_id
     

    Identity of the consumer who is using the service.

    This field should be filled in for the operations initiated by a
    consumer, but not for service-initiated operations that are
    not related to a specific consumer.
    This can be in one of the following formats:
    project:,
    project_number:,
    api_key:.

    Generated from protobuf field string consumer_id = 3;

    private $end_time
     

    End time of the operation.

    Required when the operation is used in
    [ServiceController.Report][google.api.servicecontrol.v1.ServiceController.Report],
    but optional when the operation is used in
    [ServiceController.Check][google.api.servicecontrol.v1.ServiceController.Check].

    Generated from protobuf field .google.protobuf.Timestamp end_time = 5;

    private $importance
     

    DO NOT USE. This is an experimental field.

    Generated from protobuf field .google.api.servicecontrol.v1.Operation.Importance importance = 11;

    private $labels
     

    Labels describing the operation. Only the following labels are allowed:

    • Labels describing monitored resources as defined in
      the service configuration.
    • Default labels of metric values. When specified, labels defined in the
      metric value override these default.
    • The following labels defined by Google Cloud Platform:
      • cloud.googleapis.com/location describing the location where the
        operation happened,
      • servicecontrol.googleapis.com/user_agent describing the user agent
        of the API request,
      • servicecontrol.googleapis.com/service_agent describing the service
        used to handle the API request (e.g. ESP),
      • servicecontrol.googleapis.com/platform describing the platform
        where the API is served (e.g. GAE, GCE, GKE).

    Generated from protobuf field map<string, string> labels = 6;

    private $log_entries
     

    Represents information to be logged.

    Generated from protobuf field repeated .google.api.servicecontrol.v1.LogEntry log_entries = 8;

    private $metric_value_sets
     

    Represents information about this operation. Each MetricValueSet
    corresponds to a metric defined in the service configuration.

    The data type used in the MetricValueSet must agree with
    the data type specified in the metric definition.
    Within a single operation, it is not allowed to have more than one
    MetricValue instances that have the same metric names and identical
    label value combinations. If a request has such duplicated MetricValue
    instances, the entire request is rejected with
    an invalid argument error.

    Generated from protobuf field repeated .google.api.servicecontrol.v1.MetricValueSet metric_value_sets = 7;

    private $operation_id
     

    Identity of the operation. This must be unique within the scope of the
    service that generated the operation. If the service calls
    Check() and Report() on the same operation, the two calls should carry
    the same id.

    UUID version 4 is recommended, though not required.
    In scenarios where an operation is computed from existing information
    and an idempotent id is desirable for deduplication purpose, UUID version 5
    is recommended. See RFC 4122 for details.

    Generated from protobuf field string operation_id = 1;

    private $operation_name
     

    Fully qualified name of the operation. Reserved for future use.

    Generated from protobuf field string operation_name = 2;

    private $start_time
     

    Required. Start time of the operation.

    Generated from protobuf field .google.protobuf.Timestamp start_time = 4;

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $ignore_unknown, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     
    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array, $ignore_unknown)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     

    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 each element and
    try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       

      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.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         
        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         
        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         
        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         

        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 each element and
        try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           

          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.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             
            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only