Class VisibilityRule (2.10.0)
Stay organized with collections
Save and categorize content based on your preferences.
public sealed class VisibilityRule : IMessage<VisibilityRule>, IEquatable<VisibilityRule>, IDeepCloneable<VisibilityRule>, IBufferMessage, IMessage
A visibility rule provides visibility configuration for an individual API
element.
Inheritance
object >
VisibilityRule
Namespace
Google.Api
Assembly
Google.Api.CommonProtos.dll
Constructors
VisibilityRule()
VisibilityRule(VisibilityRule)
public VisibilityRule(VisibilityRule other)
Fields
RestrictionFieldNumber
public const int RestrictionFieldNumber = 2
Field number for the "restriction" field.
Field Value |
Type |
Description |
int |
|
SelectorFieldNumber
public const int SelectorFieldNumber = 1
Field number for the "selector" field.
Field Value |
Type |
Description |
int |
|
Properties
Descriptor
public static MessageDescriptor Descriptor { get; }
Parser
public static MessageParser<VisibilityRule> Parser { get; }
Restriction
public string Restriction { get; set; }
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.
Property Value |
Type |
Description |
string |
|
Selector
public string Selector { get; set; }
Selects methods, messages, fields, enums, etc. to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax
details.
Property Value |
Type |
Description |
string |
|
Methods
CalculateSize()
public int CalculateSize()
Returns |
Type |
Description |
int |
|
Clone()
public VisibilityRule Clone()
Equals(VisibilityRule)
public bool Equals(VisibilityRule other)
Returns |
Type |
Description |
bool |
|
Equals(object)
public override bool Equals(object other)
Parameter |
Name |
Description |
other |
object
|
Returns |
Type |
Description |
bool |
|
Overrides
GetHashCode()
public override int GetHashCode()
Returns |
Type |
Description |
int |
|
Overrides
MergeFrom(VisibilityRule)
public void MergeFrom(VisibilityRule other)
public void MergeFrom(CodedInputStream input)
ToString()
public override string ToString()
Returns |
Type |
Description |
string |
|
Overrides
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-01 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2024-10-01 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-01 UTC."]]