Documentation

Visibility extends Message
in package

`Visibility` restricts service consumer's access to service elements, such as whether an application can call a visibility-restricted method.

The restriction is expressed by applying visibility labels on service elements. The visibility labels are elsewhere linked to service consumers. A service can define multiple visibility labels, but a service consumer should be granted at most one visibility label. Multiple visibility labels for a single service consumer are not supported. If an element and all its parents have no visibility label, its visibility is unconditionally granted. Example: visibility: rules: - selector: google.calendar.Calendar.EnhancedSearch restriction: PREVIEW - selector: google.calendar.Calendar.Delegate restriction: INTERNAL Here, all methods are publicly visible except for the restricted methods EnhancedSearch and Delegate.

Generated from protobuf message google.api.Visibility

Table of Contents

Properties

$rules  : mixed
A list of visibility rules that apply to individual API elements.

Methods

__construct()  : mixed
Constructor.
getRules()  : RepeatedField
A list of visibility rules that apply to individual API elements.
setRules()  : $this
A list of visibility rules that apply to individual API elements.

Properties

$rules

A list of visibility rules that apply to individual API elements.

private mixed $rules

NOTE: All service configuration rules follow "last one wins" order.

Generated from protobuf field repeated .google.api.VisibilityRule rules = 1 [json_name = "rules"];

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 array<\Google\Api\VisibilityRule>|\Google\Protobuf\Internal\RepeatedField $rules
      A list of visibility rules that apply to individual API elements.
      **NOTE:** All service configuration rules follow "last one wins" order.

}

getRules()

A list of visibility rules that apply to individual API elements.

public getRules() : RepeatedField

NOTE: All service configuration rules follow "last one wins" order.

Generated from protobuf field repeated .google.api.VisibilityRule rules = 1 [json_name = "rules"];

Return values
RepeatedField

setRules()

A list of visibility rules that apply to individual API elements.

public setRules(array<string|int, VisibilityRule>|RepeatedField $var) : $this

NOTE: All service configuration rules follow "last one wins" order.

Generated from protobuf field repeated .google.api.VisibilityRule rules = 1 [json_name = "rules"];

Parameters
$var : array<string|int, VisibilityRule>|RepeatedField
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results