Class DiscoveredApiObservation (0.28.0)

public final class DiscoveredApiObservation extends GeneratedMessageV3 implements DiscoveredApiObservationOrBuilder

Respresents an API Observation observed in one of the sources.

Protobuf type google.cloud.apihub.v1.DiscoveredApiObservation

Static Fields

API_OPERATION_COUNT_FIELD_NUMBER

public static final int API_OPERATION_COUNT_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

HOSTNAME_FIELD_NUMBER

public static final int HOSTNAME_FIELD_NUMBER
Field Value
Type Description
int

KNOWN_OPERATIONS_COUNT_FIELD_NUMBER

public static final int KNOWN_OPERATIONS_COUNT_FIELD_NUMBER
Field Value
Type Description
int

LAST_EVENT_DETECTED_TIME_FIELD_NUMBER

public static final int LAST_EVENT_DETECTED_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ORIGIN_FIELD_NUMBER

public static final int ORIGIN_FIELD_NUMBER
Field Value
Type Description
int

SERVER_IPS_FIELD_NUMBER

public static final int SERVER_IPS_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_LOCATIONS_FIELD_NUMBER

public static final int SOURCE_LOCATIONS_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_METADATA_FIELD_NUMBER

public static final int SOURCE_METADATA_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_TYPES_FIELD_NUMBER

public static final int SOURCE_TYPES_FIELD_NUMBER
Field Value
Type Description
int

STYLE_FIELD_NUMBER

public static final int STYLE_FIELD_NUMBER
Field Value
Type Description
int

UNKNOWN_OPERATIONS_COUNT_FIELD_NUMBER

public static final int UNKNOWN_OPERATIONS_COUNT_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DiscoveredApiObservation getDefaultInstance()
Returns
Type Description
DiscoveredApiObservation

getDescriptor()

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

newBuilder()

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

newBuilder(DiscoveredApiObservation prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getApiOperationCount()

public long getApiOperationCount()

Optional. The number of observed API Operations.

int64 api_operation_count = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The apiOperationCount.

getCreateTime()

public Timestamp getCreateTime()

Output only. Create time stamp of the observation in API Hub.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time stamp of the observation in API Hub.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public DiscoveredApiObservation getDefaultInstanceForType()
Returns
Type Description
DiscoveredApiObservation

getHostname()

public String getHostname()

Optional. The hostname of requests processed for this Observation.

string hostname = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The hostname.

getHostnameBytes()

public ByteString getHostnameBytes()

Optional. The hostname of requests processed for this Observation.

string hostname = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for hostname.

getKnownOperationsCount()

public long getKnownOperationsCount()

Output only. The number of known API Operations.

int64 known_operations_count = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The knownOperationsCount.

getLastEventDetectedTime()

public Timestamp getLastEventDetectedTime()

Optional. Last event detected time stamp

.google.protobuf.Timestamp last_event_detected_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The lastEventDetectedTime.

getLastEventDetectedTimeOrBuilder()

public TimestampOrBuilder getLastEventDetectedTimeOrBuilder()

Optional. Last event detected time stamp

.google.protobuf.Timestamp last_event_detected_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getName()

public String getName()

Identifier. The name of the discovered API Observation.

Format: projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The name of the discovered API Observation.

Format: projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getOrigin()

public String getOrigin()

Optional. For an observation pushed from a gcp resource, this would be the gcp project id.

string origin = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The origin.

getOriginBytes()

public ByteString getOriginBytes()

Optional. For an observation pushed from a gcp resource, this would be the gcp project id.

string origin = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for origin.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServerIps(int index)

public String getServerIps(int index)

Optional. The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: "192.168.1.1", "10.0.0.1:80", "FE80::0202:B3FF:FE1E:8329".

repeated string server_ips = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The serverIps at the given index.

getServerIpsBytes(int index)

public ByteString getServerIpsBytes(int index)

Optional. The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: "192.168.1.1", "10.0.0.1:80", "FE80::0202:B3FF:FE1E:8329".

repeated string server_ips = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the serverIps at the given index.

getServerIpsCount()

public int getServerIpsCount()

Optional. The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: "192.168.1.1", "10.0.0.1:80", "FE80::0202:B3FF:FE1E:8329".

repeated string server_ips = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of serverIps.

getServerIpsList()

public ProtocolStringList getServerIpsList()

Optional. The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: "192.168.1.1", "10.0.0.1:80", "FE80::0202:B3FF:FE1E:8329".

repeated string server_ips = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the serverIps.

getSourceLocations(int index)

public String getSourceLocations(int index)

Optional. The location of the observation source.

repeated string source_locations = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The sourceLocations at the given index.

getSourceLocationsBytes(int index)

public ByteString getSourceLocationsBytes(int index)

Optional. The location of the observation source.

repeated string source_locations = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the sourceLocations at the given index.

getSourceLocationsCount()

public int getSourceLocationsCount()

Optional. The location of the observation source.

repeated string source_locations = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of sourceLocations.

getSourceLocationsList()

public ProtocolStringList getSourceLocationsList()

Optional. The location of the observation source.

repeated string source_locations = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the sourceLocations.

getSourceMetadata()

public SourceMetadata getSourceMetadata()

Output only. The metadata of the source from which the observation was collected.

.google.cloud.apihub.v1.SourceMetadata source_metadata = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SourceMetadata

The sourceMetadata.

getSourceMetadataOrBuilder()

public SourceMetadataOrBuilder getSourceMetadataOrBuilder()

Output only. The metadata of the source from which the observation was collected.

.google.cloud.apihub.v1.SourceMetadata source_metadata = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SourceMetadataOrBuilder

getSourceTypes(int index)

public DiscoveredApiObservation.SourceType getSourceTypes(int index)

Optional. The type of the source from which the observation was collected.

repeated .google.cloud.apihub.v1.DiscoveredApiObservation.SourceType source_types = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
DiscoveredApiObservation.SourceType

The sourceTypes at the given index.

getSourceTypesCount()

public int getSourceTypesCount()

Optional. The type of the source from which the observation was collected.

repeated .google.cloud.apihub.v1.DiscoveredApiObservation.SourceType source_types = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of sourceTypes.

getSourceTypesList()

public List<DiscoveredApiObservation.SourceType> getSourceTypesList()

Optional. The type of the source from which the observation was collected.

repeated .google.cloud.apihub.v1.DiscoveredApiObservation.SourceType source_types = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<SourceType>

A list containing the sourceTypes.

getSourceTypesValue(int index)

public int getSourceTypesValue(int index)

Optional. The type of the source from which the observation was collected.

repeated .google.cloud.apihub.v1.DiscoveredApiObservation.SourceType source_types = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of sourceTypes at the given index.

getSourceTypesValueList()

public List<Integer> getSourceTypesValueList()

Optional. The type of the source from which the observation was collected.

repeated .google.cloud.apihub.v1.DiscoveredApiObservation.SourceType source_types = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for sourceTypes.

getStyle()

public DiscoveredApiObservation.Style getStyle()

Optional. Style of ApiObservation

.google.cloud.apihub.v1.DiscoveredApiObservation.Style style = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DiscoveredApiObservation.Style

The style.

getStyleValue()

public int getStyleValue()

Optional. Style of ApiObservation

.google.cloud.apihub.v1.DiscoveredApiObservation.Style style = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for style.

getUnknownOperationsCount()

public long getUnknownOperationsCount()

Output only. The number of unknown API Operations.

int64 unknown_operations_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The unknownOperationsCount.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update time stamp of the observation in API Hub.

.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time stamp of the observation in API Hub.

.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Create time stamp of the observation in API Hub.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasLastEventDetectedTime()

public boolean hasLastEventDetectedTime()

Optional. Last event detected time stamp

.google.protobuf.Timestamp last_event_detected_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the lastEventDetectedTime field is set.

hasSourceMetadata()

public boolean hasSourceMetadata()

Output only. The metadata of the source from which the observation was collected.

.google.cloud.apihub.v1.SourceMetadata source_metadata = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the sourceMetadata field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update time stamp of the observation in API Hub.

.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime 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 DiscoveredApiObservation.Builder newBuilderForType()
Returns
Type Description
DiscoveredApiObservation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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