Interface CollectApiDataRequestOrBuilder (0.28.0)

public interface CollectApiDataRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActionId()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getLocation()

public abstract 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 abstract 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.

getPluginInstance()

public abstract 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 abstract 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.

hasApiData()

public abstract 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.