Class DataAccessScope.Builder (0.1.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllAllowedDataAccessLabels(Iterable<? extends DataAccessLabelReference> values)

public DataAccessScope.Builder addAllAllowedDataAccessLabels(Iterable<? extends DataAccessLabelReference> values)

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
values Iterable<? extends com.google.cloud.chronicle.v1.DataAccessLabelReference>
Returns
Type Description
DataAccessScope.Builder

addAllDeniedDataAccessLabels(Iterable<? extends DataAccessLabelReference> values)

public DataAccessScope.Builder addAllDeniedDataAccessLabels(Iterable<? extends DataAccessLabelReference> values)

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
values Iterable<? extends com.google.cloud.chronicle.v1.DataAccessLabelReference>
Returns
Type Description
DataAccessScope.Builder

addAllowedDataAccessLabels(DataAccessLabelReference value)

public DataAccessScope.Builder addAllowedDataAccessLabels(DataAccessLabelReference value)

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
value DataAccessLabelReference
Returns
Type Description
DataAccessScope.Builder

addAllowedDataAccessLabels(DataAccessLabelReference.Builder builderForValue)

public DataAccessScope.Builder addAllowedDataAccessLabels(DataAccessLabelReference.Builder builderForValue)

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
builderForValue DataAccessLabelReference.Builder
Returns
Type Description
DataAccessScope.Builder

addAllowedDataAccessLabels(int index, DataAccessLabelReference value)

public DataAccessScope.Builder addAllowedDataAccessLabels(int index, DataAccessLabelReference value)

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

Parameters
Name Description
index int
value DataAccessLabelReference
Returns
Type Description
DataAccessScope.Builder

addAllowedDataAccessLabels(int index, DataAccessLabelReference.Builder builderForValue)

public DataAccessScope.Builder addAllowedDataAccessLabels(int index, DataAccessLabelReference.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue DataAccessLabelReference.Builder
Returns
Type Description
DataAccessScope.Builder

addAllowedDataAccessLabelsBuilder()

public DataAccessLabelReference.Builder addAllowedDataAccessLabelsBuilder()

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
DataAccessLabelReference.Builder

addAllowedDataAccessLabelsBuilder(int index)

public DataAccessLabelReference.Builder addAllowedDataAccessLabelsBuilder(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
Returns
Type Description
DataAccessLabelReference.Builder

addDeniedDataAccessLabels(DataAccessLabelReference value)

public DataAccessScope.Builder addDeniedDataAccessLabels(DataAccessLabelReference value)

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
value DataAccessLabelReference
Returns
Type Description
DataAccessScope.Builder

addDeniedDataAccessLabels(DataAccessLabelReference.Builder builderForValue)

public DataAccessScope.Builder addDeniedDataAccessLabels(DataAccessLabelReference.Builder builderForValue)

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
builderForValue DataAccessLabelReference.Builder
Returns
Type Description
DataAccessScope.Builder

addDeniedDataAccessLabels(int index, DataAccessLabelReference value)

public DataAccessScope.Builder addDeniedDataAccessLabels(int index, DataAccessLabelReference value)

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

Parameters
Name Description
index int
value DataAccessLabelReference
Returns
Type Description
DataAccessScope.Builder

addDeniedDataAccessLabels(int index, DataAccessLabelReference.Builder builderForValue)

public DataAccessScope.Builder addDeniedDataAccessLabels(int index, DataAccessLabelReference.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue DataAccessLabelReference.Builder
Returns
Type Description
DataAccessScope.Builder

addDeniedDataAccessLabelsBuilder()

public DataAccessLabelReference.Builder addDeniedDataAccessLabelsBuilder()

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
DataAccessLabelReference.Builder

addDeniedDataAccessLabelsBuilder(int index)

public DataAccessLabelReference.Builder addDeniedDataAccessLabelsBuilder(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
Returns
Type Description
DataAccessLabelReference.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DataAccessScope.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DataAccessScope.Builder
Overrides

build()

public DataAccessScope build()
Returns
Type Description
DataAccessScope

buildPartial()

public DataAccessScope buildPartial()
Returns
Type Description
DataAccessScope

clear()

public DataAccessScope.Builder clear()
Returns
Type Description
DataAccessScope.Builder
Overrides

clearAllowAll()

public DataAccessScope.Builder clearAllowAll()

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
DataAccessScope.Builder

This builder for chaining.

clearAllowedDataAccessLabels()

public DataAccessScope.Builder clearAllowedDataAccessLabels()

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
DataAccessScope.Builder

clearAuthor()

public DataAccessScope.Builder clearAuthor()

Output only. The user who created the data access scope.

string author = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataAccessScope.Builder

This builder for chaining.

clearCreateTime()

public DataAccessScope.Builder clearCreateTime()

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
DataAccessScope.Builder

clearDeniedDataAccessLabels()

public DataAccessScope.Builder clearDeniedDataAccessLabels()

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
DataAccessScope.Builder

clearDescription()

public DataAccessScope.Builder clearDescription()

Optional. A description of the data access scope for a human reader.

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataAccessScope.Builder

This builder for chaining.

clearDisplayName()

public DataAccessScope.Builder clearDisplayName()

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
DataAccessScope.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DataAccessScope.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DataAccessScope.Builder
Overrides

clearLastEditor()

public DataAccessScope.Builder clearLastEditor()

Output only. The user who last updated the data access scope.

string last_editor = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataAccessScope.Builder

This builder for chaining.

clearName()

public DataAccessScope.Builder clearName()

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
DataAccessScope.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DataAccessScope.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DataAccessScope.Builder
Overrides

clearUpdateTime()

public DataAccessScope.Builder clearUpdateTime()

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
DataAccessScope.Builder

clone()

public DataAccessScope.Builder clone()
Returns
Type Description
DataAccessScope.Builder
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
Returns
Type Description
DataAccessLabelReference

getAllowedDataAccessLabelsBuilder(int index)

public DataAccessLabelReference.Builder getAllowedDataAccessLabelsBuilder(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
Returns
Type Description
DataAccessLabelReference.Builder

getAllowedDataAccessLabelsBuilderList()

public List<DataAccessLabelReference.Builder> getAllowedDataAccessLabelsBuilderList()

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

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

Returns
Type Description
List<DataAccessLabelReference>

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
Returns
Type Description
DataAccessLabelReferenceOrBuilder

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public DataAccessScope getDefaultInstanceForType()
Returns
Type Description
DataAccessScope

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
Returns
Type Description
DataAccessLabelReference

getDeniedDataAccessLabelsBuilder(int index)

public DataAccessLabelReference.Builder getDeniedDataAccessLabelsBuilder(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
Returns
Type Description
DataAccessLabelReference.Builder

getDeniedDataAccessLabelsBuilderList()

public List<DataAccessLabelReference.Builder> getDeniedDataAccessLabelsBuilderList()

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

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

Returns
Type Description
List<DataAccessLabelReference>

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
Returns
Type Description
DataAccessLabelReferenceOrBuilder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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()

public String 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.

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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

Returns
Type Description
TimestampOrBuilder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public DataAccessScope.Builder mergeCreateTime(Timestamp value)

Output only. The time at which the data access scope was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataAccessScope.Builder

mergeFrom(DataAccessScope other)

public DataAccessScope.Builder mergeFrom(DataAccessScope other)
Parameter
Name Description
other DataAccessScope
Returns
Type Description
DataAccessScope.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataAccessScope.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataAccessScope.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DataAccessScope.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DataAccessScope.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DataAccessScope.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DataAccessScope.Builder
Overrides

mergeUpdateTime(Timestamp value)

public DataAccessScope.Builder mergeUpdateTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
DataAccessScope.Builder

removeAllowedDataAccessLabels(int index)

public DataAccessScope.Builder removeAllowedDataAccessLabels(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
Returns
Type Description
DataAccessScope.Builder

removeDeniedDataAccessLabels(int index)

public DataAccessScope.Builder removeDeniedDataAccessLabels(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
Returns
Type Description
DataAccessScope.Builder

setAllowAll(boolean value)

public DataAccessScope.Builder setAllowAll(boolean value)

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

Parameter
Name Description
value boolean

The allowAll to set.

Returns
Type Description
DataAccessScope.Builder

This builder for chaining.

setAllowedDataAccessLabels(int index, DataAccessLabelReference value)

public DataAccessScope.Builder setAllowedDataAccessLabels(int index, DataAccessLabelReference value)

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

Parameters
Name Description
index int
value DataAccessLabelReference
Returns
Type Description
DataAccessScope.Builder

setAllowedDataAccessLabels(int index, DataAccessLabelReference.Builder builderForValue)

public DataAccessScope.Builder setAllowedDataAccessLabels(int index, DataAccessLabelReference.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue DataAccessLabelReference.Builder
Returns
Type Description
DataAccessScope.Builder

setAuthor(String value)

public DataAccessScope.Builder setAuthor(String value)

Output only. The user who created the data access scope.

string author = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The author to set.

Returns
Type Description
DataAccessScope.Builder

This builder for chaining.

setAuthorBytes(ByteString value)

public DataAccessScope.Builder setAuthorBytes(ByteString value)

Output only. The user who created the data access scope.

string author = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for author to set.

Returns
Type Description
DataAccessScope.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public DataAccessScope.Builder setCreateTime(Timestamp value)

Output only. The time at which the data access scope was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataAccessScope.Builder

setCreateTime(Timestamp.Builder builderForValue)

public DataAccessScope.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time at which the data access scope was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataAccessScope.Builder

setDeniedDataAccessLabels(int index, DataAccessLabelReference value)

public DataAccessScope.Builder setDeniedDataAccessLabels(int index, DataAccessLabelReference value)

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

Parameters
Name Description
index int
value DataAccessLabelReference
Returns
Type Description
DataAccessScope.Builder

setDeniedDataAccessLabels(int index, DataAccessLabelReference.Builder builderForValue)

public DataAccessScope.Builder setDeniedDataAccessLabels(int index, DataAccessLabelReference.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue DataAccessLabelReference.Builder
Returns
Type Description
DataAccessScope.Builder

setDescription(String value)

public DataAccessScope.Builder setDescription(String value)

Optional. A description of the data access scope for a human reader.

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
DataAccessScope.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public DataAccessScope.Builder setDescriptionBytes(ByteString value)

Optional. A description of the data access scope for a human reader.

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
DataAccessScope.Builder

This builder for chaining.

setDisplayName(String value)

public DataAccessScope.Builder setDisplayName(String value)

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
DataAccessScope.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public DataAccessScope.Builder setDisplayNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
DataAccessScope.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DataAccessScope.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DataAccessScope.Builder
Overrides

setLastEditor(String value)

public DataAccessScope.Builder setLastEditor(String value)

Output only. The user who last updated the data access scope.

string last_editor = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The lastEditor to set.

Returns
Type Description
DataAccessScope.Builder

This builder for chaining.

setLastEditorBytes(ByteString value)

public DataAccessScope.Builder setLastEditorBytes(ByteString value)

Output only. The user who last updated the data access scope.

string last_editor = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for lastEditor to set.

Returns
Type Description
DataAccessScope.Builder

This builder for chaining.

setName(String value)

public DataAccessScope.Builder setName(String value)

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) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DataAccessScope.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DataAccessScope.Builder setNameBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DataAccessScope.Builder

This builder for chaining.

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

public DataAccessScope.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DataAccessScope.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DataAccessScope.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DataAccessScope.Builder
Overrides

setUpdateTime(Timestamp value)

public DataAccessScope.Builder setUpdateTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
DataAccessScope.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public DataAccessScope.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataAccessScope.Builder