Package com.google.api

Class VisibilityRule

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.api.VisibilityRule
All Implemented Interfaces:
VisibilityRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class VisibilityRule extends com.google.protobuf.GeneratedMessageV3 implements VisibilityRuleOrBuilder
 A visibility rule provides visibility configuration for an individual API
 element.
Protobuf type google.api.VisibilityRule
See Also:

  • 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.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    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.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static VisibilityRule
    getDefaultInstance()
     
    VisibilityRule
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<VisibilityRule>
    getParserForType()
     
    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. to which this rule applies.
    com.google.protobuf.ByteString
    getSelectorBytes()
    Selects methods, messages, fields, enums, etc. to which this rule applies.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static VisibilityRule.Builder
    newBuilder()
     
    static VisibilityRule.Builder
    newBuilder(VisibilityRule prototype)
     
    VisibilityRule.Builder
    newBuilderForType()
     
    protected VisibilityRule.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    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()
     
    VisibilityRule.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, 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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • 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

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • 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;
      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;
      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;
      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;
      Specified by:
      getRestrictionBytes in interface VisibilityRuleOrBuilder
      Returns:
      The bytes for restriction.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • 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

    • newBuilderForType

      public VisibilityRule.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static VisibilityRule.Builder newBuilder()

    • newBuilder

      public static VisibilityRule.Builder newBuilder(VisibilityRule prototype)

    • toBuilder

      public VisibilityRule.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected VisibilityRule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static VisibilityRule getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<VisibilityRule> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public VisibilityRule getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder