public static final class Visibility.Builder extends com.google.protobuf.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| Modifier and Type | Method and Description |
|---|---|
Visibility.Builder |
addAllRules(Iterable<? extends VisibilityRule> values)
A list of visibility rules that apply to individual API elements.
|
Visibility.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Visibility.Builder |
addRules(int index,
VisibilityRule.Builder builderForValue)
A list of visibility rules that apply to individual API elements.
|
Visibility.Builder |
addRules(int index,
VisibilityRule value)
A list of visibility rules that apply to individual API elements.
|
Visibility.Builder |
addRules(VisibilityRule.Builder builderForValue)
A list of visibility rules that apply to individual API elements.
|
Visibility.Builder |
addRules(VisibilityRule value)
A list of visibility rules that apply to individual API elements.
|
VisibilityRule.Builder |
addRulesBuilder()
A list of visibility rules that apply to individual API elements.
|
VisibilityRule.Builder |
addRulesBuilder(int index)
A list of visibility rules that apply to individual API elements.
|
Visibility |
build() |
Visibility |
buildPartial() |
Visibility.Builder |
clear() |
Visibility.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Visibility.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Visibility.Builder |
clearRules()
A list of visibility rules that apply to individual API elements.
|
Visibility.Builder |
clone() |
Visibility |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
VisibilityRule |
getRules(int index)
A list of visibility rules that apply to individual API elements.
|
VisibilityRule.Builder |
getRulesBuilder(int index)
A list of visibility rules that apply to individual API elements.
|
List<VisibilityRule.Builder> |
getRulesBuilderList()
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Visibility.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Visibility.Builder |
mergeFrom(com.google.protobuf.Message other) |
Visibility.Builder |
mergeFrom(Visibility other) |
Visibility.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Visibility.Builder |
removeRules(int index)
A list of visibility rules that apply to individual API elements.
|
Visibility.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Visibility.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Visibility.Builder |
setRules(int index,
VisibilityRule.Builder builderForValue)
A list of visibility rules that apply to individual API elements.
|
Visibility.Builder |
setRules(int index,
VisibilityRule value)
A list of visibility rules that apply to individual API elements.
|
Visibility.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Visibility.Builder>public Visibility.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Visibility.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Visibility.Builder>public Visibility getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Visibility build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Visibility buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Visibility.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Visibility.Builder>public Visibility.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Visibility.Builder>public Visibility.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Visibility.Builder>public Visibility.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Visibility.Builder>public Visibility.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Visibility.Builder>public Visibility.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Visibility.Builder>public Visibility.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Visibility.Builder>public Visibility.Builder mergeFrom(Visibility other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Visibility.Builder>public Visibility.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Visibility.Builder>IOExceptionpublic 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;getRulesList in interface VisibilityOrBuilderpublic 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;getRulesCount in interface VisibilityOrBuilderpublic 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;getRules in interface VisibilityOrBuilderpublic 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;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;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;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;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;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;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;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;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;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;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;getRulesOrBuilder in interface VisibilityOrBuilderpublic 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;getRulesOrBuilderList in interface VisibilityOrBuilderpublic 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;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;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;public final Visibility.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Visibility.Builder>public final Visibility.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Visibility.Builder>Copyright © 2022 Google LLC. All rights reserved.