com.google.api.services.eventarc.v1.model.GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-eventarc Show documentation
There is a newer version: v1-rev20250103-2.0.0
Show newest version
/*
 * 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
 *
 * http://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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.eventarc.v1.model;

/**
 * Represents a config used to authenticate with a Google OIDC token using a GCP service account.
 * Use this authentication method to invoke your Cloud Run and Cloud Functions destinations or HTTP
 * endpoints that support Google OIDC.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Eventarc API. For a detailed explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Audience to be used to generate the OIDC Token. The audience claim identifies the
   * recipient that the JWT is intended for. If unspecified, the destination URI will be used.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String audience;

  /**
   * Required. Service account email used to generate the OIDC Token. The principal who calls this
   * API must have iam.serviceAccounts.actAs permission in the service account. See
   * https://cloud.google.com/iam/docs/understanding-service-accounts for more information. Eventarc
   * service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow the Pipeline
   * to create OpenID tokens for authenticated requests.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String serviceAccount;

  /**
   * Optional. Audience to be used to generate the OIDC Token. The audience claim identifies the
   * recipient that the JWT is intended for. If unspecified, the destination URI will be used.
   * @return value or {@code null} for none
   */
  public java.lang.String getAudience() {
    return audience;
  }

  /**
   * Optional. Audience to be used to generate the OIDC Token. The audience claim identifies the
   * recipient that the JWT is intended for. If unspecified, the destination URI will be used.
   * @param audience audience or {@code null} for none
   */
  public GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken setAudience(java.lang.String audience) {
    this.audience = audience;
    return this;
  }

  /**
   * Required. Service account email used to generate the OIDC Token. The principal who calls this
   * API must have iam.serviceAccounts.actAs permission in the service account. See
   * https://cloud.google.com/iam/docs/understanding-service-accounts for more information. Eventarc
   * service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow the Pipeline
   * to create OpenID tokens for authenticated requests.
   * @return value or {@code null} for none
   */
  public java.lang.String getServiceAccount() {
    return serviceAccount;
  }

  /**
   * Required. Service account email used to generate the OIDC Token. The principal who calls this
   * API must have iam.serviceAccounts.actAs permission in the service account. See
   * https://cloud.google.com/iam/docs/understanding-service-accounts for more information. Eventarc
   * service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow the Pipeline
   * to create OpenID tokens for authenticated requests.
   * @param serviceAccount serviceAccount or {@code null} for none
   */
  public GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken setServiceAccount(java.lang.String serviceAccount) {
    this.serviceAccount = serviceAccount;
    return this;
  }

  @Override
  public GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken set(String fieldName, Object value) {
    return (GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken) super.set(fieldName, value);
  }

  @Override
  public GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken clone() {
    return (GoogleCloudEventarcV1PipelineDestinationAuthenticationConfigOidcToken) super.clone();
  }

}