Package com.google.cloud.chronicle.v1

Interface ListRulesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListRulesRequest, ListRulesRequest.Builder
@Generated public interface ListRulesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Only the following filters are allowed: "reference_lists:{reference_list_name}" "data_tables:{data_table_name}" "display_name:{display_name}"
    com.google.protobuf.ByteString
    getFilterBytes()
    Only the following filters are allowed: "reference_lists:{reference_list_name}" "data_tables:{data_table_name}" "display_name:{display_name}"
    int
    getPageSize()
    The maximum number of rules to return.
    String
    getPageToken()
    A page token, received from a previous `ListRules` call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous `ListRules` call.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    RuleView
    getView()
    view indicates the scope of fields to populate for the Rule being returned.
    int
    getViewValue()
    view indicates the scope of fields to populate for the Rule being returned.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      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:
      The parent.

    • getParentBytes

      com.google.protobuf.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:
      The bytes for parent.

    • getPageSize

      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:
      The pageSize.

    • getPageToken

      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:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.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:
      The bytes for pageToken.

    • getViewValue

      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:
      The enum numeric value on the wire for view.

    • getView

      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:
      The view.

    • getFilter

      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:
      The filter.

    • getFilterBytes

      com.google.protobuf.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:
      The bytes for filter.