Documentation

VisibilityRule extends Message
in package

A visibility rule provides visibility configuration for an individual API element.

Generated from protobuf message google.api.VisibilityRule

Table of Contents

Properties

$restriction  : mixed
A comma-separated list of visibility labels that apply to the `selector`.
$selector  : mixed
Selects methods, messages, fields, enums, etc. to which this rule applies.

Methods

__construct()  : mixed
Constructor.
getRestriction()  : string
A comma-separated list of visibility labels that apply to the `selector`.
getSelector()  : string
Selects methods, messages, fields, enums, etc. to which this rule applies.
setRestriction()  : $this
A comma-separated list of visibility labels that apply to the `selector`.
setSelector()  : $this
Selects methods, messages, fields, enums, etc. to which this rule applies.

Properties

$restriction

A comma-separated list of visibility labels that apply to the `selector`.

protected mixed $restriction = ''

Any of the listed labels can be used to grant the visibility. If a rule has multiple labels, removing one of the labels but not all of them can break clients. Example: visibility: rules: - selector: google.calendar.Calendar.EnhancedSearch restriction: INTERNAL, PREVIEW Removing INTERNAL from this restriction will break clients that rely on this method and only had access to it through INTERNAL.

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

$selector

Selects methods, messages, fields, enums, etc. to which this rule applies.

protected mixed $selector = ''

Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

Generated from protobuf field string selector = 1 [json_name = "selector"];

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 string $selector
      Selects methods, messages, fields, enums, etc. to which this rule applies.
      Refer to [selector][google.api.DocumentationRule.selector] for syntax
      details.
@type string $restriction
      A comma-separated list of visibility labels that apply to the `selector`.
      Any of the listed labels can be used to grant the visibility.
      If a rule has multiple labels, removing one of the labels but not all of
      them can break clients.
      Example:
          visibility:
            rules:
            - selector: google.calendar.Calendar.EnhancedSearch
              restriction: INTERNAL, PREVIEW
      Removing INTERNAL from this restriction will break clients that rely on
      this method and only had access to it through INTERNAL.

}

getRestriction()

A comma-separated list of visibility labels that apply to the `selector`.

public getRestriction() : string

Any of the listed labels can be used to grant the visibility. If a rule has multiple labels, removing one of the labels but not all of them can break clients. Example: visibility: rules: - selector: google.calendar.Calendar.EnhancedSearch restriction: INTERNAL, PREVIEW Removing INTERNAL from this restriction will break clients that rely on this method and only had access to it through INTERNAL.

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

Return values
string

getSelector()

Selects methods, messages, fields, enums, etc. to which this rule applies.

public getSelector() : string

Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

Generated from protobuf field string selector = 1 [json_name = "selector"];

Return values
string

setRestriction()

A comma-separated list of visibility labels that apply to the `selector`.

public setRestriction(string $var) : $this

Any of the listed labels can be used to grant the visibility. If a rule has multiple labels, removing one of the labels but not all of them can break clients. Example: visibility: rules: - selector: google.calendar.Calendar.EnhancedSearch restriction: INTERNAL, PREVIEW Removing INTERNAL from this restriction will break clients that rely on this method and only had access to it through INTERNAL.

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

Parameters
$var : string
Return values
$this

setSelector()

Selects methods, messages, fields, enums, etc. to which this rule applies.

public setSelector(string $var) : $this

Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

Generated from protobuf field string selector = 1 [json_name = "selector"];

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results