PHPFUI/InstaDoc

A resource that represents Google Cloud Platform location.

Generated from protobuf message google.cloud.location.Location

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
      Resource name for the location, which may vary between implementations.
      For example: `"projects/example-project/locations/us-east1"`
@type string $location_id
      The canonical id for this location. For example: `"us-east1"`.
@type string $display_name
      The friendly name for this location, typically a nearby city name.
      For example, "Tokyo".
@type array|\Google\Protobuf\Internal\MapField $labels
      Cross-service attributes for the location. For example
          {"cloud.googleapis.com/region": "us-east1"}
@type \Google\Protobuf\Any $metadata
      Service-specific metadata. For example the available capacity at the given
      location.

}

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 clearMetadata()

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

Clear all unknown fields previously parsed.

return null

public getDisplayName()

The friendly name for this location, typically a nearby city name.

For example, "Tokyo".

Generated from protobuf field string display_name = 5;

return string

public getLabels()

Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}

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

return \Google\Protobuf\Internal\MapField

public getLocationId()

The canonical id for this location. For example: "us-east1".

Generated from protobuf field string location_id = 4;

return string

public getMetadata()

Service-specific metadata. For example the available capacity at the given location.

Generated from protobuf field .google.protobuf.Any metadata = 3;

return \Google\Protobuf\Any|null

public getName()

Resource name for the location, which may vary between implementations.

For example: "projects/example-project/locations/us-east1"

Generated from protobuf field string name = 1;

return string

public hasMetadata()

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

The friendly name for this location, typically a nearby city name.

For example, "Tokyo".

Generated from protobuf field string display_name = 5;

param string $var
return $this

public setLabels( $var)

Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}

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

param array|\Google\Protobuf\Internal\MapField $var
return $this

public setLocationId( $var)

The canonical id for this location. For example: "us-east1".

Generated from protobuf field string location_id = 4;

param string $var
return $this

public setMetadata( $var)

Service-specific metadata. For example the available capacity at the given location.

Generated from protobuf field .google.protobuf.Any metadata = 3;

param \Google\Protobuf\Any $var
return $this

public setName( $var)

Resource name for the location, which may vary between implementations.

For example: "projects/example-project/locations/us-east1"

Generated from protobuf field string name = 1;

param string $var
return $this

Properties

protected $display_name = ''

The friendly name for this location, typically a nearby city name.

For example, "Tokyo".

Generated from protobuf field string display_name = 5;

protected $location_id = ''

The canonical id for this location. For example: "us-east1".

Generated from protobuf field string location_id = 4;

protected $metadata = NULL

Service-specific metadata. For example the available capacity at the given location.

Generated from protobuf field .google.protobuf.Any metadata = 3;

protected $name = ''

Resource name for the location, which may vary between implementations.

For example: "projects/example-project/locations/us-east1"

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

Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}

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