PHPFUI/InstaDoc

A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items.

display_name: Activity labels: - key: /customer_id description: Identifier of a library customer

Generated from protobuf message google.api.LogDescriptor

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type string $name
      The name of the log. It must be less than 512 characters long and can
      include the following characters: upper- and lower-case alphanumeric
      characters [A-Za-z0-9], and punctuation characters including
      slash, underscore, hyphen, period [/_-.].
@type array<\Google\Api\LabelDescriptor>|\Google\Protobuf\Internal\RepeatedField $labels
      The set of labels that are available to describe a specific log entry.
      Runtime requests that contain labels not specified here are
      considered invalid.
@type string $description
      A human-readable description of this log. This information appears in
      the documentation and can contain details.
@type string $display_name
      The human-readable name for this log. This information appears on
      the user interface and should be concise.

}

public Google\Protobuf\Internal\Message::__debugInfo()

public Google\Protobuf\Internal\Message::byteSize()

ignore

public Google\Protobuf\Internal\Message::clear()

Clear all containing fields.

return null

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

Clear all unknown fields previously parsed.

return null

public getDescription()

A human-readable description of this log. This information appears in the documentation and can contain details.

Generated from protobuf field string description = 3;

return string

public getDisplayName()

The human-readable name for this log. This information appears on the user interface and should be concise.

Generated from protobuf field string display_name = 4;

return string

public getLabels()

The set of labels that are available to describe a specific log entry.

Runtime requests that contain labels not specified here are considered invalid.

Generated from protobuf field repeated .google.api.LabelDescriptor labels = 2;

return \Google\Protobuf\Internal\RepeatedField

public getName()

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

Generated from protobuf field string name = 1;

return string

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

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.

param object $msg Protobuf message to be merged from.
return null

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.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
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.

param string $data Binary protobuf data.
return null
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( $options = 0)

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 setDescription( $var)

A human-readable description of this log. This information appears in the documentation and can contain details.

Generated from protobuf field string description = 3;

param string $var
return $this

public setDisplayName( $var)

The human-readable name for this log. This information appears on the user interface and should be concise.

Generated from protobuf field string display_name = 4;

param string $var
return $this

public setLabels( $var)

The set of labels that are available to describe a specific log entry.

Runtime requests that contain labels not specified here are considered invalid.

Generated from protobuf field repeated .google.api.LabelDescriptor labels = 2;

param \Google\Api\LabelDescriptor[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

public setName( $var)

Generated from protobuf field string name = 1;

param string $var
return $this

Properties

protected $description = ''

A human-readable description of this log. This information appears in the documentation and can contain details.

Generated from protobuf field string description = 3;

protected $display_name = ''

The human-readable name for this log. This information appears on the user interface and should be concise.

Generated from protobuf field string display_name = 4;

protected $name = ''

Generated from protobuf field string name = 1;

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

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.

param array $array An array containing message properties and values.
return null

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 $labels = NULL

The set of labels that are available to describe a specific log entry.

Runtime requests that contain labels not specified here are considered invalid.

Generated from protobuf field repeated .google.api.LabelDescriptor labels = 2;