PHPFUI/InstaDoc

The create key request message.

Generated from protobuf message google.cloud.recaptchaenterprise.v1.CreateKeyRequest

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

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

@type string $parent
      Required. The name of the project in which the key is created, in the
      format `projects/{project}`.
@type \Google\Cloud\RecaptchaEnterprise\V1\Key $key
      Required. Information to create a reCAPTCHA Enterprise key.

}

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

public static build(string $parent, Google\Cloud\RecaptchaEnterprise\V1\Key $key) : self

param string $parent Required. The name of the project in which the key is created, in the format projects/{project}. Please see {@see \RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field.
param \Google\Cloud\RecaptchaEnterprise\V1\Key $key Required. Information to create a reCAPTCHA Enterprise key.
return \Google\Cloud\RecaptchaEnterprise\V1\CreateKeyRequest
experimental

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

ignore

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

Clear all containing fields.

return null

public clearKey()

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

Clear all unknown fields previously parsed.

return null

public getKey()

Required. Information to create a reCAPTCHA Enterprise key.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.Key key = 2 [(.google.api.field_behavior) = REQUIRED];

return \Google\Cloud\RecaptchaEnterprise\V1\Key|null

public getParent()

Required. The name of the project in which the key is created, in the format projects/{project}.

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

return string

public hasKey()

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

Required. Information to create a reCAPTCHA Enterprise key.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.Key key = 2 [(.google.api.field_behavior) = REQUIRED];

param \Google\Cloud\RecaptchaEnterprise\V1\Key $var
return $this

public setParent( $var)

Required. The name of the project in which the key is created, in the format projects/{project}.

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

param string $var
return $this

Properties

protected $key = NULL

Required. Information to create a reCAPTCHA Enterprise key.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.Key key = 2 [(.google.api.field_behavior) = REQUIRED];

protected $parent = ''

Required. The name of the project in which the key is created, in the format projects/{project}.

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

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)

Methods

public static build(string $parent, Google\Cloud\RecaptchaEnterprise\V1\Key $key) : self

param string $parent Required. The name of the project in which the key is created, in the format projects/{project}. Please see {@see \RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field.
param \Google\Cloud\RecaptchaEnterprise\V1\Key $key Required. Information to create a reCAPTCHA Enterprise key.
return \Google\Cloud\RecaptchaEnterprise\V1\CreateKeyRequest
experimental

ConfigurationCode Formating StyleTab Stop SpacesNumbers (0-9.) only