PHPFUI/InstaDoc
 
Copied!

Associates members, or principals, with a role.

Generated from protobuf message google.iam.v1.Binding

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type string $role
      Role that is assigned to the list of `members`, or principals.
      For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
@type array<string>|\Google\Protobuf\Internal\RepeatedField $members
      Specifies the principals requesting access for a Google Cloud resource.
      `members` can have the following values:
      *          * `allUsers`: A special identifier that represents anyone who is
         on the internet; with or without a Google account.
      *          * `allAuthenticatedUsers`: A special identifier that represents anyone
         who is authenticated with a Google account or a service account.
      *          * `user:{emailid}`: An email address that represents a specific Google
         account. For example, `alice&#64;example.com` .
      *          * `serviceAccount:{emailid}`: An email address that represents a service
         account. For example, `my-other-app&#64;appspot.gserviceaccount.com`.
      *          * `group:{emailid}`: An email address that represents a Google group.
         For example, `admins&#64;example.com`.
      *          * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
         identifier) representing a user that has been recently deleted. For
         example, `alice&#64;example.com?uid=123456789012345678901`. If the user is
         recovered, this value reverts to `user:{emailid}` and the recovered user
         retains the role in the binding.
      *          * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
         unique identifier) representing a service account that has been recently
         deleted. For example,
         `my-other-app&#64;appspot.gserviceaccount.com?uid=123456789012345678901`.
         If the service account is undeleted, this value reverts to
         `serviceAccount:{emailid}` and the undeleted service account retains the
         role in the binding.
      *          * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
         identifier) representing a Google group that has been recently
         deleted. For example, `admins&#64;example.com?uid=123456789012345678901`. If
         the group is recovered, this value reverts to `group:{emailid}` and the
         recovered group retains the role in the binding.
      *          * `domain:{domain}`: The G Suite domain (primary) that represents all the
         users of that domain. For example, `google.com` or `example.com`.
@type \Google\Type\Expr $condition
      The condition that is associated with this binding.
      If the condition evaluates to `true`, then this binding applies to the
      current request.
      If the condition evaluates to `false`, then this binding does not apply to
      the current request. However, a different role binding might grant the same
      role to one or more of the principals in this binding.
      To learn which resources support conditions in their IAM policies, see the
      [IAM
      documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
    }
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 clearCondition()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getCondition()
 

The condition that is associated with this binding.

If the condition evaluates to true, then this binding applies to the current request. If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the IAM documentation.

Generated from protobuf field .google.type.Expr condition = 3;

  • return \Google\Type\Expr|null
public getMembers()
 

Specifies the principals requesting access for a Google Cloud resource.

members can have the following values:

  • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
  • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
  • user:{emailid}: An email address that represents a specific Google account. For example, alice&#64;example.com .
  • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app&#64;appspot.gserviceaccount.com.
  • group:{emailid}: An email address that represents a Google group. For example, admins&#64;example.com.
  • deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice&#64;example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
  • deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app&#64;appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
  • deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins&#64;example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
  • domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

Generated from protobuf field repeated string members = 2;

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

Role that is assigned to the list of members, or principals.

For example, roles/viewer, roles/editor, or roles/owner.

Generated from protobuf field string role = 1;

  • return string
public hasCondition()
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 setCondition( $var)
 

The condition that is associated with this binding.

If the condition evaluates to true, then this binding applies to the current request. If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the IAM documentation.

Generated from protobuf field .google.type.Expr condition = 3;

  • param \Google\Type\Expr $var
  • return $this
public setMembers( $var)
 

Specifies the principals requesting access for a Google Cloud resource.

members can have the following values:

  • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
  • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
  • user:{emailid}: An email address that represents a specific Google account. For example, alice&#64;example.com .
  • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app&#64;appspot.gserviceaccount.com.
  • group:{emailid}: An email address that represents a Google group. For example, admins&#64;example.com.
  • deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice&#64;example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
  • deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app&#64;appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
  • deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins&#64;example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
  • domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

Generated from protobuf field repeated string members = 2;

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

Role that is assigned to the list of members, or principals.

For example, roles/viewer, roles/editor, or roles/owner.

Generated from protobuf field string role = 1;

  • param string $var
  • return $this
Properties
protected $condition = NULL
 

The condition that is associated with this binding.

If the condition evaluates to true, then this binding applies to the current request. If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the IAM documentation.

Generated from protobuf field .google.type.Expr condition = 3;

protected $role = ''
 

Role that is assigned to the list of members, or principals.

For example, roles/viewer, roles/editor, or roles/owner.

Generated from protobuf field string role = 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 $members = NULL
 

Specifies the principals requesting access for a Google Cloud resource.

members can have the following values:

  • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
  • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
  • user:{emailid}: An email address that represents a specific Google account. For example, alice&#64;example.com .
  • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app&#64;appspot.gserviceaccount.com.
  • group:{emailid}: An email address that represents a Google group. For example, admins&#64;example.com.
  • deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice&#64;example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
  • deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app&#64;appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
  • deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins&#64;example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
  • domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

Generated from protobuf field repeated string members = 2;

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration