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 ListCryptoKeysRequestOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.kms.v1.ListCryptoKeysRequest) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The resource name of the [KeyRing][google.cloud.kms.v1.KeyRing] 31 * to list, in the format `projects/*/locations/*/keyRings/*`. 32 * </pre> 33 * 34 * <code> 35 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 36 * </code> 37 * 38 * @return The parent. 39 */ getParent()40 java.lang.String getParent(); 41 /** 42 * 43 * 44 * <pre> 45 * Required. The resource name of the [KeyRing][google.cloud.kms.v1.KeyRing] 46 * to list, in the format `projects/*/locations/*/keyRings/*`. 47 * </pre> 48 * 49 * <code> 50 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 51 * </code> 52 * 53 * @return The bytes for parent. 54 */ getParentBytes()55 com.google.protobuf.ByteString getParentBytes(); 56 57 /** 58 * 59 * 60 * <pre> 61 * Optional. Optional limit on the number of 62 * [CryptoKeys][google.cloud.kms.v1.CryptoKey] to include in the response. 63 * Further [CryptoKeys][google.cloud.kms.v1.CryptoKey] can subsequently be 64 * obtained by including the 65 * [ListCryptoKeysResponse.next_page_token][google.cloud.kms.v1.ListCryptoKeysResponse.next_page_token] 66 * in a subsequent request. If unspecified, the server will pick an 67 * appropriate default. 68 * </pre> 69 * 70 * <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code> 71 * 72 * @return The pageSize. 73 */ getPageSize()74 int getPageSize(); 75 76 /** 77 * 78 * 79 * <pre> 80 * Optional. Optional pagination token, returned earlier via 81 * [ListCryptoKeysResponse.next_page_token][google.cloud.kms.v1.ListCryptoKeysResponse.next_page_token]. 82 * </pre> 83 * 84 * <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 85 * 86 * @return The pageToken. 87 */ getPageToken()88 java.lang.String getPageToken(); 89 /** 90 * 91 * 92 * <pre> 93 * Optional. Optional pagination token, returned earlier via 94 * [ListCryptoKeysResponse.next_page_token][google.cloud.kms.v1.ListCryptoKeysResponse.next_page_token]. 95 * </pre> 96 * 97 * <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 98 * 99 * @return The bytes for pageToken. 100 */ getPageTokenBytes()101 com.google.protobuf.ByteString getPageTokenBytes(); 102 103 /** 104 * 105 * 106 * <pre> 107 * The fields of the primary version to include in the response. 108 * </pre> 109 * 110 * <code>.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView version_view = 4;</code> 111 * 112 * @return The enum numeric value on the wire for versionView. 113 */ getVersionViewValue()114 int getVersionViewValue(); 115 /** 116 * 117 * 118 * <pre> 119 * The fields of the primary version to include in the response. 120 * </pre> 121 * 122 * <code>.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView version_view = 4;</code> 123 * 124 * @return The versionView. 125 */ getVersionView()126 com.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView getVersionView(); 127 128 /** 129 * 130 * 131 * <pre> 132 * Optional. Only include resources that match the filter in the response. For 133 * more information, see 134 * [Sorting and filtering list 135 * results](https://cloud.google.com/kms/docs/sorting-and-filtering). 136 * </pre> 137 * 138 * <code>string filter = 5 [(.google.api.field_behavior) = OPTIONAL];</code> 139 * 140 * @return The filter. 141 */ getFilter()142 java.lang.String getFilter(); 143 /** 144 * 145 * 146 * <pre> 147 * Optional. Only include resources that match the filter in the response. For 148 * more information, see 149 * [Sorting and filtering list 150 * results](https://cloud.google.com/kms/docs/sorting-and-filtering). 151 * </pre> 152 * 153 * <code>string filter = 5 [(.google.api.field_behavior) = OPTIONAL];</code> 154 * 155 * @return The bytes for filter. 156 */ getFilterBytes()157 com.google.protobuf.ByteString getFilterBytes(); 158 159 /** 160 * 161 * 162 * <pre> 163 * Optional. Specify how the results should be sorted. If not specified, the 164 * results will be sorted in the default order. For more information, see 165 * [Sorting and filtering list 166 * results](https://cloud.google.com/kms/docs/sorting-and-filtering). 167 * </pre> 168 * 169 * <code>string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 170 * 171 * @return The orderBy. 172 */ getOrderBy()173 java.lang.String getOrderBy(); 174 /** 175 * 176 * 177 * <pre> 178 * Optional. Specify how the results should be sorted. If not specified, the 179 * results will be sorted in the default order. For more information, see 180 * [Sorting and filtering list 181 * results](https://cloud.google.com/kms/docs/sorting-and-filtering). 182 * </pre> 183 * 184 * <code>string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 185 * 186 * @return The bytes for orderBy. 187 */ getOrderByBytes()188 com.google.protobuf.ByteString getOrderByBytes(); 189 } 190