Package com.google.api

Class VisibilityRule

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<VisibilityRule,VisibilityRule.Builder>
com.google.api.VisibilityRule
All Implemented Interfaces:
VisibilityRuleOrBuilder, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder
public final class VisibilityRule extends com.google.protobuf.GeneratedMessageLite<VisibilityRule,VisibilityRule.Builder> implements VisibilityRuleOrBuilder
 A visibility rule provides visibility configuration for an individual API
 element.
Protobuf type google.api.VisibilityRule

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    VisibilityRule.Builder
    A visibility rule provides visibility configuration for an individual API element.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    RESTRICTION_FIELD_NUMBER
     
    static final int
    SELECTOR_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    static VisibilityRule
    getDefaultInstance()
     
    String
    getRestriction()
    A comma-separated list of visibility labels that apply to the `selector`.
    com.google.protobuf.ByteString
    getRestrictionBytes()
    A comma-separated list of visibility labels that apply to the `selector`.
    String
    getSelector()
    Selects methods, messages, fields, enums, etc.
    com.google.protobuf.ByteString
    getSelectorBytes()
    Selects methods, messages, fields, enums, etc.
    static VisibilityRule.Builder
    newBuilder()
     
    static VisibilityRule.Builder
    newBuilder(VisibilityRule prototype)
     
    static VisibilityRule
    parseDelimitedFrom(InputStream input)
     
    static VisibilityRule
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static VisibilityRule
    parseFrom(byte[] data)
     
    static VisibilityRule
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static VisibilityRule
    parseFrom(com.google.protobuf.ByteString data)
     
    static VisibilityRule
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static VisibilityRule
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static VisibilityRule
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static VisibilityRule
    parseFrom(InputStream input)
     
    static VisibilityRule
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static VisibilityRule
    parseFrom(ByteBuffer data)
     
    static VisibilityRule
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<VisibilityRule>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

    • SELECTOR_FIELD_NUMBER

      public static final int SELECTOR_FIELD_NUMBER
      See Also:

    • RESTRICTION_FIELD_NUMBER

      public static final int RESTRICTION_FIELD_NUMBER
      See Also:

  • Method Details

    • getSelector

      public String getSelector()
       Selects methods, messages, fields, enums, etc. to which this rule applies.

 Refer to [selector][google.api.DocumentationRule.selector] for syntax
 details.
      string selector = 1 [json_name = "selector"];
      Specified by:
      getSelector in interface VisibilityRuleOrBuilder
      Returns:
      The selector.

    • getSelectorBytes

      public com.google.protobuf.ByteString getSelectorBytes()
       Selects methods, messages, fields, enums, etc. to which this rule applies.

 Refer to [selector][google.api.DocumentationRule.selector] for syntax
 details.
      string selector = 1 [json_name = "selector"];
      Specified by:
      getSelectorBytes in interface VisibilityRuleOrBuilder
      Returns:
      The bytes for selector.

    • getRestriction

      public String getRestriction()
       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.
      string restriction = 2 [json_name = "restriction"];
      Specified by:
      getRestriction in interface VisibilityRuleOrBuilder
      Returns:
      The restriction.

    • getRestrictionBytes

      public com.google.protobuf.ByteString getRestrictionBytes()
       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.
      string restriction = 2 [json_name = "restriction"];
      Specified by:
      getRestrictionBytes in interface VisibilityRuleOrBuilder
      Returns:
      The bytes for restriction.

    • parseFrom

      public static VisibilityRule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VisibilityRule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VisibilityRule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VisibilityRule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VisibilityRule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VisibilityRule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VisibilityRule parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VisibilityRule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static VisibilityRule parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static VisibilityRule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VisibilityRule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VisibilityRule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static VisibilityRule.Builder newBuilder()

    • newBuilder

      public static VisibilityRule.Builder newBuilder(VisibilityRule prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<VisibilityRule,VisibilityRule.Builder>

    • getDefaultInstance

      public static VisibilityRule getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<VisibilityRule> parser()