|
| 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.aiplatform.v1.model; |
| 18 | + |
| 19 | +/** |
| 20 | + * Config for authentication with API key. |
| 21 | + * |
| 22 | + * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is |
| 23 | + * transmitted over HTTP when working with the Vertex AI API. For a detailed explanation see: |
| 24 | + * <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> |
| 25 | + * </p> |
| 26 | + * |
| 27 | + * @author Google, Inc. |
| 28 | + */ |
| 29 | +@SuppressWarnings("javadoc") |
| 30 | +public final class GoogleCloudAiplatformV1AuthConfigApiKeyConfig extends com.google.api.client.json.GenericJson { |
| 31 | + |
| 32 | + /** |
| 33 | + * Optional. The name of the SecretManager secret version resource storing the API key. Format: |
| 34 | + * `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and |
| 35 | + * `api_key_string` are specified, this field takes precedence over `api_key_string`. - If |
| 36 | + * specified, the `secretmanager.versions.access` permission should be granted to Vertex AI |
| 37 | + * Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access- |
| 38 | + * control#service-agents) on the specified resource. |
| 39 | + * The value may be {@code null}. |
| 40 | + */ |
| 41 | + @com.google.api.client.util.Key |
| 42 | + private java.lang.String apiKeySecret; |
| 43 | + |
| 44 | + /** |
| 45 | + * Optional. The API key to be used in the request directly. |
| 46 | + * The value may be {@code null}. |
| 47 | + */ |
| 48 | + @com.google.api.client.util.Key |
| 49 | + private java.lang.String apiKeyString; |
| 50 | + |
| 51 | + /** |
| 52 | + * Optional. The location of the API key. |
| 53 | + * The value may be {@code null}. |
| 54 | + */ |
| 55 | + @com.google.api.client.util.Key |
| 56 | + private java.lang.String httpElementLocation; |
| 57 | + |
| 58 | + /** |
| 59 | + * Optional. The parameter name of the API key. E.g. If the API request is |
| 60 | + * "https://example.com/act?api_key=", "api_key" would be the parameter name. |
| 61 | + * The value may be {@code null}. |
| 62 | + */ |
| 63 | + @com.google.api.client.util.Key |
| 64 | + private java.lang.String name; |
| 65 | + |
| 66 | + /** |
| 67 | + * Optional. The name of the SecretManager secret version resource storing the API key. Format: |
| 68 | + * `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and |
| 69 | + * `api_key_string` are specified, this field takes precedence over `api_key_string`. - If |
| 70 | + * specified, the `secretmanager.versions.access` permission should be granted to Vertex AI |
| 71 | + * Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access- |
| 72 | + * control#service-agents) on the specified resource. |
| 73 | + * @return value or {@code null} for none |
| 74 | + */ |
| 75 | + public java.lang.String getApiKeySecret() { |
| 76 | + return apiKeySecret; |
| 77 | + } |
| 78 | + |
| 79 | + /** |
| 80 | + * Optional. The name of the SecretManager secret version resource storing the API key. Format: |
| 81 | + * `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and |
| 82 | + * `api_key_string` are specified, this field takes precedence over `api_key_string`. - If |
| 83 | + * specified, the `secretmanager.versions.access` permission should be granted to Vertex AI |
| 84 | + * Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access- |
| 85 | + * control#service-agents) on the specified resource. |
| 86 | + * @param apiKeySecret apiKeySecret or {@code null} for none |
| 87 | + */ |
| 88 | + public GoogleCloudAiplatformV1AuthConfigApiKeyConfig setApiKeySecret(java.lang.String apiKeySecret) { |
| 89 | + this.apiKeySecret = apiKeySecret; |
| 90 | + return this; |
| 91 | + } |
| 92 | + |
| 93 | + /** |
| 94 | + * Optional. The API key to be used in the request directly. |
| 95 | + * @return value or {@code null} for none |
| 96 | + */ |
| 97 | + public java.lang.String getApiKeyString() { |
| 98 | + return apiKeyString; |
| 99 | + } |
| 100 | + |
| 101 | + /** |
| 102 | + * Optional. The API key to be used in the request directly. |
| 103 | + * @param apiKeyString apiKeyString or {@code null} for none |
| 104 | + */ |
| 105 | + public GoogleCloudAiplatformV1AuthConfigApiKeyConfig setApiKeyString(java.lang.String apiKeyString) { |
| 106 | + this.apiKeyString = apiKeyString; |
| 107 | + return this; |
| 108 | + } |
| 109 | + |
| 110 | + /** |
| 111 | + * Optional. The location of the API key. |
| 112 | + * @return value or {@code null} for none |
| 113 | + */ |
| 114 | + public java.lang.String getHttpElementLocation() { |
| 115 | + return httpElementLocation; |
| 116 | + } |
| 117 | + |
| 118 | + /** |
| 119 | + * Optional. The location of the API key. |
| 120 | + * @param httpElementLocation httpElementLocation or {@code null} for none |
| 121 | + */ |
| 122 | + public GoogleCloudAiplatformV1AuthConfigApiKeyConfig setHttpElementLocation(java.lang.String httpElementLocation) { |
| 123 | + this.httpElementLocation = httpElementLocation; |
| 124 | + return this; |
| 125 | + } |
| 126 | + |
| 127 | + /** |
| 128 | + * Optional. The parameter name of the API key. E.g. If the API request is |
| 129 | + * "https://example.com/act?api_key=", "api_key" would be the parameter name. |
| 130 | + * @return value or {@code null} for none |
| 131 | + */ |
| 132 | + public java.lang.String getName() { |
| 133 | + return name; |
| 134 | + } |
| 135 | + |
| 136 | + /** |
| 137 | + * Optional. The parameter name of the API key. E.g. If the API request is |
| 138 | + * "https://example.com/act?api_key=", "api_key" would be the parameter name. |
| 139 | + * @param name name or {@code null} for none |
| 140 | + */ |
| 141 | + public GoogleCloudAiplatformV1AuthConfigApiKeyConfig setName(java.lang.String name) { |
| 142 | + this.name = name; |
| 143 | + return this; |
| 144 | + } |
| 145 | + |
| 146 | + @Override |
| 147 | + public GoogleCloudAiplatformV1AuthConfigApiKeyConfig set(String fieldName, Object value) { |
| 148 | + return (GoogleCloudAiplatformV1AuthConfigApiKeyConfig) super.set(fieldName, value); |
| 149 | + } |
| 150 | + |
| 151 | + @Override |
| 152 | + public GoogleCloudAiplatformV1AuthConfigApiKeyConfig clone() { |
| 153 | + return (GoogleCloudAiplatformV1AuthConfigApiKeyConfig) super.clone(); |
| 154 | + } |
| 155 | + |
| 156 | +} |
0 commit comments