public final class Visibility extends 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > VisibilityImplements
VisibilityOrBuilderStatic Fields
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
public static Visibility getDefaultInstance()| Type | Description |
| Visibility |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
newBuilder()
public static Visibility.Builder newBuilder()| Type | Description |
| Visibility.Builder |
newBuilder(Visibility prototype)
public static Visibility.Builder newBuilder(Visibility prototype)| Name | Description |
| prototype | Visibility |
| Type | Description |
| Visibility.Builder |
parseDelimitedFrom(InputStream input)
public static Visibility parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| Visibility |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Visibility parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Visibility |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static Visibility parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| Visibility |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Visibility parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Visibility |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static Visibility parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| Visibility |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Visibility parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Visibility |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static Visibility parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| Visibility |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Visibility parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Visibility |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static Visibility parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| Visibility |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Visibility parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Visibility |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static Visibility parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| Visibility |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Visibility parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Visibility |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<Visibility> parser()| Type | Description |
| Parser<Visibility> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
getDefaultInstanceForType()
public Visibility getDefaultInstanceForType()| Type | Description |
| Visibility |
getParserForType()
public Parser<Visibility> getParserForType()| Type | Description |
| Parser<Visibility> |
getRules(int index)
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;
| Name | Description |
| index | int |
| Type | Description |
| VisibilityRule |
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;
| Type | Description |
| int |
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;
| Type | Description |
| List<VisibilityRule> |
getRulesOrBuilder(int index)
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;
| Name | Description |
| index | int |
| Type | Description |
| VisibilityRuleOrBuilder |
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;
| Type | Description |
| List<? extends com.google.api.VisibilityRuleOrBuilder> |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilderForType()
public Visibility.Builder newBuilderForType()| Type | Description |
| Visibility.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Visibility.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| Visibility.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
public Visibility.Builder toBuilder()| Type | Description |
| Visibility.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |