public static final class VisibilityRule.Builder extends GeneratedMessageV3.Builder<VisibilityRule.Builder> implements VisibilityRuleOrBuilderA visibility rule provides visibility configuration for an individual API element.
Protobuf type google.api.VisibilityRule
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > VisibilityRule.BuilderImplements
VisibilityRuleOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public VisibilityRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
|
build()
public VisibilityRule build()| Returns | |
|---|---|
| Type | Description |
VisibilityRule |
|
buildPartial()
public VisibilityRule buildPartial()| Returns | |
|---|---|
| Type | Description |
VisibilityRule |
|
clear()
public VisibilityRule.Builder clear()| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public VisibilityRule.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public VisibilityRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
|
clearRestriction()
public VisibilityRule.Builder clearRestriction() A comma-separated list of visibility labels that apply to the selector.
Any of the listed labels can be used to grant the visibility.
If a rule has multiple labels, removing one of the labels but not all of them can break clients.
Example:
visibility:
rules:
- selector: google.calendar.Calendar.EnhancedSearch
restriction: INTERNAL, PREVIEW
Removing INTERNAL from this restriction will break clients that rely on this method and only had access to it through INTERNAL.
string restriction = 2;
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
This builder for chaining. |
clearSelector()
public VisibilityRule.Builder clearSelector()Selects methods, messages, fields, enums, etc. to which this rule applies.
Refer to selector for syntax details.
string selector = 1;
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
This builder for chaining. |
clone()
public VisibilityRule.Builder clone()| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
|
getDefaultInstanceForType()
public VisibilityRule getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
VisibilityRule |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getRestriction()
public String getRestriction() A comma-separated list of visibility labels that apply to the selector.
Any of the listed labels can be used to grant the visibility.
If a rule has multiple labels, removing one of the labels but not all of them can break clients.
Example:
visibility:
rules:
- selector: google.calendar.Calendar.EnhancedSearch
restriction: INTERNAL, PREVIEW
Removing INTERNAL from this restriction will break clients that rely on this method and only had access to it through INTERNAL.
string restriction = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The restriction. |
getRestrictionBytes()
public ByteString getRestrictionBytes() A comma-separated list of visibility labels that apply to the selector.
Any of the listed labels can be used to grant the visibility.
If a rule has multiple labels, removing one of the labels but not all of them can break clients.
Example:
visibility:
rules:
- selector: google.calendar.Calendar.EnhancedSearch
restriction: INTERNAL, PREVIEW
Removing INTERNAL from this restriction will break clients that rely on this method and only had access to it through INTERNAL.
string restriction = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for restriction. |
getSelector()
public String getSelector()Selects methods, messages, fields, enums, etc. to which this rule applies.
Refer to selector for syntax details.
string selector = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The selector. |
getSelectorBytes()
public ByteString getSelectorBytes()Selects methods, messages, fields, enums, etc. to which this rule applies.
Refer to selector for syntax details.
string selector = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for selector. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(VisibilityRule other)
public VisibilityRule.Builder mergeFrom(VisibilityRule other)| Parameter | |
|---|---|
| Name | Description |
other |
VisibilityRule |
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public VisibilityRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public VisibilityRule.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final VisibilityRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public VisibilityRule.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public VisibilityRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
|
setRestriction(String value)
public VisibilityRule.Builder setRestriction(String value) A comma-separated list of visibility labels that apply to the selector.
Any of the listed labels can be used to grant the visibility.
If a rule has multiple labels, removing one of the labels but not all of them can break clients.
Example:
visibility:
rules:
- selector: google.calendar.Calendar.EnhancedSearch
restriction: INTERNAL, PREVIEW
Removing INTERNAL from this restriction will break clients that rely on this method and only had access to it through INTERNAL.
string restriction = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe restriction to set. |
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
This builder for chaining. |
setRestrictionBytes(ByteString value)
public VisibilityRule.Builder setRestrictionBytes(ByteString value) A comma-separated list of visibility labels that apply to the selector.
Any of the listed labels can be used to grant the visibility.
If a rule has multiple labels, removing one of the labels but not all of them can break clients.
Example:
visibility:
rules:
- selector: google.calendar.Calendar.EnhancedSearch
restriction: INTERNAL, PREVIEW
Removing INTERNAL from this restriction will break clients that rely on this method and only had access to it through INTERNAL.
string restriction = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for restriction to set. |
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
This builder for chaining. |
setSelector(String value)
public VisibilityRule.Builder setSelector(String value)Selects methods, messages, fields, enums, etc. to which this rule applies.
Refer to selector for syntax details.
string selector = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe selector to set. |
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
This builder for chaining. |
setSelectorBytes(ByteString value)
public VisibilityRule.Builder setSelectorBytes(ByteString value)Selects methods, messages, fields, enums, etc. to which this rule applies.
Refer to selector for syntax details.
string selector = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for selector to set. |
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final VisibilityRule.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
VisibilityRule.Builder |
|