1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/kms/v1/service.proto 18 19 package com.google.cloud.kms.v1; 20 21 public interface ListKeyRingsRequestOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.kms.v1.ListKeyRingsRequest) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The resource name of the location associated with the 31 * [KeyRings][google.cloud.kms.v1.KeyRing], in the format 32 * `projects/*/locations/*`. 33 * </pre> 34 * 35 * <code> 36 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 37 * </code> 38 * 39 * @return The parent. 40 */ getParent()41 java.lang.String getParent(); 42 /** 43 * 44 * 45 * <pre> 46 * Required. The resource name of the location associated with the 47 * [KeyRings][google.cloud.kms.v1.KeyRing], in the format 48 * `projects/*/locations/*`. 49 * </pre> 50 * 51 * <code> 52 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 53 * </code> 54 * 55 * @return The bytes for parent. 56 */ getParentBytes()57 com.google.protobuf.ByteString getParentBytes(); 58 59 /** 60 * 61 * 62 * <pre> 63 * Optional. Optional limit on the number of 64 * [KeyRings][google.cloud.kms.v1.KeyRing] to include in the response. Further 65 * [KeyRings][google.cloud.kms.v1.KeyRing] can subsequently be obtained by 66 * including the 67 * [ListKeyRingsResponse.next_page_token][google.cloud.kms.v1.ListKeyRingsResponse.next_page_token] 68 * in a subsequent request. If unspecified, the server will pick an 69 * appropriate default. 70 * </pre> 71 * 72 * <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code> 73 * 74 * @return The pageSize. 75 */ getPageSize()76 int getPageSize(); 77 78 /** 79 * 80 * 81 * <pre> 82 * Optional. Optional pagination token, returned earlier via 83 * [ListKeyRingsResponse.next_page_token][google.cloud.kms.v1.ListKeyRingsResponse.next_page_token]. 84 * </pre> 85 * 86 * <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 87 * 88 * @return The pageToken. 89 */ getPageToken()90 java.lang.String getPageToken(); 91 /** 92 * 93 * 94 * <pre> 95 * Optional. Optional pagination token, returned earlier via 96 * [ListKeyRingsResponse.next_page_token][google.cloud.kms.v1.ListKeyRingsResponse.next_page_token]. 97 * </pre> 98 * 99 * <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 100 * 101 * @return The bytes for pageToken. 102 */ getPageTokenBytes()103 com.google.protobuf.ByteString getPageTokenBytes(); 104 105 /** 106 * 107 * 108 * <pre> 109 * Optional. Only include resources that match the filter in the response. For 110 * more information, see 111 * [Sorting and filtering list 112 * results](https://cloud.google.com/kms/docs/sorting-and-filtering). 113 * </pre> 114 * 115 * <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 116 * 117 * @return The filter. 118 */ getFilter()119 java.lang.String getFilter(); 120 /** 121 * 122 * 123 * <pre> 124 * Optional. Only include resources that match the filter in the response. For 125 * more information, see 126 * [Sorting and filtering list 127 * results](https://cloud.google.com/kms/docs/sorting-and-filtering). 128 * </pre> 129 * 130 * <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 131 * 132 * @return The bytes for filter. 133 */ getFilterBytes()134 com.google.protobuf.ByteString getFilterBytes(); 135 136 /** 137 * 138 * 139 * <pre> 140 * Optional. Specify how the results should be sorted. If not specified, the 141 * results will be sorted in the default order. For more information, see 142 * [Sorting and filtering list 143 * results](https://cloud.google.com/kms/docs/sorting-and-filtering). 144 * </pre> 145 * 146 * <code>string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];</code> 147 * 148 * @return The orderBy. 149 */ getOrderBy()150 java.lang.String getOrderBy(); 151 /** 152 * 153 * 154 * <pre> 155 * Optional. Specify how the results should be sorted. If not specified, the 156 * results will be sorted in the default order. For more information, see 157 * [Sorting and filtering list 158 * results](https://cloud.google.com/kms/docs/sorting-and-filtering). 159 * </pre> 160 * 161 * <code>string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];</code> 162 * 163 * @return The bytes for orderBy. 164 */ getOrderByBytes()165 com.google.protobuf.ByteString getOrderByBytes(); 166 } 167