Creates a PerfSampleSeries. May return any of the following error code(s): - ALREADY_EXISTS - PerfMetricSummary already exists for the given Step - NOT_FOUND - The containing Step does not exist
Auto-naming is currently not supported for this resource.
Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist
on Google Cloud even though it will be deleted from Pulumi state.
Create PerfSampleSeries Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def PerfSampleSeries(resource_name: str,
args: PerfSampleSeriesArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PerfSampleSeries(resource_name: str,
opts: Optional[ResourceOptions] = None,
execution_id: Optional[str] = None,
history_id: Optional[str] = None,
step_id: Optional[str] = None,
basic_perf_sample_series: Optional[BasicPerfSampleSeriesArgs] = None,
project: Optional[str] = None)
type: google-native:toolresults/v1beta3:PerfSampleSeries
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "google-native_toolresults_v1beta3_perf_sample_series" "name" {
# resource properties
}
Parameters
- resource_name
str
- The unique name of the resource.
- args
PerfSampleSeriesArgs
- The arguments to resource properties.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resource.
- args
PerfSampleSeriesArgs
- The arguments to resource properties.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resource.
- args
PerfSampleSeriesArgs
- The arguments to resource properties.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var perfSampleSeriesResource = new GoogleNative.ToolResults.V1Beta3.PerfSampleSeries("perfSampleSeriesResource", new()
{
ExecutionId = "string",
HistoryId = "string",
StepId = "string",
BasicPerfSampleSeries = new GoogleNative.ToolResults.V1Beta3.Inputs.BasicPerfSampleSeriesArgs
{
PerfMetricType = GoogleNative.ToolResults.V1Beta3.BasicPerfSampleSeriesPerfMetricType.PerfMetricTypeUnspecified,
PerfUnit = GoogleNative.ToolResults.V1Beta3.BasicPerfSampleSeriesPerfUnit.PerfUnitUnspecified,
SampleSeriesLabel = GoogleNative.ToolResults.V1Beta3.BasicPerfSampleSeriesSampleSeriesLabel.SampleSeriesTypeUnspecified,
},
Project = "string",
});
example, err := toolresults.NewPerfSampleSeries(ctx, "perfSampleSeriesResource", &toolresults.PerfSampleSeriesArgs{
ExecutionId: pulumi.String("string"),
HistoryId: pulumi.String("string"),
StepId: pulumi.String("string"),
BasicPerfSampleSeries: &toolresults.BasicPerfSampleSeriesArgs{
PerfMetricType: toolresults.BasicPerfSampleSeriesPerfMetricTypePerfMetricTypeUnspecified,
PerfUnit: toolresults.BasicPerfSampleSeriesPerfUnitPerfUnitUnspecified,
SampleSeriesLabel: toolresults.BasicPerfSampleSeriesSampleSeriesLabelSampleSeriesTypeUnspecified,
},
Project: pulumi.String("string"),
})
resource "google-native_toolresults_v1beta3_perf_sample_series" "perfSampleSeriesResource" {
lifecycle {
create_before_destroy = true
}
execution_id = "string"
history_id = "string"
step_id = "string"
basic_perf_sample_series = {
perf_metric_type = "perfMetricTypeUnspecified"
perf_unit = "perfUnitUnspecified"
sample_series_label = "sampleSeriesTypeUnspecified"
}
project = "string"
}
var perfSampleSeriesResource = new PerfSampleSeries("perfSampleSeriesResource", PerfSampleSeriesArgs.builder()
.executionId("string")
.historyId("string")
.stepId("string")
.basicPerfSampleSeries(BasicPerfSampleSeriesArgs.builder()
.perfMetricType(com.pulumi.googlenative.toolresults_v1beta3.enums.BasicPerfSampleSeriesPerfMetricType.PerfMetricTypeUnspecified)
.perfUnit(com.pulumi.googlenative.toolresults_v1beta3.enums.BasicPerfSampleSeriesPerfUnit.PerfUnitUnspecified)
.sampleSeriesLabel(com.pulumi.googlenative.toolresults_v1beta3.enums.BasicPerfSampleSeriesSampleSeriesLabel.SampleSeriesTypeUnspecified)
.build())
.project("string")
.build());
perf_sample_series_resource = google_native.toolresults.v1beta3.PerfSampleSeries("perfSampleSeriesResource",
execution_id="string",
history_id="string",
step_id="string",
basic_perf_sample_series={
"perf_metric_type": google_native.toolresults.v1beta3.BasicPerfSampleSeriesPerfMetricType.PERF_METRIC_TYPE_UNSPECIFIED,
"perf_unit": google_native.toolresults.v1beta3.BasicPerfSampleSeriesPerfUnit.PERF_UNIT_UNSPECIFIED,
"sample_series_label": google_native.toolresults.v1beta3.BasicPerfSampleSeriesSampleSeriesLabel.SAMPLE_SERIES_TYPE_UNSPECIFIED,
},
project="string")
const perfSampleSeriesResource = new google_native.toolresults.v1beta3.PerfSampleSeries("perfSampleSeriesResource", {
executionId: "string",
historyId: "string",
stepId: "string",
basicPerfSampleSeries: {
perfMetricType: google_native.toolresults.v1beta3.BasicPerfSampleSeriesPerfMetricType.PerfMetricTypeUnspecified,
perfUnit: google_native.toolresults.v1beta3.BasicPerfSampleSeriesPerfUnit.PerfUnitUnspecified,
sampleSeriesLabel: google_native.toolresults.v1beta3.BasicPerfSampleSeriesSampleSeriesLabel.SampleSeriesTypeUnspecified,
},
project: "string",
});
type: google-native:toolresults/v1beta3:PerfSampleSeries
properties:
basicPerfSampleSeries:
perfMetricType: perfMetricTypeUnspecified
perfUnit: perfUnitUnspecified
sampleSeriesLabel: sampleSeriesTypeUnspecified
executionId: string
historyId: string
project: string
stepId: string
PerfSampleSeries Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PerfSampleSeries resource accepts the following input properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the PerfSampleSeries resource produces the following output properties:
- Id
string
- The provider-assigned unique ID for this managed resource.
- SampleSeriesId
string
- A sample series id
- Id
string
- The provider-assigned unique ID for this managed resource.
- SampleSeriesId
string
- A sample series id
- id
string
- The provider-assigned unique ID for this managed resource.
- sample_series_id
string
- A sample series id
- id
String
- The provider-assigned unique ID for this managed resource.
- sampleSeriesId
String
- A sample series id
- id
string
- The provider-assigned unique ID for this managed resource.
- sampleSeriesId
string
- A sample series id
- id
str
- The provider-assigned unique ID for this managed resource.
- sample_series_id
str
- A sample series id
- id
String
- The provider-assigned unique ID for this managed resource.
- sampleSeriesId
String
- A sample series id
Look up Existing PerfSampleSeries Resource
Get an existing PerfSampleSeries resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
func GetPerfSampleSeries(ctx *Context, name string, id IDInput, state *PerfSampleSeriesState, opts ...ResourceOption) (*PerfSampleSeries, error)
public static PerfSampleSeries get(String name, Output<String> id, CustomResourceOptions options)
resources: existingPerfSampleSeries: type: google-native:toolresults/v1beta3:PerfSampleSeries get: id: ${id}
import {
to = google-native_toolresults_v1beta3_perf_sample_series.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
PerfSampleSeriesState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
BasicPerfSampleSeries, BasicPerfSampleSeriesArgs
Encapsulates the metadata for basic sample series represented by a line chart
BasicPerfSampleSeriesPerfMetricType
| Name | Value |
|---|
| PerfMetricTypeUnspecified | perfMetricTypeUnspecified |
| Memory | memory |
| Cpu | cpu |
| Network | network |
| Graphics | graphics |
| Name | Value |
|---|
| BasicPerfSampleSeriesPerfMetricTypePerfMetricTypeUnspecified | perfMetricTypeUnspecified |
| BasicPerfSampleSeriesPerfMetricTypeMemory | memory |
| BasicPerfSampleSeriesPerfMetricTypeCpu | cpu |
| BasicPerfSampleSeriesPerfMetricTypeNetwork | network |
| BasicPerfSampleSeriesPerfMetricTypeGraphics | graphics |
| Value |
|---|
perfMetricTypeUnspecified |
memory |
cpu |
network |
graphics |
| Name | Value |
|---|
| PerfMetricTypeUnspecified | perfMetricTypeUnspecified |
| Memory | memory |
| Cpu | cpu |
| Network | network |
| Graphics | graphics |
| Name | Value |
|---|
| PerfMetricTypeUnspecified | perfMetricTypeUnspecified |
| Memory | memory |
| Cpu | cpu |
| Network | network |
| Graphics | graphics |
| Name | Value |
|---|
| PERF_METRIC_TYPE_UNSPECIFIED | perfMetricTypeUnspecified |
| MEMORY | memory |
| CPU | cpu |
| NETWORK | network |
| GRAPHICS | graphics |
| Value |
|---|
perfMetricTypeUnspecified |
memory |
cpu |
network |
graphics |
BasicPerfSampleSeriesPerfUnit
| Name | Value |
|---|
| PerfUnitUnspecified | perfUnitUnspecified |
| Kibibyte | kibibyte |
| Percent | percent |
| BytesPerSecond | bytesPerSecond |
| FramesPerSecond | framesPerSecond |
| Byte | byte |
| Name | Value |
|---|
| BasicPerfSampleSeriesPerfUnitPerfUnitUnspecified | perfUnitUnspecified |
| BasicPerfSampleSeriesPerfUnitKibibyte | kibibyte |
| BasicPerfSampleSeriesPerfUnitPercent | percent |
| BasicPerfSampleSeriesPerfUnitBytesPerSecond | bytesPerSecond |
| BasicPerfSampleSeriesPerfUnitFramesPerSecond | framesPerSecond |
| BasicPerfSampleSeriesPerfUnitByte | byte |
| Value |
|---|
perfUnitUnspecified |
kibibyte |
percent |
bytesPerSecond |
framesPerSecond |
byte |
| Name | Value |
|---|
| PerfUnitUnspecified | perfUnitUnspecified |
| Kibibyte | kibibyte |
| Percent | percent |
| BytesPerSecond | bytesPerSecond |
| FramesPerSecond | framesPerSecond |
| Byte | byte |
| Name | Value |
|---|
| PerfUnitUnspecified | perfUnitUnspecified |
| Kibibyte | kibibyte |
| Percent | percent |
| BytesPerSecond | bytesPerSecond |
| FramesPerSecond | framesPerSecond |
| Byte | byte |
| Name | Value |
|---|
| PERF_UNIT_UNSPECIFIED | perfUnitUnspecified |
| KIBIBYTE | kibibyte |
| PERCENT | percent |
| BYTES_PER_SECOND | bytesPerSecond |
| FRAMES_PER_SECOND | framesPerSecond |
| BYTE | byte |
| Value |
|---|
perfUnitUnspecified |
kibibyte |
percent |
bytesPerSecond |
framesPerSecond |
byte |
BasicPerfSampleSeriesResponse
Encapsulates the metadata for basic sample series represented by a line chart
BasicPerfSampleSeriesSampleSeriesLabel
| Name | Value | Description |
|---|
| SampleSeriesTypeUnspecified | sampleSeriesTypeUnspecified | |
| MemoryRssPrivate | memoryRssPrivate | Memory sample series |
| MemoryRssShared | memoryRssShared | |
| MemoryRssTotal | memoryRssTotal | |
| MemoryTotal | memoryTotal | |
| CpuUser | cpuUser | CPU sample series |
| CpuKernel | cpuKernel | |
| CpuTotal | cpuTotal | |
| NtBytesTransferred | ntBytesTransferred | Network sample series |
| NtBytesReceived | ntBytesReceived | |
| NetworkSent | networkSent | |
| NetworkReceived | networkReceived | |
| GraphicsFrameRate | graphicsFrameRate | Graphics sample series |
| Name | Value | Description |
|---|
| BasicPerfSampleSeriesSampleSeriesLabelSampleSeriesTypeUnspecified | sampleSeriesTypeUnspecified | |
| BasicPerfSampleSeriesSampleSeriesLabelMemoryRssPrivate | memoryRssPrivate | Memory sample series |
| BasicPerfSampleSeriesSampleSeriesLabelMemoryRssShared | memoryRssShared | |
| BasicPerfSampleSeriesSampleSeriesLabelMemoryRssTotal | memoryRssTotal | |
| BasicPerfSampleSeriesSampleSeriesLabelMemoryTotal | memoryTotal | |
| BasicPerfSampleSeriesSampleSeriesLabelCpuUser | cpuUser | CPU sample series |
| BasicPerfSampleSeriesSampleSeriesLabelCpuKernel | cpuKernel | |
| BasicPerfSampleSeriesSampleSeriesLabelCpuTotal | cpuTotal | |
| BasicPerfSampleSeriesSampleSeriesLabelNtBytesTransferred | ntBytesTransferred | Network sample series |
| BasicPerfSampleSeriesSampleSeriesLabelNtBytesReceived | ntBytesReceived | |
| BasicPerfSampleSeriesSampleSeriesLabelNetworkSent | networkSent | |
| BasicPerfSampleSeriesSampleSeriesLabelNetworkReceived | networkReceived | |
| BasicPerfSampleSeriesSampleSeriesLabelGraphicsFrameRate | graphicsFrameRate | Graphics sample series |
| Value | Description |
|---|
sampleSeriesTypeUnspecified | |
memoryRssPrivate | Memory sample series |
memoryRssShared | |
memoryRssTotal | |
memoryTotal | |
cpuUser | CPU sample series |
cpuKernel | |
cpuTotal | |
ntBytesTransferred | Network sample series |
ntBytesReceived | |
networkSent | |
networkReceived | |
graphicsFrameRate | Graphics sample series |
| Name | Value | Description |
|---|
| SampleSeriesTypeUnspecified | sampleSeriesTypeUnspecified | |
| MemoryRssPrivate | memoryRssPrivate | Memory sample series |
| MemoryRssShared | memoryRssShared | |
| MemoryRssTotal | memoryRssTotal | |
| MemoryTotal | memoryTotal | |
| CpuUser | cpuUser | CPU sample series |
| CpuKernel | cpuKernel | |
| CpuTotal | cpuTotal | |
| NtBytesTransferred | ntBytesTransferred | Network sample series |
| NtBytesReceived | ntBytesReceived | |
| NetworkSent | networkSent | |
| NetworkReceived | networkReceived | |
| GraphicsFrameRate | graphicsFrameRate | Graphics sample series |
| Name | Value | Description |
|---|
| SampleSeriesTypeUnspecified | sampleSeriesTypeUnspecified | |
| MemoryRssPrivate | memoryRssPrivate | Memory sample series |
| MemoryRssShared | memoryRssShared | |
| MemoryRssTotal | memoryRssTotal | |
| MemoryTotal | memoryTotal | |
| CpuUser | cpuUser | CPU sample series |
| CpuKernel | cpuKernel | |
| CpuTotal | cpuTotal | |
| NtBytesTransferred | ntBytesTransferred | Network sample series |
| NtBytesReceived | ntBytesReceived | |
| NetworkSent | networkSent | |
| NetworkReceived | networkReceived | |
| GraphicsFrameRate | graphicsFrameRate | Graphics sample series |
| Name | Value | Description |
|---|
| SAMPLE_SERIES_TYPE_UNSPECIFIED | sampleSeriesTypeUnspecified | |
| MEMORY_RSS_PRIVATE | memoryRssPrivate | Memory sample series |
| MEMORY_RSS_SHARED | memoryRssShared | |
| MEMORY_RSS_TOTAL | memoryRssTotal | |
| MEMORY_TOTAL | memoryTotal | |
| CPU_USER | cpuUser | CPU sample series |
| CPU_KERNEL | cpuKernel | |
| CPU_TOTAL | cpuTotal | |
| NT_BYTES_TRANSFERRED | ntBytesTransferred | Network sample series |
| NT_BYTES_RECEIVED | ntBytesReceived | |
| NETWORK_SENT | networkSent | |
| NETWORK_RECEIVED | networkReceived | |
| GRAPHICS_FRAME_RATE | graphicsFrameRate | Graphics sample series |
| Value | Description |
|---|
sampleSeriesTypeUnspecified | |
memoryRssPrivate | Memory sample series |
memoryRssShared | |
memoryRssTotal | |
memoryTotal | |
cpuUser | CPU sample series |
cpuKernel | |
cpuTotal | |
ntBytesTransferred | Network sample series |
ntBytesReceived | |
networkSent | |
networkReceived | |
graphicsFrameRate | Graphics sample series |
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0