Package com.google.api

Class Visibility

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<Visibility,Visibility.Builder>
com.google.api.Visibility
All Implemented Interfaces:
VisibilityOrBuilder, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder
public final class Visibility extends com.google.protobuf.GeneratedMessageLite<Visibility,Visibility.Builder> 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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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.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
    RULES_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 Visibility
    getDefaultInstance()
     
    VisibilityRule
    getRules(int index)
    A list of visibility rules that apply to individual API elements.
    int
    getRulesCount()
    A list of visibility rules that apply to individual API elements.
    List<VisibilityRule>
    getRulesList()
    A list of visibility rules that apply to individual API elements.
    VisibilityRuleOrBuilder
    getRulesOrBuilder(int index)
    A list of visibility rules that apply to individual API elements.
    List<? extends VisibilityRuleOrBuilder>
    getRulesOrBuilderList()
    A list of visibility rules that apply to individual API elements.
    static Visibility.Builder
    newBuilder()
     
    static Visibility.Builder
    newBuilder(Visibility prototype)
     
    static Visibility
    parseDelimitedFrom(InputStream input)
     
    static Visibility
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Visibility
    parseFrom(byte[] data)
     
    static Visibility
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Visibility
    parseFrom(com.google.protobuf.ByteString data)
     
    static Visibility
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Visibility
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Visibility
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Visibility
    parseFrom(InputStream input)
     
    static Visibility
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Visibility
    parseFrom(ByteBuffer data)
     
    static Visibility
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Visibility>
    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

  • Method Details

    • 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 [json_name = "rules"];
      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 [json_name = "rules"];

    • 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 [json_name = "rules"];
      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 [json_name = "rules"];
      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 [json_name = "rules"];

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static Visibility.Builder newBuilder()

    • newBuilder

      public static Visibility.Builder newBuilder(Visibility 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<Visibility,Visibility.Builder>

    • getDefaultInstance

      public static Visibility getDefaultInstance()

    • parser

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