Class ResourceReference

public sealed class ResourceReference : Protobuf.IMessage<ResourceReference>, Protobuf.IBufferMessage

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

Inheritance

Object > ResourceReference

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

ResourceReference()

public ResourceReference()

ResourceReference(ResourceReference)

public ResourceReference(ResourceReference other)
Parameter
TypeNameDescription
ResourceReferenceother

Fields

ChildTypeFieldNumber

public const int ChildTypeFieldNumber = 2

Field number for the "child_type" field.

Field Value
TypeDescription
Int32

TypeFieldNumber

public const int TypeFieldNumber = 1

Field number for the "type" field.

Field Value
TypeDescription
Int32

Properties

ChildType

public string ChildType { get; set; }

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

Property Value
TypeDescription
String

Descriptor

public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Property Value
TypeDescription
Protobuf.Reflection.MessageDescriptor

Parser

public static Protobuf.MessageParser<ResourceReference> Parser { get; }
Property Value
TypeDescription
Protobuf.MessageParser<ResourceReference>

Type

public string Type { get; set; }

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

Property Value
TypeDescription
String

Methods

CalculateSize()

public int CalculateSize()
Returns
TypeDescription
Int32

Clone()

public ResourceReference Clone()
Returns
TypeDescription
ResourceReference

Equals(ResourceReference)

public bool Equals(ResourceReference other)
Parameter
TypeNameDescription
ResourceReferenceother
Returns
TypeDescription
Boolean

Equals(Object)

public override bool Equals(object other)
Parameter
TypeNameDescription
Objectother
Returns
TypeDescription
Boolean

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
Int32

MergeFrom(ResourceReference)

public void MergeFrom(ResourceReference other)
Parameter
TypeNameDescription
ResourceReferenceother

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)
Parameter
TypeNameDescription
Protobuf.CodedInputStreaminput

ToString()

public override string ToString()
Returns
TypeDescription
String

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)
Parameter
TypeNameDescription
Protobuf.CodedOutputStreamoutput

Implements