|
| 1 | +/* |
| 2 | + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except |
| 3 | + * in compliance with the License. You may obtain a copy of the License at |
| 4 | + * |
| 5 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 6 | + * |
| 7 | + * Unless required by applicable law or agreed to in writing, software distributed under the License |
| 8 | + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express |
| 9 | + * or implied. See the License for the specific language governing permissions and limitations under |
| 10 | + * the License. |
| 11 | + */ |
| 12 | +/* |
| 13 | + * This code was generated by https://github.com/googleapis/google-api-java-client-services/ |
| 14 | + * Modify at your own risk. |
| 15 | + */ |
| 16 | + |
| 17 | +package com.google.api.services.networksecurity.v1.model; |
| 18 | + |
| 19 | +/** |
| 20 | + * BackendAuthenticationConfig message groups the TrustConfig together with other settings that |
| 21 | + * control how the load balancer authenticates, and expresses its identity to, the backend: * |
| 22 | + * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance |
| 23 | + * should trust backend server certificates that are issued by public certificate authorities, in |
| 24 | + * addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client |
| 25 | + * certificate that the load balancer uses to express its identity to the backend, if the connection |
| 26 | + * to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer’s |
| 27 | + * BackendService directly determining how that BackendService negotiates TLS. |
| 28 | + * |
| 29 | + * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is |
| 30 | + * transmitted over HTTP when working with the Network Security API. For a detailed explanation see: |
| 31 | + * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a> |
| 32 | + * </p> |
| 33 | + * |
| 34 | + * @author Google, Inc. |
| 35 | + */ |
| 36 | +@SuppressWarnings("javadoc") |
| 37 | +public final class BackendAuthenticationConfig extends com.google.api.client.json.GenericJson { |
| 38 | + |
| 39 | + /** |
| 40 | + * Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a |
| 41 | + * relative resource path following the form |
| 42 | + * "projects/{project}/locations/{location}/certificates/{certificate}". Used by a BackendService |
| 43 | + * to negotiate mTLS when the backend connection uses TLS and the backend requests a client |
| 44 | + * certificate. Must have a CLIENT_AUTH scope. |
| 45 | + * The value may be {@code null}. |
| 46 | + */ |
| 47 | + @com.google.api.client.util.Key |
| 48 | + private java.lang.String clientCertificate; |
| 49 | + |
| 50 | + /** |
| 51 | + * Output only. The timestamp when the resource was created. |
| 52 | + * The value may be {@code null}. |
| 53 | + */ |
| 54 | + @com.google.api.client.util.Key |
| 55 | + private String createTime; |
| 56 | + |
| 57 | + /** |
| 58 | + * Optional. Free-text description of the resource. |
| 59 | + * The value may be {@code null}. |
| 60 | + */ |
| 61 | + @com.google.api.client.util.Key |
| 62 | + private java.lang.String description; |
| 63 | + |
| 64 | + /** |
| 65 | + * Output only. Etag of the resource. |
| 66 | + * The value may be {@code null}. |
| 67 | + */ |
| 68 | + @com.google.api.client.util.Key |
| 69 | + private java.lang.String etag; |
| 70 | + |
| 71 | + /** |
| 72 | + * Set of label tags associated with the resource. |
| 73 | + * The value may be {@code null}. |
| 74 | + */ |
| 75 | + @com.google.api.client.util.Key |
| 76 | + private java.util.Map<String, java.lang.String> labels; |
| 77 | + |
| 78 | + /** |
| 79 | + * Required. Name of the BackendAuthenticationConfig resource. It matches the pattern |
| 80 | + * `projects/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}` |
| 81 | + * The value may be {@code null}. |
| 82 | + */ |
| 83 | + @com.google.api.client.util.Key |
| 84 | + private java.lang.String name; |
| 85 | + |
| 86 | + /** |
| 87 | + * Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com |
| 88 | + * namespace. This is a relative resource path following the form |
| 89 | + * "projects/{project}/locations/{location}/trustConfigs/{trust_config}". A BackendService uses |
| 90 | + * the chain of trust represented by this TrustConfig, if specified, to validate the server |
| 91 | + * certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS. |
| 92 | + * The value may be {@code null}. |
| 93 | + */ |
| 94 | + @com.google.api.client.util.Key |
| 95 | + private java.lang.String trustConfig; |
| 96 | + |
| 97 | + /** |
| 98 | + * Output only. The timestamp when the resource was updated. |
| 99 | + * The value may be {@code null}. |
| 100 | + */ |
| 101 | + @com.google.api.client.util.Key |
| 102 | + private String updateTime; |
| 103 | + |
| 104 | + /** |
| 105 | + * Well known roots to use for server certificate validation. |
| 106 | + * The value may be {@code null}. |
| 107 | + */ |
| 108 | + @com.google.api.client.util.Key |
| 109 | + private java.lang.String wellKnownRoots; |
| 110 | + |
| 111 | + /** |
| 112 | + * Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a |
| 113 | + * relative resource path following the form |
| 114 | + * "projects/{project}/locations/{location}/certificates/{certificate}". Used by a BackendService |
| 115 | + * to negotiate mTLS when the backend connection uses TLS and the backend requests a client |
| 116 | + * certificate. Must have a CLIENT_AUTH scope. |
| 117 | + * @return value or {@code null} for none |
| 118 | + */ |
| 119 | + public java.lang.String getClientCertificate() { |
| 120 | + return clientCertificate; |
| 121 | + } |
| 122 | + |
| 123 | + /** |
| 124 | + * Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a |
| 125 | + * relative resource path following the form |
| 126 | + * "projects/{project}/locations/{location}/certificates/{certificate}". Used by a BackendService |
| 127 | + * to negotiate mTLS when the backend connection uses TLS and the backend requests a client |
| 128 | + * certificate. Must have a CLIENT_AUTH scope. |
| 129 | + * @param clientCertificate clientCertificate or {@code null} for none |
| 130 | + */ |
| 131 | + public BackendAuthenticationConfig setClientCertificate(java.lang.String clientCertificate) { |
| 132 | + this.clientCertificate = clientCertificate; |
| 133 | + return this; |
| 134 | + } |
| 135 | + |
| 136 | + /** |
| 137 | + * Output only. The timestamp when the resource was created. |
| 138 | + * @return value or {@code null} for none |
| 139 | + */ |
| 140 | + public String getCreateTime() { |
| 141 | + return createTime; |
| 142 | + } |
| 143 | + |
| 144 | + /** |
| 145 | + * Output only. The timestamp when the resource was created. |
| 146 | + * @param createTime createTime or {@code null} for none |
| 147 | + */ |
| 148 | + public BackendAuthenticationConfig setCreateTime(String createTime) { |
| 149 | + this.createTime = createTime; |
| 150 | + return this; |
| 151 | + } |
| 152 | + |
| 153 | + /** |
| 154 | + * Optional. Free-text description of the resource. |
| 155 | + * @return value or {@code null} for none |
| 156 | + */ |
| 157 | + public java.lang.String getDescription() { |
| 158 | + return description; |
| 159 | + } |
| 160 | + |
| 161 | + /** |
| 162 | + * Optional. Free-text description of the resource. |
| 163 | + * @param description description or {@code null} for none |
| 164 | + */ |
| 165 | + public BackendAuthenticationConfig setDescription(java.lang.String description) { |
| 166 | + this.description = description; |
| 167 | + return this; |
| 168 | + } |
| 169 | + |
| 170 | + /** |
| 171 | + * Output only. Etag of the resource. |
| 172 | + * @return value or {@code null} for none |
| 173 | + */ |
| 174 | + public java.lang.String getEtag() { |
| 175 | + return etag; |
| 176 | + } |
| 177 | + |
| 178 | + /** |
| 179 | + * Output only. Etag of the resource. |
| 180 | + * @param etag etag or {@code null} for none |
| 181 | + */ |
| 182 | + public BackendAuthenticationConfig setEtag(java.lang.String etag) { |
| 183 | + this.etag = etag; |
| 184 | + return this; |
| 185 | + } |
| 186 | + |
| 187 | + /** |
| 188 | + * Set of label tags associated with the resource. |
| 189 | + * @return value or {@code null} for none |
| 190 | + */ |
| 191 | + public java.util.Map<String, java.lang.String> getLabels() { |
| 192 | + return labels; |
| 193 | + } |
| 194 | + |
| 195 | + /** |
| 196 | + * Set of label tags associated with the resource. |
| 197 | + * @param labels labels or {@code null} for none |
| 198 | + */ |
| 199 | + public BackendAuthenticationConfig setLabels(java.util.Map<String, java.lang.String> labels) { |
| 200 | + this.labels = labels; |
| 201 | + return this; |
| 202 | + } |
| 203 | + |
| 204 | + /** |
| 205 | + * Required. Name of the BackendAuthenticationConfig resource. It matches the pattern |
| 206 | + * `projects/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}` |
| 207 | + * @return value or {@code null} for none |
| 208 | + */ |
| 209 | + public java.lang.String getName() { |
| 210 | + return name; |
| 211 | + } |
| 212 | + |
| 213 | + /** |
| 214 | + * Required. Name of the BackendAuthenticationConfig resource. It matches the pattern |
| 215 | + * `projects/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}` |
| 216 | + * @param name name or {@code null} for none |
| 217 | + */ |
| 218 | + public BackendAuthenticationConfig setName(java.lang.String name) { |
| 219 | + this.name = name; |
| 220 | + return this; |
| 221 | + } |
| 222 | + |
| 223 | + /** |
| 224 | + * Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com |
| 225 | + * namespace. This is a relative resource path following the form |
| 226 | + * "projects/{project}/locations/{location}/trustConfigs/{trust_config}". A BackendService uses |
| 227 | + * the chain of trust represented by this TrustConfig, if specified, to validate the server |
| 228 | + * certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS. |
| 229 | + * @return value or {@code null} for none |
| 230 | + */ |
| 231 | + public java.lang.String getTrustConfig() { |
| 232 | + return trustConfig; |
| 233 | + } |
| 234 | + |
| 235 | + /** |
| 236 | + * Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com |
| 237 | + * namespace. This is a relative resource path following the form |
| 238 | + * "projects/{project}/locations/{location}/trustConfigs/{trust_config}". A BackendService uses |
| 239 | + * the chain of trust represented by this TrustConfig, if specified, to validate the server |
| 240 | + * certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS. |
| 241 | + * @param trustConfig trustConfig or {@code null} for none |
| 242 | + */ |
| 243 | + public BackendAuthenticationConfig setTrustConfig(java.lang.String trustConfig) { |
| 244 | + this.trustConfig = trustConfig; |
| 245 | + return this; |
| 246 | + } |
| 247 | + |
| 248 | + /** |
| 249 | + * Output only. The timestamp when the resource was updated. |
| 250 | + * @return value or {@code null} for none |
| 251 | + */ |
| 252 | + public String getUpdateTime() { |
| 253 | + return updateTime; |
| 254 | + } |
| 255 | + |
| 256 | + /** |
| 257 | + * Output only. The timestamp when the resource was updated. |
| 258 | + * @param updateTime updateTime or {@code null} for none |
| 259 | + */ |
| 260 | + public BackendAuthenticationConfig setUpdateTime(String updateTime) { |
| 261 | + this.updateTime = updateTime; |
| 262 | + return this; |
| 263 | + } |
| 264 | + |
| 265 | + /** |
| 266 | + * Well known roots to use for server certificate validation. |
| 267 | + * @return value or {@code null} for none |
| 268 | + */ |
| 269 | + public java.lang.String getWellKnownRoots() { |
| 270 | + return wellKnownRoots; |
| 271 | + } |
| 272 | + |
| 273 | + /** |
| 274 | + * Well known roots to use for server certificate validation. |
| 275 | + * @param wellKnownRoots wellKnownRoots or {@code null} for none |
| 276 | + */ |
| 277 | + public BackendAuthenticationConfig setWellKnownRoots(java.lang.String wellKnownRoots) { |
| 278 | + this.wellKnownRoots = wellKnownRoots; |
| 279 | + return this; |
| 280 | + } |
| 281 | + |
| 282 | + @Override |
| 283 | + public BackendAuthenticationConfig set(String fieldName, Object value) { |
| 284 | + return (BackendAuthenticationConfig) super.set(fieldName, value); |
| 285 | + } |
| 286 | + |
| 287 | + @Override |
| 288 | + public BackendAuthenticationConfig clone() { |
| 289 | + return (BackendAuthenticationConfig) super.clone(); |
| 290 | + } |
| 291 | + |
| 292 | +} |
0 commit comments