public final class ResourceReference extends GeneratedMessageV3 implements ResourceReferenceOrBuilderDefines a proto annotation that describes a string field that refers to an API resource.
Protobuf type google.api.ResourceReference
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ResourceReferenceImplements
ResourceReferenceOrBuilderStatic Fields
CHILD_TYPE_FIELD_NUMBER
public static final int CHILD_TYPE_FIELD_NUMBER| Type | Description |
| int |
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
public static ResourceReference getDefaultInstance()| Type | Description |
| ResourceReference |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
newBuilder()
public static ResourceReference.Builder newBuilder()| Type | Description |
| ResourceReference.Builder |
newBuilder(ResourceReference prototype)
public static ResourceReference.Builder newBuilder(ResourceReference prototype)| Name | Description |
| prototype | ResourceReference |
| Type | Description |
| ResourceReference.Builder |
parseDelimitedFrom(InputStream input)
public static ResourceReference parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| ResourceReference |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ResourceReference parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ResourceReference |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static ResourceReference parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| ResourceReference |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ResourceReference parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ResourceReference |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static ResourceReference parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| ResourceReference |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ResourceReference parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ResourceReference |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static ResourceReference parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| ResourceReference |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ResourceReference parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ResourceReference |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static ResourceReference parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| ResourceReference |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ResourceReference parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ResourceReference |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static ResourceReference parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| ResourceReference |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ResourceReference parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ResourceReference |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<ResourceReference> parser()| Type | Description |
| Parser<ResourceReference> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
getChildType()
public 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;
| Type | Description |
| String | The childType. |
getChildTypeBytes()
public 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;
| Type | Description |
| ByteString | The bytes for childType. |
getDefaultInstanceForType()
public ResourceReference getDefaultInstanceForType()| Type | Description |
| ResourceReference |
getParserForType()
public Parser<ResourceReference> getParserForType()| Type | Description |
| Parser<ResourceReference> |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
getType()
public 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;
| Type | Description |
| String | The type. |
getTypeBytes()
public 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;
| Type | Description |
| ByteString | The bytes for type. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilderForType()
public ResourceReference.Builder newBuilderForType()| Type | Description |
| ResourceReference.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ResourceReference.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| ResourceReference.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
public ResourceReference.Builder toBuilder()| Type | Description |
| ResourceReference.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |