Class Visibility.Builder (2.46.0)

Version 2.46.0

• 2.50.0 (latest)
• 2.49.0
• 2.48.0
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public static final class Visibility.Builder extends GeneratedMessageV3.Builder<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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Visibility.Builder

Implements

VisibilityOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllRules(Iterable<? extends VisibilityRule> values)

public Visibility.Builder addAllRules(Iterable<? extends VisibilityRule> values)

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
Name	Description
values	Iterable<? extends com.google.api.VisibilityRule>

Returns
Type	Description
Visibility.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Visibility.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Visibility.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addRules(VisibilityRule value)

public Visibility.Builder addRules(VisibilityRule value)

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
Name	Description
value	VisibilityRule

Returns
Type	Description
Visibility.Builder

addRules(VisibilityRule.Builder builderForValue)

public Visibility.Builder addRules(VisibilityRule.Builder builderForValue)

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
Name	Description
builderForValue	VisibilityRule.Builder

Returns
Type	Description
Visibility.Builder

addRules(int index, VisibilityRule value)

public Visibility.Builder addRules(int index, VisibilityRule value)

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;

Parameters
Name	Description
index	int
value	VisibilityRule

Returns
Type	Description
Visibility.Builder

addRules(int index, VisibilityRule.Builder builderForValue)

public Visibility.Builder addRules(int index, VisibilityRule.Builder builderForValue)

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;

Parameters
Name	Description
index	int
builderForValue	VisibilityRule.Builder

Returns
Type	Description
Visibility.Builder

addRulesBuilder()

public VisibilityRule.Builder addRulesBuilder()

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
Type	Description
VisibilityRule.Builder

addRulesBuilder(int index)

public VisibilityRule.Builder addRulesBuilder(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
Name	Description
index	int

Returns
Type	Description
VisibilityRule.Builder

build()

public Visibility build()

Returns
Type	Description
Visibility

buildPartial()

public Visibility buildPartial()

Returns
Type	Description
Visibility

clear()

public Visibility.Builder clear()

Returns
Type	Description
Visibility.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Visibility.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Visibility.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public Visibility.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Visibility.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRules()

public Visibility.Builder clearRules()

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
Type	Description
Visibility.Builder

clone()

public Visibility.Builder clone()

Returns
Type	Description
Visibility.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Visibility getDefaultInstanceForType()

Returns
Type	Description
Visibility

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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
Name	Description
index	int

Returns
Type	Description
VisibilityRule

getRulesBuilder(int index)

public VisibilityRule.Builder getRulesBuilder(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
Name	Description
index	int

Returns
Type	Description
VisibilityRule.Builder

getRulesBuilderList()

public List<VisibilityRule.Builder> getRulesBuilderList()

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
Type	Description
List<Builder>

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

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

Parameter
Name	Description
index	int

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

Returns
Type	Description
List<? extends com.google.api.VisibilityRuleOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Visibility other)

public Visibility.Builder mergeFrom(Visibility other)

Parameter
Name	Description
other	Visibility

Returns
Type	Description
Visibility.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Visibility.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Visibility.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Visibility.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Visibility.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Visibility.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Visibility.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeRules(int index)

public Visibility.Builder removeRules(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
Name	Description
index	int

Returns
Type	Description
Visibility.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Visibility.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Visibility.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Visibility.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Visibility.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRules(int index, VisibilityRule value)

public Visibility.Builder setRules(int index, VisibilityRule value)

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;

Parameters
Name	Description
index	int
value	VisibilityRule

Returns
Type	Description
Visibility.Builder

setRules(int index, VisibilityRule.Builder builderForValue)

public Visibility.Builder setRules(int index, VisibilityRule.Builder builderForValue)

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;

Parameters
Name	Description
index	int
builderForValue	VisibilityRule.Builder

Returns
Type	Description
Visibility.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Visibility.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Visibility.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)