Google API Common Protos Client - Class Visibility (4.8.2)

Reference documentation and code samples for the Google API Common Protos Client class Visibility.

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

Namespace

Google \ Api

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ rules array<Google\Api\VisibilityRule>

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.

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRules

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

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

Parameter
Name Description
var array<Google\Api\VisibilityRule>
Returns
Type Description
$this