Class Visibility

  • All Implemented Interfaces:
    VisibilityOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class Visibility
    extends com.google.protobuf.GeneratedMessageV3
    implements VisibilityOrBuilder
     `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.
     
    Protobuf type google.api.Visibility
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Visibility.Builder
      `Visibility` restricts service consumer's access to service elements, such as whether an application can call a visibility-restricted method.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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 int RULES_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 Detail

      • newInstance

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

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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
      • getRulesList

        public List<VisibilityRule> getRulesList()
         A list of visibility rules that apply to individual API elements.
         **NOTE:** All service configuration rules follow "last one wins" order.
         
        repeated .google.api.VisibilityRule rules = 1;
        Specified by:
        getRulesList in interface VisibilityOrBuilder
      • getRulesOrBuilderList

        public List<? extends VisibilityRuleOrBuilder> getRulesOrBuilderList()
         A list of visibility rules that apply to individual API elements.
         **NOTE:** All service configuration rules follow "last one wins" order.
         
        repeated .google.api.VisibilityRule rules = 1;
        Specified by:
        getRulesOrBuilderList in interface VisibilityOrBuilder
      • getRulesCount

        public int getRulesCount()
         A list of visibility rules that apply to individual API elements.
         **NOTE:** All service configuration rules follow "last one wins" order.
         
        repeated .google.api.VisibilityRule rules = 1;
        Specified by:
        getRulesCount in interface VisibilityOrBuilder
      • getRules

        public VisibilityRule getRules​(int index)
         A list of visibility rules that apply to individual API elements.
         **NOTE:** All service configuration rules follow "last one wins" order.
         
        repeated .google.api.VisibilityRule rules = 1;
        Specified by:
        getRules in interface VisibilityOrBuilder
      • getRulesOrBuilder

        public VisibilityRuleOrBuilder getRulesOrBuilder​(int index)
         A list of visibility rules that apply to individual API elements.
         **NOTE:** All service configuration rules follow "last one wins" order.
         
        repeated .google.api.VisibilityRule rules = 1;
        Specified by:
        getRulesOrBuilder in interface VisibilityOrBuilder
      • 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 Visibility parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static Visibility parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static Visibility parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

        protected Visibility.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static Visibility getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Visibility> parser()
      • getParserForType

        public com.google.protobuf.Parser<Visibility> 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 Visibility getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder