Class ListRulesRequest.Builder (0.1.0)

public static final class ListRulesRequest.Builder extends GeneratedMessageV3.Builder<ListRulesRequest.Builder> implements ListRulesRequestOrBuilder

Request message for ListRules method.

Protobuf type google.cloud.chronicle.v1.ListRulesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListRulesRequest build()
Returns
Type Description
ListRulesRequest

buildPartial()

public ListRulesRequest buildPartial()
Returns
Type Description
ListRulesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListRulesRequest.Builder clearFilter()

Only the following filters are allowed: "reference_lists:{reference_list_name}" "data_tables:{data_table_name}" "display_name:{display_name}"

string filter = 5;

Returns
Type Description
ListRulesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListRulesRequest.Builder clearPageSize()

The maximum number of rules to return. The service may return fewer than this value. If unspecified, at most 100 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Returns
Type Description
ListRulesRequest.Builder

This builder for chaining.

clearPageToken()

public ListRulesRequest.Builder clearPageToken()

A page token, received from a previous ListRules call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListRules must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
ListRulesRequest.Builder

This builder for chaining.

clearParent()

public ListRulesRequest.Builder clearParent()

Required. The parent, which owns this collection of rules. Format: projects/{project}/locations/{location}/instances/{instance}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListRulesRequest.Builder

This builder for chaining.

clearView()

public ListRulesRequest.Builder clearView()

view indicates the scope of fields to populate for the Rule being returned. If unspecified, defaults to BASIC.

.google.cloud.chronicle.v1.RuleView view = 4;

Returns
Type Description
ListRulesRequest.Builder

This builder for chaining.

clone()

public ListRulesRequest.Builder clone()
Returns
Type Description
ListRulesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListRulesRequest getDefaultInstanceForType()
Returns
Type Description
ListRulesRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Only the following filters are allowed: "reference_lists:{reference_list_name}" "data_tables:{data_table_name}" "display_name:{display_name}"

string filter = 5;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Only the following filters are allowed: "reference_lists:{reference_list_name}" "data_tables:{data_table_name}" "display_name:{display_name}"

string filter = 5;

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

The maximum number of rules to return. The service may return fewer than this value. If unspecified, at most 100 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A page token, received from a previous ListRules call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListRules must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token, received from a previous ListRules call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListRules must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent, which owns this collection of rules. Format: projects/{project}/locations/{location}/instances/{instance}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent, which owns this collection of rules. Format: projects/{project}/locations/{location}/instances/{instance}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getView()

public RuleView getView()

view indicates the scope of fields to populate for the Rule being returned. If unspecified, defaults to BASIC.

.google.cloud.chronicle.v1.RuleView view = 4;

Returns
Type Description
RuleView

The view.

getViewValue()

public int getViewValue()

view indicates the scope of fields to populate for the Rule being returned. If unspecified, defaults to BASIC.

.google.cloud.chronicle.v1.RuleView view = 4;

Returns
Type Description
int

The enum numeric value on the wire for view.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListRulesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListRulesRequest.Builder setFilter(String value)

Only the following filters are allowed: "reference_lists:{reference_list_name}" "data_tables:{data_table_name}" "display_name:{display_name}"

string filter = 5;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListRulesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListRulesRequest.Builder setFilterBytes(ByteString value)

Only the following filters are allowed: "reference_lists:{reference_list_name}" "data_tables:{data_table_name}" "display_name:{display_name}"

string filter = 5;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListRulesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListRulesRequest.Builder setPageSize(int value)

The maximum number of rules to return. The service may return fewer than this value. If unspecified, at most 100 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListRulesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListRulesRequest.Builder setPageToken(String value)

A page token, received from a previous ListRules call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListRules must match the call that provided the page token.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListRulesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListRulesRequest.Builder setPageTokenBytes(ByteString value)

A page token, received from a previous ListRules call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListRules must match the call that provided the page token.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListRulesRequest.Builder

This builder for chaining.

setParent(String value)

public ListRulesRequest.Builder setParent(String value)

Required. The parent, which owns this collection of rules. Format: projects/{project}/locations/{location}/instances/{instance}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListRulesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListRulesRequest.Builder setParentBytes(ByteString value)

Required. The parent, which owns this collection of rules. Format: projects/{project}/locations/{location}/instances/{instance}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListRulesRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setView(RuleView value)

public ListRulesRequest.Builder setView(RuleView value)

view indicates the scope of fields to populate for the Rule being returned. If unspecified, defaults to BASIC.

.google.cloud.chronicle.v1.RuleView view = 4;

Parameter
Name Description
value RuleView

The view to set.

Returns
Type Description
ListRulesRequest.Builder

This builder for chaining.

setViewValue(int value)

public ListRulesRequest.Builder setViewValue(int value)

view indicates the scope of fields to populate for the Rule being returned. If unspecified, defaults to BASIC.

.google.cloud.chronicle.v1.RuleView view = 4;

Parameter
Name Description
value int

The enum numeric value on the wire for view to set.

Returns
Type Description
ListRulesRequest.Builder

This builder for chaining.