Reference documentation and code samples for the Google Cloud Asset V1 Client class ExportAssetsRequest.
Export asset request.
Generated from protobuf message google.cloud.asset.v1.ExportAssetsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The relative name of the root asset. This 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"), or a folder number (such as "folders/123"). |
↳ read_time |
Google\Protobuf\Timestamp
Timestamp to take an asset snapshot. This can only be set to a timestamp between the current time and the current time minus 35 days (inclusive). If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results. |
↳ asset_types |
array
A list of asset types to take a snapshot for. For example: "compute.googleapis.com/Disk". Regular expressions are also supported. For example: * "compute.googleapis.com." snapshots resources whose asset type starts with "compute.googleapis.com". * ".Instance" snapshots resources whose asset type ends with "Instance". * ".Instance." snapshots resources whose asset type contains "Instance". See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned. If specified, only matching assets will be returned, otherwise, it will snapshot all asset types. See Introduction to Cloud Asset Inventory for all supported asset types. |
↳ content_type |
int
Asset content type. If not specified, no content but the asset name will be returned. |
↳ output_config |
Google\Cloud\Asset\V1\OutputConfig
Required. Output configuration indicating where the results will be output to. |
↳ relationship_types |
array
A list of relationship types to export, for example: |
getParent
Required. The relative name of the root asset. This 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"), or a folder number (such as "folders/123").
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The relative name of the root asset. This 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"), or a folder number (such as "folders/123").
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReadTime
Timestamp to take an asset snapshot. This can only be set to a timestamp between the current time and the current time minus 35 days (inclusive).
If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results.
Generated from protobuf field .google.protobuf.Timestamp read_time = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasReadTime
clearReadTime
setReadTime
Timestamp to take an asset snapshot. This can only be set to a timestamp between the current time and the current time minus 35 days (inclusive).
If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results.
Generated from protobuf field .google.protobuf.Timestamp read_time = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAssetTypes
A list of asset types to take a snapshot for. For example: "compute.googleapis.com/Disk".
Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots resources whose asset type ends with "Instance".
- ".Instance." snapshots resources whose asset type contains "Instance". See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned. If specified, only matching assets will be returned, otherwise, it will snapshot all asset types. See Introduction to Cloud Asset Inventory for all supported asset types.
Generated from protobuf field repeated string asset_types = 3;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAssetTypes
A list of asset types to take a snapshot for. For example: "compute.googleapis.com/Disk".
Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots resources whose asset type ends with "Instance".
- ".Instance." snapshots resources whose asset type contains "Instance". See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned. If specified, only matching assets will be returned, otherwise, it will snapshot all asset types. See Introduction to Cloud Asset Inventory for all supported asset types.
Generated from protobuf field repeated string asset_types = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getContentType
Asset content type. If not specified, no content but the asset name will be returned.
Generated from protobuf field .google.cloud.asset.v1.ContentType content_type = 4;
| Returns | |
|---|---|
| Type | Description |
int | |
setContentType
Asset content type. If not specified, no content but the asset name will be returned.
Generated from protobuf field .google.cloud.asset.v1.ContentType content_type = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOutputConfig
Required. Output configuration indicating where the results will be output to.
Generated from protobuf field .google.cloud.asset.v1.OutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Asset\V1\OutputConfig|null | |
hasOutputConfig
clearOutputConfig
setOutputConfig
Required. Output configuration indicating where the results will be output to.
Generated from protobuf field .google.cloud.asset.v1.OutputConfig output_config = 5 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Asset\V1\OutputConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRelationshipTypes
A list of relationship types to export, for example:
INSTANCE_TO_INSTANCEGROUP. This field should only be specified if
content_type=RELATIONSHIP.
- If specified: it snapshots specified relationships. It returns an error if any of the [relationship_types] doesn't belong to the supported relationship types of the [asset_types] or if any of the [asset_types] doesn't belong to the source types of the [relationship_types].
- Otherwise: it snapshots the supported relationships for all [asset_types] or returns an error if any of the [asset_types] has no relationship support. An unspecified asset types field means all supported asset_types. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.
Generated from protobuf field repeated string relationship_types = 6;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setRelationshipTypes
A list of relationship types to export, for example:
INSTANCE_TO_INSTANCEGROUP. This field should only be specified if
content_type=RELATIONSHIP.
- If specified: it snapshots specified relationships. It returns an error if any of the [relationship_types] doesn't belong to the supported relationship types of the [asset_types] or if any of the [asset_types] doesn't belong to the source types of the [relationship_types].
- Otherwise: it snapshots the supported relationships for all [asset_types] or returns an error if any of the [asset_types] has no relationship support. An unspecified asset types field means all supported asset_types. See Introduction to Cloud Asset Inventory for all supported asset types and relationship types.
Generated from protobuf field repeated string relationship_types = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |