Reference documentation and code samples for the Google Cloud Asset V1 Client class BatchGetAssetsHistoryRequest.
Batch get assets history request.
Generated from protobuf message google.cloud.asset.v1.BatchGetAssetsHistoryRequest
Namespace
Google \ Cloud \ Asset \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The relative name of the root asset. It can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345"). |
↳ asset_names |
array
A list of the full names of the assets. See: https://cloud.google.com/asset-inventory/docs/resource-name-format Example: |
↳ content_type |
int
Optional. The content type. |
↳ read_time_window |
Google\Cloud\Asset\V1\TimeWindow
Optional. The time window for the asset history. Both start_time and end_time are optional and if set, it must be after the current time minus 35 days. If end_time is not set, it is default to current timestamp. If start_time is not set, the snapshot of the assets at end_time will be returned. The returned results contain all temporal assets whose time window overlap with read_time_window. |
↳ relationship_types |
array
Optional. A list of relationship types to output, for example: |
getParent
Required. The relative name of the root asset. It can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345").
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The relative name of the root asset. It can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345").
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAssetNames
A list of the full names of the assets.
See: https://cloud.google.com/asset-inventory/docs/resource-name-format
Example:
//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.
The request becomes a no-op if the asset name list is empty, and the max
size of the asset name list is 100 in one request.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAssetNames
A list of the full names of the assets.
See: https://cloud.google.com/asset-inventory/docs/resource-name-format
Example:
//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1.
The request becomes a no-op if the asset name list is empty, and the max
size of the asset name list is 100 in one request.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getContentType
Optional. The content type.
| Returns | |
|---|---|
| Type | Description |
int | |
setContentType
Optional. The content type.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReadTimeWindow
Optional. The time window for the asset history. Both start_time and end_time are optional and if set, it must be after the current time minus 35 days. If end_time is not set, it is default to current timestamp.
If start_time is not set, the snapshot of the assets at end_time will be returned. The returned results contain all temporal assets whose time window overlap with read_time_window.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Asset\V1\TimeWindow|null | |
hasReadTimeWindow
clearReadTimeWindow
setReadTimeWindow
Optional. The time window for the asset history. Both start_time and end_time are optional and if set, it must be after the current time minus 35 days. If end_time is not set, it is default to current timestamp.
If start_time is not set, the snapshot of the assets at end_time will be returned. The returned results contain all temporal assets whose time window overlap with read_time_window.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Asset\V1\TimeWindow
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRelationshipTypes
Optional. A list of relationship types to output, for example:
INSTANCE_TO_INSTANCEGROUP. This field should only be specified if
content_type=RELATIONSHIP.
- If specified: it outputs specified relationships' history on the [asset_names]. It returns an error if any of the [relationship_types] doesn't belong to the supported relationship types of the [asset_names] or if any of the [asset_names]'s types doesn't belong to the source types of the [relationship_types].
- Otherwise: it outputs the supported relationships' history on the [asset_names] or returns an error if any of the [asset_names]'s types has no relationship support. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setRelationshipTypes
Optional. A list of relationship types to output, for example:
INSTANCE_TO_INSTANCEGROUP. This field should only be specified if
content_type=RELATIONSHIP.
- If specified: it outputs specified relationships' history on the [asset_names]. It returns an error if any of the [relationship_types] doesn't belong to the supported relationship types of the [asset_names] or if any of the [asset_names]'s types doesn't belong to the source types of the [relationship_types].
- Otherwise: it outputs the supported relationships' history on the [asset_names] or returns an error if any of the [asset_names]'s types has no relationship support. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |