Class CollectApiDataRequest (0.28.0)

public final class CollectApiDataRequest extends GeneratedMessageV3 implements CollectApiDataRequestOrBuilder

The CollectApiData method's request.

Protobuf type google.cloud.apihub.v1.CollectApiDataRequest

Static Fields

ACTION_ID_FIELD_NUMBER

public static final int ACTION_ID_FIELD_NUMBER
Field Value
Type Description
int

API_DATA_FIELD_NUMBER

public static final int API_DATA_FIELD_NUMBER
Field Value
Type Description
int

COLLECTION_TYPE_FIELD_NUMBER

public static final int COLLECTION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

PLUGIN_INSTANCE_FIELD_NUMBER

public static final int PLUGIN_INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CollectApiDataRequest getDefaultInstance()
Returns
Type Description
CollectApiDataRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CollectApiDataRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getActionId()

public String getActionId()

Required. The action ID to be used for collecting the API data. This should map to one of the action IDs specified in action configs in the plugin.

string action_id = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The actionId.

getActionIdBytes()

public ByteString getActionIdBytes()

Required. The action ID to be used for collecting the API data. This should map to one of the action IDs specified in action configs in the plugin.

string action_id = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for actionId.

getApiData()

public ApiData getApiData()

Required. The API data to be collected.

.google.cloud.apihub.v1.ApiData api_data = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ApiData

The apiData.

getApiDataOrBuilder()

public ApiDataOrBuilder getApiDataOrBuilder()

Required. The API data to be collected.

.google.cloud.apihub.v1.ApiData api_data = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ApiDataOrBuilder

getCollectionType()

public CollectionType getCollectionType()

Required. The type of collection. Applies to all entries in api_data.

.google.cloud.apihub.v1.CollectionType collection_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CollectionType

The collectionType.

getCollectionTypeValue()

public int getCollectionTypeValue()

Required. The type of collection. Applies to all entries in api_data.

.google.cloud.apihub.v1.CollectionType collection_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for collectionType.

getDefaultInstanceForType()

public CollectApiDataRequest getDefaultInstanceForType()
Returns
Type Description
CollectApiDataRequest

getLocation()

public String getLocation()

Required. The regional location of the API hub instance and its resources. Format: projects/{project}/locations/{location}

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

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

Required. The regional location of the API hub instance and its resources. Format: projects/{project}/locations/{location}

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

Returns
Type Description
ByteString

The bytes for location.

getParserForType()

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

getPluginInstance()

public String getPluginInstance()

Required. The plugin instance collecting the API data. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}.

string plugin_instance = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The pluginInstance.

getPluginInstanceBytes()

public ByteString getPluginInstanceBytes()

Required. The plugin instance collecting the API data. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}.

string plugin_instance = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for pluginInstance.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasApiData()

public boolean hasApiData()

Required. The API data to be collected.

.google.cloud.apihub.v1.ApiData api_data = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the apiData field is set.

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 CollectApiDataRequest.Builder newBuilderForType()
Returns
Type Description
CollectApiDataRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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