com.google.cloud.retail.v2.ListControlsRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-retail-v2 Show documentation
Proto library for google-cloud-retail
The newest version!
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/retail/v2/control_service.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.retail.v2;

public interface ListControlsRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2.ListControlsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The catalog resource name. Format:
   * `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The parent.
   */
  java.lang.String getParent();
  /**
   *
   *
   *    * Required. The catalog resource name. Format:
   * `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for parent.
   */
  com.google.protobuf.ByteString getParentBytes();

  /**
   *
   *
   *    * Optional. Maximum number of results to return. If unspecified, defaults
   * to 50. Max allowed value is 1000.
   * 
   *
   * int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The pageSize.
   */
  int getPageSize();

  /**
   *
   *
   *    * Optional. A page token, received from a previous `ListControls` call.
   * Provide this to retrieve the subsequent page.
   * 
   *
   * string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The pageToken.
   */
  java.lang.String getPageToken();
  /**
   *
   *
   *    * Optional. A page token, received from a previous `ListControls` call.
   * Provide this to retrieve the subsequent page.
   * 
   *
   * string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for pageToken.
   */
  com.google.protobuf.ByteString getPageTokenBytes();

  /**
   *
   *
   *    * Optional. A filter to apply on the list results. Supported features:
   *
   * * List all the products under the parent branch if
   * [filter][google.cloud.retail.v2.ListControlsRequest.filter] is unset.
   * * List controls that are used in a single ServingConfig:
   *     'serving_config = "boosted_home_page_cvr"'
   * 
   *
   * string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The filter.
   */
  java.lang.String getFilter();
  /**
   *
   *
   *    * Optional. A filter to apply on the list results. Supported features:
   *
   * * List all the products under the parent branch if
   * [filter][google.cloud.retail.v2.ListControlsRequest.filter] is unset.
   * * List controls that are used in a single ServingConfig:
   *     'serving_config = "boosted_home_page_cvr"'
   * 
   *
   * string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for filter.
   */
  com.google.protobuf.ByteString getFilterBytes();
}