Interface ResourceReferenceOrBuilder (2.66.0) 

public interface ResourceReferenceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getChildType()

public abstract String getChildType()

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

string child_type = 2;

Returns
Type Description
String

The childType.

getChildTypeBytes()

public abstract ByteString getChildTypeBytes()

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

string child_type = 2;

Returns
Type Description
ByteString

The bytes for childType.

getType()

public abstract String getType()

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

string type = 1;

Returns
Type Description
String

The type.

getTypeBytes()

public abstract ByteString getTypeBytes()

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

string type = 1;

Returns
Type Description
ByteString

The bytes for type.