google_api_service_management v0.45.0 GoogleApi.ServiceManagement.V1.Model.ResourceReference View Source

Defines a proto annotation that describes a string field that refers to an API resource.

Attributes

  • childType (type: String.t, default: nil) - 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"
      };
    }
  • type (type: String.t, default: nil) - 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: "*"
      }];
    }

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.ServiceManagement.V1.Model.ResourceReference{
  childType: String.t(),
  type: String.t()
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.