PHPFUI/InstaDoc

A message type used to describe a single precondition failure.

Generated from protobuf message google.rpc.PreconditionFailure.Violation

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Public
Protected

Methods

public __construct( $data = NULL)

Constructor.

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

@type string $type
      The type of PreconditionFailure. We recommend using a service-specific
      enum type to define the supported precondition violation subjects. For
      example, "TOS" for "Terms of Service violation".
@type string $subject
      The subject, relative to the type, that failed.
      For example, "google.com/cloud" relative to the "TOS" type would indicate
      which terms of service is being referenced.
@type string $description
      A description of how the precondition failed. Developers can use this
      description to understand how to fix the failure.
      For example: "Terms of service not accepted".

}

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 description of how the precondition failed. Developers can use this description to understand how to fix the failure.

For example: "Terms of service not accepted".

Generated from protobuf field string description = 3;

return string

public getSubject()

The subject, relative to the type, that failed.

For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.

Generated from protobuf field string subject = 2;

return string

public getType()

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".

Generated from protobuf field string type = 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 description of how the precondition failed. Developers can use this description to understand how to fix the failure.

For example: "Terms of service not accepted".

Generated from protobuf field string description = 3;

param string $var
return $this

public setSubject( $var)

The subject, relative to the type, that failed.

For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.

Generated from protobuf field string subject = 2;

param string $var
return $this

public setType( $var)

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".

Generated from protobuf field string type = 1;

param string $var
return $this

Properties

protected $description = ''

A description of how the precondition failed. Developers can use this description to understand how to fix the failure.

For example: "Terms of service not accepted".

Generated from protobuf field string description = 3;

protected $subject = ''

The subject, relative to the type, that failed.

For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.

Generated from protobuf field string subject = 2;

protected $type = ''

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".

Generated from protobuf field string type = 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)