Class GetMetadataRequest (0.56.0)

public final class GetMetadataRequest extends GeneratedMessageV3 implements GetMetadataRequestOrBuilder

Request for a property's dimension and metric metadata.

Protobuf type google.analytics.data.v1beta.GetMetadataRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GetMetadataRequest getDefaultInstance()
Returns
Type Description
GetMetadataRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static GetMetadataRequest.Builder newBuilder()
Returns
Type Description
GetMetadataRequest.Builder

newBuilder(GetMetadataRequest prototype)

public static GetMetadataRequest.Builder newBuilder(GetMetadataRequest prototype)
Parameter
Name Description
prototype GetMetadataRequest
Returns
Type Description
GetMetadataRequest.Builder

parseDelimitedFrom(InputStream input)

public static GetMetadataRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GetMetadataRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GetMetadataRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetMetadataRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GetMetadataRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GetMetadataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GetMetadataRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetMetadataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GetMetadataRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GetMetadataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GetMetadataRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetMetadataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GetMetadataRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GetMetadataRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GetMetadataRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetMetadataRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GetMetadataRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GetMetadataRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GetMetadataRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetMetadataRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GetMetadataRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GetMetadataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GetMetadataRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetMetadataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GetMetadataRequest> parser()
Returns
Type Description
Parser<GetMetadataRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public GetMetadataRequest getDefaultInstanceForType()
Returns
Type Description
GetMetadataRequest

getName()

public String getName()

Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see where to find your Property ID.

Example: properties/1234/metadata

Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see where to find your Property ID.

Example: properties/1234/metadata

Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<GetMetadataRequest> getParserForType()
Returns
Type Description
Parser<GetMetadataRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GetMetadataRequest.Builder newBuilderForType()
Returns
Type Description
GetMetadataRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GetMetadataRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GetMetadataRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GetMetadataRequest.Builder toBuilder()
Returns
Type Description
GetMetadataRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException