Class Dependency (0.29.0) 

public final class Dependency extends GeneratedMessageV3 implements DependencyOrBuilder

A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two Operations or between an Operation and External API.

Protobuf type google.cloud.apihub.v1.Dependency

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Dependency

Implements

DependencyOrBuilder

Static Fields

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

CONSUMER_FIELD_NUMBER

public static final int CONSUMER_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISCOVERY_MODE_FIELD_NUMBER

public static final int DISCOVERY_MODE_FIELD_NUMBER
Field Value
Type Description
int

ERROR_DETAIL_FIELD_NUMBER

public static final int ERROR_DETAIL_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

SUPPLIER_FIELD_NUMBER

public static final int SUPPLIER_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 Dependency getDefaultInstance()
Returns
Type Description
Dependency

getDescriptor()

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

newBuilder()

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

newBuilder(Dependency prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsAttributes(String key)

public boolean containsAttributes(String key)

Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.

map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getAttributes() (deprecated)

public Map<String,AttributeValues> getAttributes()

Use #getAttributesMap() instead.

Returns
Type Description
Map<String,AttributeValues>

getAttributesCount()

public int getAttributesCount()

Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.

map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAttributesMap()

public Map<String,AttributeValues> getAttributesMap()

Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.

map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,AttributeValues>

getAttributesOrDefault(String key, AttributeValues defaultValue)

public AttributeValues getAttributesOrDefault(String key, AttributeValues defaultValue)

Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.

map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue AttributeValues
Returns
Type Description
AttributeValues

getAttributesOrThrow(String key)

public AttributeValues getAttributesOrThrow(String key)

Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.

map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
AttributeValues

getConsumer()

public DependencyEntityReference getConsumer()

Required. Immutable. The entity acting as the consumer in the dependency.

.google.cloud.apihub.v1.DependencyEntityReference consumer = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DependencyEntityReference

The consumer.

getConsumerOrBuilder()

public DependencyEntityReferenceOrBuilder getConsumerOrBuilder()

Required. Immutable. The entity acting as the consumer in the dependency.

.google.cloud.apihub.v1.DependencyEntityReference consumer = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DependencyEntityReferenceOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The time at which the dependency was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which the dependency was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Dependency getDefaultInstanceForType()
Returns
Type Description
Dependency

getDescription()

public String getDescription()

Optional. Human readable description corresponding of the dependency.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Human readable description corresponding of the dependency.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDiscoveryMode()

public Dependency.DiscoveryMode getDiscoveryMode()

Output only. Discovery mode of the dependency.

.google.cloud.apihub.v1.Dependency.DiscoveryMode discovery_mode = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Dependency.DiscoveryMode

The discoveryMode.

getDiscoveryModeValue()

public int getDiscoveryModeValue()

Output only. Discovery mode of the dependency.

.google.cloud.apihub.v1.Dependency.DiscoveryMode discovery_mode = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for discoveryMode.

getErrorDetail()

public DependencyErrorDetail getErrorDetail()

Output only. Error details of a dependency if the system has detected it internally.

.google.cloud.apihub.v1.DependencyErrorDetail error_detail = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DependencyErrorDetail

The errorDetail.

getErrorDetailOrBuilder()

public DependencyErrorDetailOrBuilder getErrorDetailOrBuilder()

Output only. Error details of a dependency if the system has detected it internally.

.google.cloud.apihub.v1.DependencyErrorDetail error_detail = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DependencyErrorDetailOrBuilder

getName()

public String getName()

Identifier. The name of the dependency in the API Hub.

Format: projects/{project}/locations/{location}/dependencies/{dependency}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The name of the dependency in the API Hub.

Format: projects/{project}/locations/{location}/dependencies/{dependency}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Dependency.State getState()

Output only. State of the dependency.

.google.cloud.apihub.v1.Dependency.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Dependency.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the dependency.

.google.cloud.apihub.v1.Dependency.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getSupplier()

public DependencyEntityReference getSupplier()

Required. Immutable. The entity acting as the supplier in the dependency.

.google.cloud.apihub.v1.DependencyEntityReference supplier = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DependencyEntityReference

The supplier.

getSupplierOrBuilder()

public DependencyEntityReferenceOrBuilder getSupplierOrBuilder()

Required. Immutable. The entity acting as the supplier in the dependency.

.google.cloud.apihub.v1.DependencyEntityReference supplier = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DependencyEntityReferenceOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time at which the dependency was last updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time at which the dependency was last updated.

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

Returns
Type Description
TimestampOrBuilder

hasConsumer()

public boolean hasConsumer()

Required. Immutable. The entity acting as the consumer in the dependency.

.google.cloud.apihub.v1.DependencyEntityReference consumer = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the consumer field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time at which the dependency was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasErrorDetail()

public boolean hasErrorDetail()

Output only. Error details of a dependency if the system has detected it internally.

.google.cloud.apihub.v1.DependencyErrorDetail error_detail = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the errorDetail field is set.

hasSupplier()

public boolean hasSupplier()

Required. Immutable. The entity acting as the supplier in the dependency.

.google.cloud.apihub.v1.DependencyEntityReference supplier = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the supplier field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time at which the dependency was last updated.

.google.protobuf.Timestamp update_time = 9 [(.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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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