Structured address format for billing and shipping addresses.

Generated from protobuf message google.cloud.recaptchaenterprise.v1.TransactionData.Address

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object.
    @type string $recipient
          Optional. The recipient name, potentially including information such as
          "care of".
    @type array<string>|\Google\Protobuf\Internal\RepeatedField $address
          Optional. The first lines of the address. The first line generally
          contains the street name and number, and further lines may include
          information such as an apartment number.
    @type string $locality
          Optional. The town/city of the address.
    @type string $administrative_area
          Optional. The state, province, or otherwise administrative area of the
          address.
    @type string $region_code
          Optional. The CLDR country/region of the address.
    @type string $postal_code
          Optional. The postal or ZIP code of the address.
    
    }
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 getAddress()
 

Optional. The first lines of the address. The first line generally contains the street name and number, and further lines may include information such as an apartment number.

Generated from protobuf field repeated string address = 2 [(.google.api.field_behavior) = OPTIONAL];

  • return \Google\Protobuf\Internal\RepeatedField
public getAdministrativeArea()
 

Optional. The state, province, or otherwise administrative area of the address.

Generated from protobuf field string administrative_area = 4 [(.google.api.field_behavior) = OPTIONAL];

  • return string
public getLocality()
 

Optional. The town/city of the address.

Generated from protobuf field string locality = 3 [(.google.api.field_behavior) = OPTIONAL];

  • return string
public getPostalCode()
 

Optional. The postal or ZIP code of the address.

Generated from protobuf field string postal_code = 6 [(.google.api.field_behavior) = OPTIONAL];

  • return string
public getRecipient()
 

Optional. The recipient name, potentially including information such as "care of".

Generated from protobuf field string recipient = 1 [(.google.api.field_behavior) = OPTIONAL];

  • return string
public getRegionCode()
 

Optional. The CLDR country/region of the address.

Generated from protobuf field string region_code = 5 [(.google.api.field_behavior) = OPTIONAL];

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

Optional. The first lines of the address. The first line generally contains the street name and number, and further lines may include information such as an apartment number.

Generated from protobuf field repeated string address = 2 [(.google.api.field_behavior) = OPTIONAL];

  • param string[]|\Google\Protobuf\Internal\RepeatedField $var
  • return $this
public setAdministrativeArea( $var)
 

Optional. The state, province, or otherwise administrative area of the address.

Generated from protobuf field string administrative_area = 4 [(.google.api.field_behavior) = OPTIONAL];

  • param string $var
  • return $this
public setLocality( $var)
 

Optional. The town/city of the address.

Generated from protobuf field string locality = 3 [(.google.api.field_behavior) = OPTIONAL];

  • param string $var
  • return $this
public setPostalCode( $var)
 

Optional. The postal or ZIP code of the address.

Generated from protobuf field string postal_code = 6 [(.google.api.field_behavior) = OPTIONAL];

  • param string $var
  • return $this
public setRecipient( $var)
 

Optional. The recipient name, potentially including information such as "care of".

Generated from protobuf field string recipient = 1 [(.google.api.field_behavior) = OPTIONAL];

  • param string $var
  • return $this
public setRegionCode( $var)
 

Optional. The CLDR country/region of the address.

Generated from protobuf field string region_code = 5 [(.google.api.field_behavior) = OPTIONAL];

  • param string $var
  • return $this
Properties
protected $administrative_area = ''
 

Optional. The state, province, or otherwise administrative area of the address.

Generated from protobuf field string administrative_area = 4 [(.google.api.field_behavior) = OPTIONAL];

protected $locality = ''
 

Optional. The town/city of the address.

Generated from protobuf field string locality = 3 [(.google.api.field_behavior) = OPTIONAL];

protected $postal_code = ''
 

Optional. The postal or ZIP code of the address.

Generated from protobuf field string postal_code = 6 [(.google.api.field_behavior) = OPTIONAL];

protected $recipient = ''
 

Optional. The recipient name, potentially including information such as "care of".

Generated from protobuf field string recipient = 1 [(.google.api.field_behavior) = OPTIONAL];

protected $region_code = ''
 

Optional. The CLDR country/region of the address.

Generated from protobuf field string region_code = 5 [(.google.api.field_behavior) = OPTIONAL];

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

Optional. The first lines of the address. The first line generally contains the street name and number, and further lines may include information such as an apartment number.

Generated from protobuf field repeated string address = 2 [(.google.api.field_behavior) = OPTIONAL];

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration