Reference documentation and code samples for the Google Cloud Api Hub V1 Client class Dependency.
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.
Generated from protobuf message google.cloud.apihub.v1.Dependency
Namespace
Google \ Cloud \ ApiHub \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The name of the dependency in the API Hub. Format: |
↳ consumer |
DependencyEntityReference
Required. Immutable. The entity acting as the consumer in the dependency. |
↳ supplier |
DependencyEntityReference
Required. Immutable. The entity acting as the supplier in the dependency. |
↳ state |
int
Output only. State of the dependency. |
↳ description |
string
Optional. Human readable description corresponding of the dependency. |
↳ discovery_mode |
int
Output only. Discovery mode of the dependency. |
↳ error_detail |
DependencyErrorDetail
Output only. Error details of a dependency if the system has detected it internally. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time at which the dependency was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time at which the dependency was last updated. |
↳ attributes |
array|Google\Protobuf\Internal\MapField
Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: |
getName
Identifier. The name of the dependency in the API Hub.
Format: projects/{project}/locations/{location}/dependencies/{dependency}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The name of the dependency in the API Hub.
Format: projects/{project}/locations/{location}/dependencies/{dependency}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConsumer
Required. Immutable. The entity acting as the consumer in the dependency.
| Returns | |
|---|---|
| Type | Description |
DependencyEntityReference|null |
|
hasConsumer
clearConsumer
setConsumer
Required. Immutable. The entity acting as the consumer in the dependency.
| Parameter | |
|---|---|
| Name | Description |
var |
DependencyEntityReference
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSupplier
Required. Immutable. The entity acting as the supplier in the dependency.
| Returns | |
|---|---|
| Type | Description |
DependencyEntityReference|null |
|
hasSupplier
clearSupplier
setSupplier
Required. Immutable. The entity acting as the supplier in the dependency.
| Parameter | |
|---|---|
| Name | Description |
var |
DependencyEntityReference
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. State of the dependency.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. State of the dependency.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Human readable description corresponding of the dependency.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Human readable description corresponding of the dependency.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDiscoveryMode
Output only. Discovery mode of the dependency.
| Returns | |
|---|---|
| Type | Description |
int |
|
setDiscoveryMode
Output only. Discovery mode of the dependency.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getErrorDetail
Output only. Error details of a dependency if the system has detected it internally.
| Returns | |
|---|---|
| Type | Description |
DependencyErrorDetail|null |
|
hasErrorDetail
clearErrorDetail
setErrorDetail
Output only. Error details of a dependency if the system has detected it internally.
| Parameter | |
|---|---|
| Name | Description |
var |
DependencyErrorDetail
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time at which the dependency was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which the dependency was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time at which the dependency was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which the dependency was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAttributes
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setAttributes
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|