/*
* 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/translate/v3beta1/translation_service.proto
// Protobuf Java Version: 3.25.2
package com.google.cloud.translate.v3beta1;
public interface ListGlossariesRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.translation.v3beta1.ListGlossariesRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. The name of the project from which to list all of the glossaries.
*
*
*
* string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
*
*
* @return The parent.
*/
java.lang.String getParent();
/**
*
*
*
* Required. The name of the project from which to list all of the glossaries.
*
*
*
* string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for parent.
*/
com.google.protobuf.ByteString getParentBytes();
/**
*
*
*
* Optional. Requested page size. The server may return fewer glossaries than
* requested. If unspecified, the server picks an appropriate default.
*
*
* int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The pageSize.
*/
int getPageSize();
/**
*
*
*
* Optional. A token identifying a page of results the server should return.
* Typically, this is the value of [ListGlossariesResponse.next_page_token]
* returned from the previous call to `ListGlossaries` method.
* The first page is returned if `page_token`is empty or missing.
*
*
* string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The pageToken.
*/
java.lang.String getPageToken();
/**
*
*
*
* Optional. A token identifying a page of results the server should return.
* Typically, this is the value of [ListGlossariesResponse.next_page_token]
* returned from the previous call to `ListGlossaries` method.
* The first page is returned if `page_token`is empty or missing.
*
*
* string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for pageToken.
*/
com.google.protobuf.ByteString getPageTokenBytes();
/**
*
*
*
* Optional. Filter specifying constraints of a list operation.
* Specify the constraint by the format of "key=value", where key must be
* "src" or "tgt", and the value must be a valid language code.
* For multiple restrictions, concatenate them by "AND" (uppercase only),
* such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used
* here, which means using 'en-US' and 'en' can lead to different results,
* which depends on the language code you used when you create the glossary.
* For the unidirectional glossaries, the "src" and "tgt" add restrictions
* on the source and target language code separately.
* For the equivalent term set glossaries, the "src" and/or "tgt" add
* restrictions on the term set.
* For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional
* glossaries which exactly match the source language code as "en-US" and the
* target language code "zh-CN", but all equivalent term set glossaries which
* contain "en-US" and "zh-CN" in their language set will be picked.
* If missing, no filtering is performed.
*
*
* string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The filter.
*/
java.lang.String getFilter();
/**
*
*
*
* Optional. Filter specifying constraints of a list operation.
* Specify the constraint by the format of "key=value", where key must be
* "src" or "tgt", and the value must be a valid language code.
* For multiple restrictions, concatenate them by "AND" (uppercase only),
* such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used
* here, which means using 'en-US' and 'en' can lead to different results,
* which depends on the language code you used when you create the glossary.
* For the unidirectional glossaries, the "src" and "tgt" add restrictions
* on the source and target language code separately.
* For the equivalent term set glossaries, the "src" and/or "tgt" add
* restrictions on the term set.
* For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional
* glossaries which exactly match the source language code as "en-US" and the
* target language code "zh-CN", but all equivalent term set glossaries which
* contain "en-US" and "zh-CN" in their language set will be picked.
* If missing, no filtering is performed.
*
*
* string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for filter.
*/
com.google.protobuf.ByteString getFilterBytes();
}
