Class Visibility (2.9.1)

Stay organized with collections Save and categorize content based on your preferences.
public final class Visibility extends GeneratedMessageV3 implements VisibilityOrBuilder

Visibility defines restrictions for the visibility of service elements. Restrictions are specified using visibility labels (e.g., PREVIEW) that are elsewhere linked to users and projects. Users and projects can have access to more than one visibility label. The effective visibility for multiple labels is the union of each label's elements, plus any unrestricted elements. If an element and its parents have no restrictions, 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

Implements

VisibilityOrBuilder

Static Fields

RULES_FIELD_NUMBER

public static final int RULES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Visibility getDefaultInstance()
Returns
TypeDescription
Visibility

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Visibility.Builder newBuilder()
Returns
TypeDescription
Visibility.Builder

newBuilder(Visibility prototype)

public static Visibility.Builder newBuilder(Visibility prototype)
Parameter
NameDescription
prototypeVisibility
Returns
TypeDescription
Visibility.Builder

parseDelimitedFrom(InputStream input)

public static Visibility parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Visibility
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Visibility parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Visibility
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Visibility parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Visibility
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Visibility parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Visibility
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Visibility parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Visibility
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Visibility parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Visibility
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Visibility parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Visibility
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Visibility parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Visibility
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Visibility parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Visibility
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Visibility parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Visibility
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Visibility parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Visibility
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Visibility parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Visibility
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Visibility> parser()
Returns
TypeDescription
Parser<Visibility>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Visibility getDefaultInstanceForType()
Returns
TypeDescription
Visibility

getParserForType()

public Parser<Visibility> getParserForType()
Returns
TypeDescription
Parser<Visibility>
Overrides

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Parameter
NameDescription
indexint
Returns
TypeDescription
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;

Returns
TypeDescription
List<? extends com.google.api.VisibilityRuleOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Visibility.Builder newBuilderForType()
Returns
TypeDescription
Visibility.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Visibility.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Visibility.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Visibility.Builder toBuilder()
Returns
TypeDescription
Visibility.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException