Documentation

Select extends Message
in package

A field selection expression. e.g. `request.auth`.

Generated from protobuf message google.api.expr.v1alpha1.Expr.Select

Table of Contents

Properties

$field  : mixed
Required. The name of the field to select.
$operand  : mixed
Required. The target of the selection expression.
$test_only  : mixed
Whether the select is to be interpreted as a field presence test.

Methods

__construct()  : mixed
Constructor.
clearOperand()  : mixed
getField()  : string
Required. The name of the field to select.
getOperand()  : Expr|null
Required. The target of the selection expression.
getTestOnly()  : bool
Whether the select is to be interpreted as a field presence test.
hasOperand()  : mixed
setField()  : $this
Required. The name of the field to select.
setOperand()  : $this
Required. The target of the selection expression.
setTestOnly()  : $this
Whether the select is to be interpreted as a field presence test.

Properties

$field

Required. The name of the field to select.

protected mixed $field = ''

For example, in the select expression request.auth, the auth portion of the expression would be the field.

Generated from protobuf field string field = 2 [json_name = "field"];

$operand

Required. The target of the selection expression.

protected mixed $operand = null

For example, in the select expression request.auth, the request portion of the expression is the operand.

Generated from protobuf field .google.api.expr.v1alpha1.Expr operand = 1 [json_name = "operand"];

$test_only

Whether the select is to be interpreted as a field presence test.

protected mixed $test_only = false

This results from the macro has(request.auth).

Generated from protobuf field bool test_only = 3 [json_name = "testOnly"];

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type \Google\Api\Expr\V1alpha1\Expr $operand
      Required. The target of the selection expression.
      For example, in the select expression `request.auth`, the `request`
      portion of the expression is the `operand`.
@type string $field
      Required. The name of the field to select.
      For example, in the select expression `request.auth`, the `auth` portion
      of the expression would be the `field`.
@type bool $test_only
      Whether the select is to be interpreted as a field presence test.
      This results from the macro `has(request.auth)`.

}

clearOperand()

public clearOperand() : mixed

getField()

Required. The name of the field to select.

public getField() : string

For example, in the select expression request.auth, the auth portion of the expression would be the field.

Generated from protobuf field string field = 2 [json_name = "field"];

Return values
string

getOperand()

Required. The target of the selection expression.

public getOperand() : Expr|null

For example, in the select expression request.auth, the request portion of the expression is the operand.

Generated from protobuf field .google.api.expr.v1alpha1.Expr operand = 1 [json_name = "operand"];

Return values
Expr|null

getTestOnly()

Whether the select is to be interpreted as a field presence test.

public getTestOnly() : bool

This results from the macro has(request.auth).

Generated from protobuf field bool test_only = 3 [json_name = "testOnly"];

Return values
bool

hasOperand()

public hasOperand() : mixed

setField()

Required. The name of the field to select.

public setField(string $var) : $this

For example, in the select expression request.auth, the auth portion of the expression would be the field.

Generated from protobuf field string field = 2 [json_name = "field"];

Parameters
$var : string
Return values
$this

setOperand()

Required. The target of the selection expression.

public setOperand(Expr $var) : $this

For example, in the select expression request.auth, the request portion of the expression is the operand.

Generated from protobuf field .google.api.expr.v1alpha1.Expr operand = 1 [json_name = "operand"];

Parameters
$var : Expr
Return values
$this

setTestOnly()

Whether the select is to be interpreted as a field presence test.

public setTestOnly(bool $var) : $this

This results from the macro has(request.auth).

Generated from protobuf field bool test_only = 3 [json_name = "testOnly"];

Parameters
$var : bool
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results