public final class DataAccessScope extends GeneratedMessageV3 implements DataAccessScopeOrBuilder
A DataAccessScope is a boolean expression of data access labels used
to restrict access to data for users.
Protobuf type google.cloud.chronicle.v1.DataAccessScope
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ALLOWED_DATA_ACCESS_LABELS_FIELD_NUMBER
public static final int ALLOWED_DATA_ACCESS_LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ALLOW_ALL_FIELD_NUMBER
public static final int ALLOW_ALL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
AUTHOR_FIELD_NUMBER
public static final int AUTHOR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DENIED_DATA_ACCESS_LABELS_FIELD_NUMBER
public static final int DENIED_DATA_ACCESS_LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LAST_EDITOR_FIELD_NUMBER
public static final int LAST_EDITOR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static DataAccessScope getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DataAccessScope.Builder newBuilder()
newBuilder(DataAccessScope prototype)
public static DataAccessScope.Builder newBuilder(DataAccessScope prototype)
public static DataAccessScope parseDelimitedFrom(InputStream input)
public static DataAccessScope parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DataAccessScope parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DataAccessScope parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DataAccessScope parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataAccessScope parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataAccessScope parseFrom(CodedInputStream input)
public static DataAccessScope parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DataAccessScope parseFrom(InputStream input)
public static DataAccessScope parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DataAccessScope parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DataAccessScope parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DataAccessScope> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAllowAll()
public boolean getAllowAll()
Optional. Whether or not the scope allows all labels, allow_all and
allowed_data_access_labels are mutually exclusive and one of them must be
present. denied_data_access_labels can still be used along with allow_all.
When combined with denied_data_access_labels, access will be granted to all
data that doesn't have labels mentioned in denied_data_access_labels. E.g.:
A customer with scope with denied labels A and B and allow_all will be able
to see all data except data labeled with A and data labeled with B and data
with labels A and B.
bool allow_all = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The allowAll.
|
getAllowedDataAccessLabels(int index)
public DataAccessLabelReference getAllowedDataAccessLabels(int index)
Optional. The allowed labels for the scope.
Either allow_all or allowed_data_access_labels needs to be provided.
When provided, there has to be at least one label allowed for the scope to
be valid.
The logical operator for evaluation of the allowed labels is OR.
E.g.: A customer with scope with allowed labels A and B will be able
to see data with labeled with A or B or (A and B).
repeated .google.cloud.chronicle.v1.DataAccessLabelReference allowed_data_access_labels = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getAllowedDataAccessLabelsCount()
public int getAllowedDataAccessLabelsCount()
Optional. The allowed labels for the scope.
Either allow_all or allowed_data_access_labels needs to be provided.
When provided, there has to be at least one label allowed for the scope to
be valid.
The logical operator for evaluation of the allowed labels is OR.
E.g.: A customer with scope with allowed labels A and B will be able
to see data with labeled with A or B or (A and B).
repeated .google.cloud.chronicle.v1.DataAccessLabelReference allowed_data_access_labels = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getAllowedDataAccessLabelsList()
public List<DataAccessLabelReference> getAllowedDataAccessLabelsList()
Optional. The allowed labels for the scope.
Either allow_all or allowed_data_access_labels needs to be provided.
When provided, there has to be at least one label allowed for the scope to
be valid.
The logical operator for evaluation of the allowed labels is OR.
E.g.: A customer with scope with allowed labels A and B will be able
to see data with labeled with A or B or (A and B).
repeated .google.cloud.chronicle.v1.DataAccessLabelReference allowed_data_access_labels = 2 [(.google.api.field_behavior) = OPTIONAL];
getAllowedDataAccessLabelsOrBuilder(int index)
public DataAccessLabelReferenceOrBuilder getAllowedDataAccessLabelsOrBuilder(int index)
Optional. The allowed labels for the scope.
Either allow_all or allowed_data_access_labels needs to be provided.
When provided, there has to be at least one label allowed for the scope to
be valid.
The logical operator for evaluation of the allowed labels is OR.
E.g.: A customer with scope with allowed labels A and B will be able
to see data with labeled with A or B or (A and B).
repeated .google.cloud.chronicle.v1.DataAccessLabelReference allowed_data_access_labels = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getAllowedDataAccessLabelsOrBuilderList()
public List<? extends DataAccessLabelReferenceOrBuilder> getAllowedDataAccessLabelsOrBuilderList()
Optional. The allowed labels for the scope.
Either allow_all or allowed_data_access_labels needs to be provided.
When provided, there has to be at least one label allowed for the scope to
be valid.
The logical operator for evaluation of the allowed labels is OR.
E.g.: A customer with scope with allowed labels A and B will be able
to see data with labeled with A or B or (A and B).
repeated .google.cloud.chronicle.v1.DataAccessLabelReference allowed_data_access_labels = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.chronicle.v1.DataAccessLabelReferenceOrBuilder> |
|
getAuthor()
public String getAuthor()
Output only. The user who created the data access scope.
string author = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The author.
|
getAuthorBytes()
public ByteString getAuthorBytes()
Output only. The user who created the data access scope.
string author = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for author.
|
getCreateTime()
public Timestamp getCreateTime()
Output only. The time at which the data access scope was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time at which the data access scope was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public DataAccessScope getDefaultInstanceForType()
getDeniedDataAccessLabels(int index)
public DataAccessLabelReference getDeniedDataAccessLabels(int index)
Optional. The denied labels for the scope.
The logical operator for evaluation of the denied labels is AND.
E.g.: A customer with scope with denied labels A and B won't be able
to see data labeled with A and data labeled with B
and data with labels A and B.
repeated .google.cloud.chronicle.v1.DataAccessLabelReference denied_data_access_labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getDeniedDataAccessLabelsCount()
public int getDeniedDataAccessLabelsCount()
Optional. The denied labels for the scope.
The logical operator for evaluation of the denied labels is AND.
E.g.: A customer with scope with denied labels A and B won't be able
to see data labeled with A and data labeled with B
and data with labels A and B.
repeated .google.cloud.chronicle.v1.DataAccessLabelReference denied_data_access_labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getDeniedDataAccessLabelsList()
public List<DataAccessLabelReference> getDeniedDataAccessLabelsList()
Optional. The denied labels for the scope.
The logical operator for evaluation of the denied labels is AND.
E.g.: A customer with scope with denied labels A and B won't be able
to see data labeled with A and data labeled with B
and data with labels A and B.
repeated .google.cloud.chronicle.v1.DataAccessLabelReference denied_data_access_labels = 3 [(.google.api.field_behavior) = OPTIONAL];
getDeniedDataAccessLabelsOrBuilder(int index)
public DataAccessLabelReferenceOrBuilder getDeniedDataAccessLabelsOrBuilder(int index)
Optional. The denied labels for the scope.
The logical operator for evaluation of the denied labels is AND.
E.g.: A customer with scope with denied labels A and B won't be able
to see data labeled with A and data labeled with B
and data with labels A and B.
repeated .google.cloud.chronicle.v1.DataAccessLabelReference denied_data_access_labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getDeniedDataAccessLabelsOrBuilderList()
public List<? extends DataAccessLabelReferenceOrBuilder> getDeniedDataAccessLabelsOrBuilderList()
Optional. The denied labels for the scope.
The logical operator for evaluation of the denied labels is AND.
E.g.: A customer with scope with denied labels A and B won't be able
to see data labeled with A and data labeled with B
and data with labels A and B.
repeated .google.cloud.chronicle.v1.DataAccessLabelReference denied_data_access_labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.chronicle.v1.DataAccessLabelReferenceOrBuilder> |
|
getDescription()
public String getDescription()
Optional. A description of the data access scope for a human reader.
string description = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. A description of the data access scope for a human reader.
string description = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getDisplayName()
public String getDisplayName()
Output only. The name to be used for display to customers of the data
access scope.
string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Output only. The name to be used for display to customers of the data
access scope.
string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getLastEditor()
public String getLastEditor()
Output only. The user who last updated the data access scope.
string last_editor = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The lastEditor.
|
getLastEditorBytes()
public ByteString getLastEditorBytes()
Output only. The user who last updated the data access scope.
string last_editor = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for lastEditor.
|
getName()
Required. The unique full name of the data access scope.
The name should comply with https://google.aip.dev/122 standards.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. The unique full name of the data access scope.
The name should comply with https://google.aip.dev/122 standards.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<DataAccessScope> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The time at which the data access scope was last updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time at which the data access scope was last updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. The time at which the data access scope was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The time at which the data access scope was last updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DataAccessScope.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DataAccessScope.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public DataAccessScope.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
