Class: Google::Api::ResourceReference

Inherits:

Object

• Object
• Google::Api::ResourceReference

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/api/resource.rb

Overview

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

Instance Attribute Summary

• #child_type ⇒ ::String

  The resource type of a child collection that the annotated field references.

• #type ⇒ ::String

  The resource type that the annotated field references.

Instance Attribute Details

#child_type ⇒ ::String

Returns 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"
  };
}.

Returns:

• (::String) —

  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"
    };
  }
  

# File 'proto_docs/google/api/resource.rb', line 278

class ResourceReference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#type ⇒ ::String

Returns 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: "*"
  }];
}.

Returns:

• (::String) —

  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: "*"
    }];
  }
  

# File 'proto_docs/google/api/resource.rb', line 278

class ResourceReference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end