com.google.api.services.servicemanagement.model.ResourceReference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-servicemanagement Show documentation
There is a newer version: v1-rev20241106-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.servicemanagement.model;

/**
 * Defines a proto annotation that describes a string field that refers to an API resource.
 *
 *  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 Service Management 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 ResourceReference extends com.google.api.client.json.GenericJson {

  /**
   * The resource type of a child collection that the annotated field references. This is useful for
   * annotating the `parent` field that doesn't have a fixed resource type. Example: message
   * ListLogEntriesRequest { string parent = 1 [(google.api.resource_reference) = { child_type:
   * "logging.googleapis.com/LogEntry" }; }
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String childType;

  /**
   * The resource type that the annotated field references. Example: message Subscription { string
   * topic = 2 [(google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }]; }
   * Occasionally, a field may reference an arbitrary resource. In this case, APIs use the special
   * value * in their resource reference. Example: message GetIamPolicyRequest { string resource = 2
   * [(google.api.resource_reference) = { type: "*" }]; }
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String type;

  /**
   * The resource type of a child collection that the annotated field references. This is useful for
   * annotating the `parent` field that doesn't have a fixed resource type. Example: message
   * ListLogEntriesRequest { string parent = 1 [(google.api.resource_reference) = { child_type:
   * "logging.googleapis.com/LogEntry" }; }
   * @return value or {@code null} for none
   */
  public java.lang.String getChildType() {
    return childType;
  }

  /**
   * The resource type of a child collection that the annotated field references. This is useful for
   * annotating the `parent` field that doesn't have a fixed resource type. Example: message
   * ListLogEntriesRequest { string parent = 1 [(google.api.resource_reference) = { child_type:
   * "logging.googleapis.com/LogEntry" }; }
   * @param childType childType or {@code null} for none
   */
  public ResourceReference setChildType(java.lang.String childType) {
    this.childType = childType;
    return this;
  }

  /**
   * The resource type that the annotated field references. Example: message Subscription { string
   * topic = 2 [(google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }]; }
   * Occasionally, a field may reference an arbitrary resource. In this case, APIs use the special
   * value * in their resource reference. Example: message GetIamPolicyRequest { string resource = 2
   * [(google.api.resource_reference) = { type: "*" }]; }
   * @return value or {@code null} for none
   */
  public java.lang.String getType() {
    return type;
  }

  /**
   * The resource type that the annotated field references. Example: message Subscription { string
   * topic = 2 [(google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }]; }
   * Occasionally, a field may reference an arbitrary resource. In this case, APIs use the special
   * value * in their resource reference. Example: message GetIamPolicyRequest { string resource = 2
   * [(google.api.resource_reference) = { type: "*" }]; }
   * @param type type or {@code null} for none
   */
  public ResourceReference setType(java.lang.String type) {
    this.type = type;
    return this;
  }

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

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

}