workloadmanager

package
v0.210.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 4, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package workloadmanager provides access to the Workload Manager API.

For product documentation, see: https://cloud.google.com/workload-manager/docs

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/workloadmanager/v1"
...
ctx := context.Background()
workloadmanagerService, err := workloadmanager.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

workloadmanagerService, err := workloadmanager.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
workloadmanagerService, err := workloadmanager.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AgentCommand added in v0.187.0

type AgentCommand struct {
	// Command: command is the name of the agent one-time executable that will be
	// invoked.
	Command string `json:"command,omitempty"`
	// Parameters: parameters is a map of key/value pairs that can be used to
	// specify additional one-time executable settings.
	Parameters map[string]string `json:"parameters,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Command") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Command") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AgentCommand: * An AgentCommand specifies a one-time executable program for the agent to run.

func (AgentCommand) MarshalJSON added in v0.187.0

func (s AgentCommand) MarshalJSON() ([]byte, error)

type BigQueryDestination added in v0.156.0

type BigQueryDestination struct {
	// CreateNewResultsTable: Optional. determine if results will be saved in a new
	// table
	CreateNewResultsTable bool `json:"createNewResultsTable,omitempty"`
	// DestinationDataset: Optional. destination dataset to save evaluation results
	DestinationDataset string `json:"destinationDataset,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CreateNewResultsTable") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateNewResultsTable") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BigQueryDestination: Message describing big query destination

func (BigQueryDestination) MarshalJSON added in v0.156.0

func (s BigQueryDestination) MarshalJSON() ([]byte, error)

type CancelOperationRequest

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type Command added in v0.187.0

type Command struct {
	// AgentCommand: AgentCommand specifies a one-time executable program for the
	// agent to run.
	AgentCommand *AgentCommand `json:"agentCommand,omitempty"`
	// ShellCommand: ShellCommand is invoked via the agent's command line executor.
	ShellCommand *ShellCommand `json:"shellCommand,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AgentCommand") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AgentCommand") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Command: * Command specifies the type of command to execute.

func (Command) MarshalJSON added in v0.187.0

func (s Command) MarshalJSON() ([]byte, error)

type Empty

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type Evaluation

type Evaluation struct {
	// BigQueryDestination: Optional. BigQuery destination
	BigQueryDestination *BigQueryDestination `json:"bigQueryDestination,omitempty"`
	// CreateTime: Output only. [Output only] Create time stamp
	CreateTime string `json:"createTime,omitempty"`
	// CustomRulesBucket: The Cloud Storage bucket name for custom rules.
	CustomRulesBucket string `json:"customRulesBucket,omitempty"`
	// Description: Description of the Evaluation
	Description string `json:"description,omitempty"`
	// Labels: Labels as key value pairs
	Labels map[string]string `json:"labels,omitempty"`
	// Name: name of resource names have the form
	// 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}'
	Name string `json:"name,omitempty"`
	// ResourceFilter: annotations as key value pairs
	ResourceFilter *ResourceFilter `json:"resourceFilter,omitempty"`
	// ResourceStatus: Output only. [Output only] The updated rule ids if exist.
	ResourceStatus *ResourceStatus `json:"resourceStatus,omitempty"`
	// RuleNames: the name of the rule
	RuleNames []string `json:"ruleNames,omitempty"`
	// RuleVersions: Output only. [Output only] The updated rule ids if exist.
	RuleVersions []string `json:"ruleVersions,omitempty"`
	// Schedule: crontab format schedule for scheduled evaluation, currently only
	// support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * *
	// *", "0 0 */1 * *", "0 0 */7 * *",
	Schedule string `json:"schedule,omitempty"`
	// UpdateTime: Output only. [Output only] Update time stamp
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "BigQueryDestination") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BigQueryDestination") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Evaluation: LINT.IfChange Message describing Evaluation object

func (Evaluation) MarshalJSON

func (s Evaluation) MarshalJSON() ([]byte, error)

type Execution added in v0.118.0

type Execution struct {
	// EndTime: Output only. [Output only] End time stamp
	EndTime string `json:"endTime,omitempty"`
	// EvaluationId: Output only. [Output only] Evaluation ID
	EvaluationId string `json:"evaluationId,omitempty"`
	// ExternalDataSources: Optional. External data sources
	ExternalDataSources []*ExternalDataSources `json:"externalDataSources,omitempty"`
	// InventoryTime: Output only. [Output only] Inventory time stamp
	InventoryTime string `json:"inventoryTime,omitempty"`
	// Labels: Labels as key value pairs
	Labels map[string]string `json:"labels,omitempty"`
	// Name: The name of execution resource. The format is
	// projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{
	// execution}
	Name string `json:"name,omitempty"`
	// Notices: Output only. Additional information generated by the execution
	Notices []*Notice `json:"notices,omitempty"`
	// RuleResults: Output only. execution result summary per rule
	RuleResults []*RuleExecutionResult `json:"ruleResults,omitempty"`
	// RunType: type represent whether the execution executed directly by user or
	// scheduled according evaluation.schedule field.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - type of execution is unspecified
	//   "ONE_TIME" - type of execution is one time
	//   "SCHEDULED" - type of execution is scheduled
	RunType string `json:"runType,omitempty"`
	// StartTime: Output only. [Output only] Start time stamp
	StartTime string `json:"startTime,omitempty"`
	// State: Output only. [Output only] State
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - state of execution is unspecified
	//   "RUNNING" - the execution is running in backend service
	//   "SUCCEEDED" - the execution run success
	//   "FAILED" - the execution run failed
	State string `json:"state,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Execution: Message describing Execution object

func (Execution) MarshalJSON added in v0.118.0

func (s Execution) MarshalJSON() ([]byte, error)

type ExecutionResult added in v0.118.0

type ExecutionResult struct {
	// Commands: The commands to remediate the violation.
	Commands []*Command `json:"commands,omitempty"`
	// DocumentationUrl: The URL for the documentation of the rule.
	DocumentationUrl string `json:"documentationUrl,omitempty"`
	// Resource: The resource that violates the rule.
	Resource *Resource `json:"resource,omitempty"`
	// Rule: The rule that is violated in an evaluation.
	Rule string `json:"rule,omitempty"`
	// Severity: The severity of violation.
	Severity string `json:"severity,omitempty"`
	// Type: Execution result type of the scanned resource
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Unknown state
	//   "TYPE_PASSED" - resource successfully passed the rule
	//   "TYPE_VIOLATED" - resource violated the rule
	Type string `json:"type,omitempty"`
	// ViolationDetails: The details of violation in an evaluation result.
	ViolationDetails *ViolationDetails `json:"violationDetails,omitempty"`
	// ViolationMessage: The violation message of an execution.
	ViolationMessage string `json:"violationMessage,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Commands") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Commands") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExecutionResult: Message describing the result of an execution

func (ExecutionResult) MarshalJSON added in v0.118.0

func (s ExecutionResult) MarshalJSON() ([]byte, error)

type ExternalDataSources added in v0.181.0

type ExternalDataSources struct {
	// AssetType: Required. The asset type of the external data source this can be
	// one of go/cai-asset-types to override the default asset type or it can be a
	// custom type defined by the user custom type must match the asset type in the
	// rule
	AssetType string `json:"assetType,omitempty"`
	// Name: Optional. Name of external data source. The name will be used inside
	// the rego/sql to refer the external data
	Name string `json:"name,omitempty"`
	// Type: Required. Type of external data source
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Unknown type
	//   "BIG_QUERY_TABLE" - BigQuery table
	Type string `json:"type,omitempty"`
	// Uri: Required. URI of external data source. example of bq table
	// {project_ID}.{dataset_ID}.{table_ID}
	Uri string `json:"uri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AssetType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AssetType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExternalDataSources: Message for external data sources

func (ExternalDataSources) MarshalJSON added in v0.181.0

func (s ExternalDataSources) MarshalJSON() ([]byte, error)

type GceInstanceFilter

type GceInstanceFilter struct {
	// ServiceAccounts: Service account of compute engine
	ServiceAccounts []string `json:"serviceAccounts,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ServiceAccounts") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ServiceAccounts") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GceInstanceFilter: Message describing compute engine instance filter

func (GceInstanceFilter) MarshalJSON

func (s GceInstanceFilter) MarshalJSON() ([]byte, error)

type Insight

type Insight struct {
	// InstanceId: Required. The instance id where the insight is generated from
	InstanceId string `json:"instanceId,omitempty"`
	// SapDiscovery: The insights data for SAP system discovery. This is a copy of
	// SAP System proto and should get updated whenever that one changes.
	SapDiscovery *SapDiscovery `json:"sapDiscovery,omitempty"`
	// SapValidation: The insights data for the SAP workload validation.
	SapValidation *SapValidation `json:"sapValidation,omitempty"`
	// SentTime: Output only. [Output only] Create time stamp
	SentTime string `json:"sentTime,omitempty"`
	// SqlserverValidation: The insights data for the sqlserver workload
	// validation.
	SqlserverValidation *SqlserverValidation `json:"sqlserverValidation,omitempty"`
	// ForceSendFields is a list of field names (e.g. "InstanceId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "InstanceId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Insight: A presentation of host resource usage where the workload runs.

func (Insight) MarshalJSON

func (s Insight) MarshalJSON() ([]byte, error)

type ListEvaluationsResponse

type ListEvaluationsResponse struct {
	// Evaluations: The list of Evaluation
	Evaluations []*Evaluation `json:"evaluations,omitempty"`
	// NextPageToken: A token identifying a page of results the server should
	// return.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: Locations that could not be reached.
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Evaluations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Evaluations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListEvaluationsResponse: Message for response to listing Evaluations

func (ListEvaluationsResponse) MarshalJSON

func (s ListEvaluationsResponse) MarshalJSON() ([]byte, error)

type ListExecutionResultsResponse added in v0.118.0

type ListExecutionResultsResponse struct {
	// ExecutionResults: The versions from the specified publisher.
	ExecutionResults []*ExecutionResult `json:"executionResults,omitempty"`
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ExecutionResults") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExecutionResults") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListExecutionResultsResponse: Message for response of list execution results

func (ListExecutionResultsResponse) MarshalJSON added in v0.118.0

func (s ListExecutionResultsResponse) MarshalJSON() ([]byte, error)

type ListExecutionsResponse added in v0.118.0

type ListExecutionsResponse struct {
	// Executions: The list of Execution
	Executions []*Execution `json:"executions,omitempty"`
	// NextPageToken: A token identifying a page of results the server should
	// return.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: Locations that could not be reached.
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Executions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Executions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListExecutionsResponse: Message for response to listing Executions

func (ListExecutionsResponse) MarshalJSON added in v0.118.0

func (s ListExecutionsResponse) MarshalJSON() ([]byte, error)

type ListLocationsResponse

type ListLocationsResponse struct {
	// Locations: A list of locations that matches the specified filter in the
	// request.
	Locations []*Location `json:"locations,omitempty"`
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Locations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Locations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (ListLocationsResponse) MarshalJSON

func (s ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Operations: A list of operations that matches the specified filter in the
	// request.
	Operations []*Operation `json:"operations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse) MarshalJSON

func (s ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListRulesResponse added in v0.118.0

type ListRulesResponse struct {
	// NextPageToken: A token identifying a page of results the server should
	// return.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Rules: all rules in response
	Rules []*Rule `json:"rules,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListRulesResponse: Mesesage of response of list rules

func (ListRulesResponse) MarshalJSON added in v0.118.0

func (s ListRulesResponse) MarshalJSON() ([]byte, error)

type ListScannedResourcesResponse added in v0.118.0

type ListScannedResourcesResponse struct {
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// ScannedResources: All scanned resources in response
	ScannedResources []*ScannedResource `json:"scannedResources,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListScannedResourcesResponse: Message for response to list scanned resources

func (ListScannedResourcesResponse) MarshalJSON added in v0.118.0

func (s ListScannedResourcesResponse) MarshalJSON() ([]byte, error)

type Location

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby city
	// name. For example, "Tokyo".
	DisplayName string `json:"displayName,omitempty"`
	// Labels: Cross-service attributes for the location. For example
	// {"cloud.googleapis.com/region": "us-east1"}
	Labels map[string]string `json:"labels,omitempty"`
	// LocationId: The canonical id for this location. For example: "us-east1".
	LocationId string `json:"locationId,omitempty"`
	// Metadata: Service-specific metadata. For example the available capacity at
	// the given location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: Resource name for the location, which may vary between
	// implementations. For example:
	// "projects/example-project/locations/us-east1"
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Location: A resource that represents a Google Cloud location.

func (Location) MarshalJSON

func (s Location) MarshalJSON() ([]byte, error)

type Notice added in v0.204.0

type Notice struct {
	// Message: Output only. Message of the notice
	Message string `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Message") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Message") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Notice: Message for additional information generated by the execution

func (Notice) MarshalJSON added in v0.204.0

func (s Notice) MarshalJSON() ([]byte, error)

type Operation

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in progress.
	// If `true`, the operation is completed, and either `error` or `response` is
	// available.
	Done bool `json:"done,omitempty"`
	// Error: The error result of the operation in case of failure or cancellation.
	Error *Status `json:"error,omitempty"`
	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as create
	// time. Some services might not provide such metadata. Any method that returns
	// a long-running operation should document the metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: The server-assigned name, which is only unique within the same service
	// that originally returns it. If you use the default HTTP mapping, the `name`
	// should be a resource name ending with `operations/{unique_id}`.
	Name string `json:"name,omitempty"`
	// Response: The normal, successful response of the operation. If the original
	// method returns no data on success, such as `Delete`, the response is
	// `google.protobuf.Empty`. If the original method is standard
	// `Get`/`Create`/`Update`, the response should be the resource. For other
	// methods, the response should have the type `XxxResponse`, where `Xxx` is the
	// original method name. For example, if the original method name is
	// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Done") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Done") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (Operation) MarshalJSON

func (s Operation) MarshalJSON() ([]byte, error)

type OperationMetadata

type OperationMetadata struct {
	// ApiVersion: Output only. API version used to start the operation.
	ApiVersion string `json:"apiVersion,omitempty"`
	// CreateTime: Output only. The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: Output only. The time the operation finished running.
	EndTime string `json:"endTime,omitempty"`
	// RequestedCancellation: Output only. Identifies whether the user has
	// requested cancellation of the operation. Operations that have been cancelled
	// successfully have Operation.error value with a google.rpc.Status.code of 1,
	// corresponding to `Code.CANCELLED`.
	RequestedCancellation bool `json:"requestedCancellation,omitempty"`
	// StatusMessage: Output only. Human-readable status of the operation, if any.
	StatusMessage string `json:"statusMessage,omitempty"`
	// Target: Output only. Server-defined resource path for the target of the
	// operation.
	Target string `json:"target,omitempty"`
	// Verb: Output only. Name of the verb executed by the operation.
	Verb string `json:"verb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OperationMetadata: Represents the metadata of the long-running operation.

func (OperationMetadata) MarshalJSON

func (s OperationMetadata) MarshalJSON() ([]byte, error)

type ProjectsLocationsEvaluationsCreateCall

type ProjectsLocationsEvaluationsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsEvaluationsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEvaluationsCreateCall) Do

Do executes the "workloadmanager.projects.locations.evaluations.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEvaluationsCreateCall) EvaluationId

EvaluationId sets the optional parameter "evaluationId": Required. Id of the requesting object

func (*ProjectsLocationsEvaluationsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsEvaluationsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEvaluationsCreateCall) RequestId

RequestId sets the optional parameter "requestId": An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsEvaluationsDeleteCall added in v0.166.0

type ProjectsLocationsEvaluationsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsEvaluationsDeleteCall) Context added in v0.166.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEvaluationsDeleteCall) Do added in v0.166.0

Do executes the "workloadmanager.projects.locations.evaluations.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEvaluationsDeleteCall) Fields added in v0.166.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsEvaluationsDeleteCall) Force added in v0.172.0

Force sets the optional parameter "force": Followed the best practice from https://aip.dev/135#cascading-delete

func (*ProjectsLocationsEvaluationsDeleteCall) Header added in v0.166.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEvaluationsDeleteCall) RequestId added in v0.166.0

RequestId sets the optional parameter "requestId": An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsEvaluationsExecutionsDeleteCall added in v0.166.0

type ProjectsLocationsEvaluationsExecutionsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsEvaluationsExecutionsDeleteCall) Context added in v0.166.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEvaluationsExecutionsDeleteCall) Do added in v0.166.0

Do executes the "workloadmanager.projects.locations.evaluations.executions.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEvaluationsExecutionsDeleteCall) Fields added in v0.166.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsEvaluationsExecutionsDeleteCall) Header added in v0.166.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEvaluationsExecutionsDeleteCall) RequestId added in v0.166.0

RequestId sets the optional parameter "requestId": An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsEvaluationsExecutionsGetCall added in v0.118.0

type ProjectsLocationsEvaluationsExecutionsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsEvaluationsExecutionsGetCall) Context added in v0.118.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEvaluationsExecutionsGetCall) Do added in v0.118.0

Do executes the "workloadmanager.projects.locations.evaluations.executions.get" call. Any non-2xx status code is an error. Response headers are in either *Execution.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEvaluationsExecutionsGetCall) Fields added in v0.118.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsEvaluationsExecutionsGetCall) Header added in v0.118.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEvaluationsExecutionsGetCall) IfNoneMatch added in v0.118.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsEvaluationsExecutionsListCall added in v0.118.0

type ProjectsLocationsEvaluationsExecutionsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsEvaluationsExecutionsListCall) Context added in v0.118.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEvaluationsExecutionsListCall) Do added in v0.118.0

Do executes the "workloadmanager.projects.locations.evaluations.executions.list" call. Any non-2xx status code is an error. Response headers are in either *ListExecutionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEvaluationsExecutionsListCall) Fields added in v0.118.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsEvaluationsExecutionsListCall) Filter added in v0.118.0

Filter sets the optional parameter "filter": Filtering results

func (*ProjectsLocationsEvaluationsExecutionsListCall) Header added in v0.118.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEvaluationsExecutionsListCall) IfNoneMatch added in v0.118.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsEvaluationsExecutionsListCall) OrderBy added in v0.118.0

OrderBy sets the optional parameter "orderBy": Field to sort by. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsEvaluationsExecutionsListCall) PageSize added in v0.118.0

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsEvaluationsExecutionsListCall) PageToken added in v0.118.0

PageToken sets the optional parameter "pageToken": A token identifying a page of results the server should return.

func (*ProjectsLocationsEvaluationsExecutionsListCall) Pages added in v0.118.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsEvaluationsExecutionsResultsListCall added in v0.118.0

type ProjectsLocationsEvaluationsExecutionsResultsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsEvaluationsExecutionsResultsListCall) Context added in v0.118.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEvaluationsExecutionsResultsListCall) Do added in v0.118.0

Do executes the "workloadmanager.projects.locations.evaluations.executions.results.list" call. Any non-2xx status code is an error. Response headers are in either *ListExecutionResultsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEvaluationsExecutionsResultsListCall) Fields added in v0.118.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsEvaluationsExecutionsResultsListCall) Filter added in v0.118.0

Filter sets the optional parameter "filter": Filtering results

func (*ProjectsLocationsEvaluationsExecutionsResultsListCall) Header added in v0.118.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEvaluationsExecutionsResultsListCall) IfNoneMatch added in v0.118.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsEvaluationsExecutionsResultsListCall) PageSize added in v0.118.0

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsEvaluationsExecutionsResultsListCall) PageToken added in v0.118.0

PageToken sets the optional parameter "pageToken": A token identifying a page of results the server should return.

func (*ProjectsLocationsEvaluationsExecutionsResultsListCall) Pages added in v0.118.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsEvaluationsExecutionsResultsService added in v0.118.0

type ProjectsLocationsEvaluationsExecutionsResultsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsEvaluationsExecutionsResultsService added in v0.118.0

func NewProjectsLocationsEvaluationsExecutionsResultsService(s *Service) *ProjectsLocationsEvaluationsExecutionsResultsService

func (*ProjectsLocationsEvaluationsExecutionsResultsService) List added in v0.118.0

List: Lists the result of a single evaluation.

  • parent: The execution results. Format: {parent}/evaluations/*/executions/*/results.

type ProjectsLocationsEvaluationsExecutionsRunCall added in v0.118.0

type ProjectsLocationsEvaluationsExecutionsRunCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsEvaluationsExecutionsRunCall) Context added in v0.118.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEvaluationsExecutionsRunCall) Do added in v0.118.0

Do executes the "workloadmanager.projects.locations.evaluations.executions.run" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEvaluationsExecutionsRunCall) Fields added in v0.118.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsEvaluationsExecutionsRunCall) Header added in v0.118.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsEvaluationsExecutionsScannedResourcesListCall added in v0.118.0

type ProjectsLocationsEvaluationsExecutionsScannedResourcesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsEvaluationsExecutionsScannedResourcesListCall) Context added in v0.118.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEvaluationsExecutionsScannedResourcesListCall) Do added in v0.118.0

Do executes the "workloadmanager.projects.locations.evaluations.executions.scannedResources.list" call. Any non-2xx status code is an error. Response headers are in either *ListScannedResourcesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEvaluationsExecutionsScannedResourcesListCall) Fields added in v0.118.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsEvaluationsExecutionsScannedResourcesListCall) Filter added in v0.118.0

Filter sets the optional parameter "filter": Filtering results

func (*ProjectsLocationsEvaluationsExecutionsScannedResourcesListCall) Header added in v0.118.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEvaluationsExecutionsScannedResourcesListCall) IfNoneMatch added in v0.118.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsEvaluationsExecutionsScannedResourcesListCall) OrderBy added in v0.118.0

OrderBy sets the optional parameter "orderBy": Field to sort by. See https://google.aip.dev/132#ordering for more details.

func (*ProjectsLocationsEvaluationsExecutionsScannedResourcesListCall) PageSize added in v0.118.0

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsEvaluationsExecutionsScannedResourcesListCall) PageToken added in v0.118.0

PageToken sets the optional parameter "pageToken": A token identifying a page of results the server should return.

func (*ProjectsLocationsEvaluationsExecutionsScannedResourcesListCall) Pages added in v0.118.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsEvaluationsExecutionsScannedResourcesListCall) Rule added in v0.118.0

Rule sets the optional parameter "rule": rule name

type ProjectsLocationsEvaluationsExecutionsScannedResourcesService added in v0.118.0

type ProjectsLocationsEvaluationsExecutionsScannedResourcesService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsEvaluationsExecutionsScannedResourcesService added in v0.118.0

func NewProjectsLocationsEvaluationsExecutionsScannedResourcesService(s *Service) *ProjectsLocationsEvaluationsExecutionsScannedResourcesService

func (*ProjectsLocationsEvaluationsExecutionsScannedResourcesService) List added in v0.118.0

List: List all scanned resources for a single Execution.

- parent: parent for ListScannedResourcesRequest.

type ProjectsLocationsEvaluationsExecutionsService added in v0.118.0

type ProjectsLocationsEvaluationsExecutionsService struct {
	Results *ProjectsLocationsEvaluationsExecutionsResultsService

	ScannedResources *ProjectsLocationsEvaluationsExecutionsScannedResourcesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsEvaluationsExecutionsService added in v0.118.0

func NewProjectsLocationsEvaluationsExecutionsService(s *Service) *ProjectsLocationsEvaluationsExecutionsService

func (*ProjectsLocationsEvaluationsExecutionsService) Delete added in v0.166.0

Delete: Deletes a single Execution.

- name: Name of the resource.

func (*ProjectsLocationsEvaluationsExecutionsService) Get added in v0.118.0

Get: Gets details of a single Execution.

- name: Name of the resource.

func (*ProjectsLocationsEvaluationsExecutionsService) List added in v0.118.0

List: Lists Executions in a given project and location.

  • parent: The resource prefix of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}'.

func (*ProjectsLocationsEvaluationsExecutionsService) Run added in v0.118.0

Run: Creates a new Execution in a given project and location.

  • name: The resource name of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}/execution s/{execution}'.

type ProjectsLocationsEvaluationsGetCall

type ProjectsLocationsEvaluationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsEvaluationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEvaluationsGetCall) Do

Do executes the "workloadmanager.projects.locations.evaluations.get" call. Any non-2xx status code is an error. Response headers are in either *Evaluation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEvaluationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsEvaluationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEvaluationsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsEvaluationsListCall

type ProjectsLocationsEvaluationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsEvaluationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsEvaluationsListCall) Do

Do executes the "workloadmanager.projects.locations.evaluations.list" call. Any non-2xx status code is an error. Response headers are in either *ListEvaluationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEvaluationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsEvaluationsListCall) Filter

Filter sets the optional parameter "filter": Filter to be applied when listing the evaluation results.

func (*ProjectsLocationsEvaluationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsEvaluationsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsEvaluationsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Hint for how to order the results

func (*ProjectsLocationsEvaluationsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsEvaluationsListCall) PageToken

PageToken sets the optional parameter "pageToken": A token identifying a page of results the server should return.

func (*ProjectsLocationsEvaluationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsEvaluationsService

type ProjectsLocationsEvaluationsService struct {
	Executions *ProjectsLocationsEvaluationsExecutionsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsEvaluationsService

func NewProjectsLocationsEvaluationsService(s *Service) *ProjectsLocationsEvaluationsService

func (*ProjectsLocationsEvaluationsService) Create

Create: Creates a new Evaluation in a given project and location.

  • parent: The resource prefix of the evaluation location using the form: `projects/{project_id}/locations/{location_id}`.

func (*ProjectsLocationsEvaluationsService) Delete added in v0.166.0

Delete: Deletes a single Evaluation.

- name: Name of the resource.

func (*ProjectsLocationsEvaluationsService) Get

Get: Gets details of a single Evaluation.

- name: Name of the resource.

func (*ProjectsLocationsEvaluationsService) List

List: Lists Evaluations in a given project and location.

- parent: Parent value for ListEvaluationsRequest.

type ProjectsLocationsGetCall

type ProjectsLocationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetCall) Do

Do executes the "workloadmanager.projects.locations.get" call. Any non-2xx status code is an error. Response headers are in either *Location.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsGetCall) Header

func (c *ProjectsLocationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsGetCall) IfNoneMatch

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsInsightsService

type ProjectsLocationsInsightsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsInsightsService

func NewProjectsLocationsInsightsService(s *Service) *ProjectsLocationsInsightsService

func (*ProjectsLocationsInsightsService) WriteInsight

WriteInsight: Write the data insights to workload manager data warehouse.

  • location: The GCP location. The format is: projects/{project}/locations/{location}.

type ProjectsLocationsInsightsWriteInsightCall

type ProjectsLocationsInsightsWriteInsightCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInsightsWriteInsightCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInsightsWriteInsightCall) Do

Do executes the "workloadmanager.projects.locations.insights.writeInsight" call. Any non-2xx status code is an error. Response headers are in either *WriteInsightResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInsightsWriteInsightCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInsightsWriteInsightCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsListCall

type ProjectsLocationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListCall) Do

Do executes the "workloadmanager.projects.locations.list" call. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsListCall) Filter

Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

func (*ProjectsLocationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsListCall) IfNoneMatch

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

func (*ProjectsLocationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsOperationsCancelCall

type ProjectsLocationsOperationsCancelCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsCancelCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsCancelCall) Do

Do executes the "workloadmanager.projects.locations.operations.cancel" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsCancelCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsCancelCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsDeleteCall

type ProjectsLocationsOperationsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsDeleteCall) Do

Do executes the "workloadmanager.projects.locations.operations.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsGetCall

type ProjectsLocationsOperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsGetCall) Do

Do executes the "workloadmanager.projects.locations.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsOperationsListCall

type ProjectsLocationsOperationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsListCall) Do

Do executes the "workloadmanager.projects.locations.operations.list" call. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsListCall) Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsOperationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsOperationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsLocationsOperationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsLocationsOperationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsOperationsService

type ProjectsLocationsOperationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsOperationsService

func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService

func (*ProjectsLocationsOperationsService) Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsLocationsOperationsService) Delete

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsLocationsOperationsService) Get

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService) List

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

type ProjectsLocationsRulesListCall added in v0.118.0

type ProjectsLocationsRulesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsRulesListCall) Context added in v0.118.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRulesListCall) CustomRulesBucket added in v0.127.0

func (c *ProjectsLocationsRulesListCall) CustomRulesBucket(customRulesBucket string) *ProjectsLocationsRulesListCall

CustomRulesBucket sets the optional parameter "customRulesBucket": The Cloud Storage bucket name for custom rules.

func (*ProjectsLocationsRulesListCall) Do added in v0.118.0

Do executes the "workloadmanager.projects.locations.rules.list" call. Any non-2xx status code is an error. Response headers are in either *ListRulesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRulesListCall) Fields added in v0.118.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsRulesListCall) Filter added in v0.118.0

Filter sets the optional parameter "filter": Filter based on primary_category, secondary_category

func (*ProjectsLocationsRulesListCall) Header added in v0.118.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsRulesListCall) IfNoneMatch added in v0.118.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsRulesListCall) PageSize added in v0.118.0

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsRulesListCall) PageToken added in v0.118.0

PageToken sets the optional parameter "pageToken": A token identifying a page of results the server should return.

func (*ProjectsLocationsRulesListCall) Pages added in v0.118.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsRulesService added in v0.118.0

type ProjectsLocationsRulesService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsRulesService added in v0.118.0

func NewProjectsLocationsRulesService(s *Service) *ProjectsLocationsRulesService

func (*ProjectsLocationsRulesService) List added in v0.118.0

List: Lists rules in a given project.

  • parent: The [project] on which to execute the request. The format is: projects/{project_id}/locations/{location} Currently, the pre-defined rules are global available to all projects and all regions.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	Evaluations *ProjectsLocationsEvaluationsService

	Insights *ProjectsLocationsInsightsService

	Operations *ProjectsLocationsOperationsService

	Rules *ProjectsLocationsRulesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService) List

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

type ProjectsService

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type Resource added in v0.118.0

type Resource struct {
	// Name: The name of the resource.
	Name string `json:"name,omitempty"`
	// ServiceAccount: The service account associated with the resource.
	ServiceAccount string `json:"serviceAccount,omitempty"`
	// Type: The type of resource.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Resource: Message represent resource in execution result

func (Resource) MarshalJSON added in v0.118.0

func (s Resource) MarshalJSON() ([]byte, error)

type ResourceFilter

type ResourceFilter struct {
	// GceInstanceFilter: Filter compute engine resource
	GceInstanceFilter *GceInstanceFilter `json:"gceInstanceFilter,omitempty"`
	// InclusionLabels: The label used for filter resource
	InclusionLabels map[string]string `json:"inclusionLabels,omitempty"`
	// ResourceIdPatterns: The id pattern for filter resource
	ResourceIdPatterns []string `json:"resourceIdPatterns,omitempty"`
	// Scopes: The scopes of evaluation resource
	Scopes []string `json:"scopes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GceInstanceFilter") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GceInstanceFilter") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ResourceFilter: Message describing resource filters

func (ResourceFilter) MarshalJSON

func (s ResourceFilter) MarshalJSON() ([]byte, error)

type ResourceStatus

type ResourceStatus struct {
	// RulesNewerVersions: Historical: Used before 2023-05-22 the new version of
	// rule id if exists
	RulesNewerVersions []string `json:"rulesNewerVersions,omitempty"`
	// State: State of the resource
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - The state has not been populated in this message.
	//   "CREATING" - Resource has an active Create operation.
	//   "ACTIVE" - Resource has no outstanding operations on it or has active
	// Update operations.
	//   "DELETING" - Resource has an active Delete operation.
	State string `json:"state,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RulesNewerVersions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "RulesNewerVersions") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ResourceStatus: Message describing resource status

func (ResourceStatus) MarshalJSON

func (s ResourceStatus) MarshalJSON() ([]byte, error)

type Rule added in v0.118.0

type Rule struct {
	// Description: descrite rule in plain language
	Description string `json:"description,omitempty"`
	// DisplayName: the name display in UI
	DisplayName string `json:"displayName,omitempty"`
	// ErrorMessage: the message template for rule
	ErrorMessage string `json:"errorMessage,omitempty"`
	// Name: rule name
	Name string `json:"name,omitempty"`
	// PrimaryCategory: the primary category
	PrimaryCategory string `json:"primaryCategory,omitempty"`
	// Remediation: the remediation for the rule
	Remediation string `json:"remediation,omitempty"`
	// RevisionId: Output only. the version of the rule
	RevisionId string `json:"revisionId,omitempty"`
	// SecondaryCategory: the secondary category
	SecondaryCategory string `json:"secondaryCategory,omitempty"`
	// Severity: the severity of the rule
	Severity string `json:"severity,omitempty"`
	// Tags: List of user-defined tags
	Tags []string `json:"tags,omitempty"`
	// Uri: the docuement url for the rule
	Uri string `json:"uri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Rule: Message represent a rule

func (Rule) MarshalJSON added in v0.118.0

func (s Rule) MarshalJSON() ([]byte, error)

type RuleExecutionResult added in v0.202.0

type RuleExecutionResult struct {
	// Message: Execution message, if any
	Message string `json:"message,omitempty"`
	// ResultCount: Number of violations
	ResultCount int64 `json:"resultCount,omitempty,string"`
	// Rule: rule name
	Rule string `json:"rule,omitempty"`
	// ScannedResourceCount: Number of total scanned resources
	ScannedResourceCount int64 `json:"scannedResourceCount,omitempty,string"`
	// State: Output only. The execution status
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Unknown state
	//   "STATE_SUCCESS" - execution completed successfully
	//   "STATE_FAILURE" - execution completed with failures
	//   "STATE_SKIPPED" - execution was not executed
	State string `json:"state,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Message") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Message") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RuleExecutionResult: Message for execution result summary per rule

func (RuleExecutionResult) MarshalJSON added in v0.202.0

func (s RuleExecutionResult) MarshalJSON() ([]byte, error)

type RunEvaluationRequest added in v0.118.0

type RunEvaluationRequest struct {
	// Execution: Required. The resource being created
	Execution *Execution `json:"execution,omitempty"`
	// ExecutionId: Required. Id of the requesting object If auto-generating Id
	// server-side, remove this field and execution_id from the method_signature of
	// Create RPC
	ExecutionId string `json:"executionId,omitempty"`
	// RequestId: Optional. An optional request ID to identify requests. Specify a
	// unique request ID so that if you must retry your request, the server will
	// know to ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes since the first request. For example,
	// consider a situation where you make an initial request and the request times
	// out. If you make the request again with the same request ID, the server can
	// check if original operation with the same request ID was received, and if
	// so, will ignore the second request. This prevents clients from accidentally
	// creating duplicate commitments. The request ID must be a valid UUID with the
	// exception that zero UUID is not supported
	// (00000000-0000-0000-0000-000000000000).
	RequestId string `json:"requestId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Execution") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Execution") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RunEvaluationRequest: Message for creating a Execution

func (RunEvaluationRequest) MarshalJSON added in v0.118.0

func (s RunEvaluationRequest) MarshalJSON() ([]byte, error)

type SapDiscovery

type SapDiscovery struct {
	// ApplicationLayer: Optional. An SAP system may run without an application
	// layer.
	ApplicationLayer *SapDiscoveryComponent `json:"applicationLayer,omitempty"`
	// DatabaseLayer: Required. An SAP System must have a database.
	DatabaseLayer *SapDiscoveryComponent `json:"databaseLayer,omitempty"`
	// Metadata: Optional. The metadata for SAP system discovery data.
	Metadata *SapDiscoveryMetadata `json:"metadata,omitempty"`
	// ProjectNumber: Optional. The GCP project number that this SapSystem belongs
	// to.
	ProjectNumber string `json:"projectNumber,omitempty"`
	// SystemId: Output only. A combination of database SID, database instance URI
	// and tenant DB name to make a unique identifier per-system.
	SystemId string `json:"systemId,omitempty"`
	// UpdateTime: Required. Unix timestamp this system has been updated last.
	UpdateTime string `json:"updateTime,omitempty"`
	// WorkloadProperties: Optional. The properties of the workload.
	WorkloadProperties *SapDiscoveryWorkloadProperties `json:"workloadProperties,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApplicationLayer") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApplicationLayer") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SapDiscovery: The schema of SAP system discovery data.

func (SapDiscovery) MarshalJSON

func (s SapDiscovery) MarshalJSON() ([]byte, error)

type SapDiscoveryComponent

type SapDiscoveryComponent struct {
	// ApplicationProperties: Optional. The component is a SAP application.
	ApplicationProperties *SapDiscoveryComponentApplicationProperties `json:"applicationProperties,omitempty"`
	// DatabaseProperties: Optional. The component is a SAP database.
	DatabaseProperties *SapDiscoveryComponentDatabaseProperties `json:"databaseProperties,omitempty"`
	// HaHosts: Optional. A list of host URIs that are part of the HA configuration
	// if present. An empty list indicates the component is not configured for HA.
	HaHosts []string `json:"haHosts,omitempty"`
	// HostProject: Required. Pantheon Project in which the resources reside.
	HostProject string `json:"hostProject,omitempty"`
	// ReplicationSites: Optional. A list of replication sites used in Disaster
	// Recovery (DR) configurations.
	ReplicationSites []*SapDiscoveryComponent `json:"replicationSites,omitempty"`
	// Resources: Optional. The resources in a component.
	Resources []*SapDiscoveryResource `json:"resources,omitempty"`
	// Sid: Optional. The SAP identifier, used by the SAP software and helps
	// differentiate systems for customers.
	Sid string `json:"sid,omitempty"`
	// TopologyType: Optional. The detected topology of the component.
	//
	// Possible values:
	//   "TOPOLOGY_TYPE_UNSPECIFIED" - Unspecified topology.
	//   "TOPOLOGY_SCALE_UP" - A scale-up single node system.
	//   "TOPOLOGY_SCALE_OUT" - A scale-out multi-node system.
	TopologyType string `json:"topologyType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApplicationProperties") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApplicationProperties") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SapDiscoveryComponent: Message describing the system component.

func (SapDiscoveryComponent) MarshalJSON

func (s SapDiscoveryComponent) MarshalJSON() ([]byte, error)

type SapDiscoveryComponentApplicationProperties added in v0.133.0

type SapDiscoveryComponentApplicationProperties struct {
	// Abap: Optional. Deprecated: ApplicationType now tells you whether this is
	// ABAP or Java.
	Abap bool `json:"abap,omitempty"`
	// AppInstanceNumber: Optional. Instance number of the SAP application
	// instance.
	AppInstanceNumber string `json:"appInstanceNumber,omitempty"`
	// ApplicationType: Required. Type of the application. Netweaver, etc.
	//
	// Possible values:
	//   "APPLICATION_TYPE_UNSPECIFIED" - Unspecified application type
	//   "NETWEAVER" - SAP Netweaver
	//   "NETWEAVER_ABAP" - SAP Netweaver ABAP
	//   "NETWEAVER_JAVA" - SAP Netweaver Java
	ApplicationType string `json:"applicationType,omitempty"`
	// AscsInstanceNumber: Optional. Instance number of the ASCS instance.
	AscsInstanceNumber string `json:"ascsInstanceNumber,omitempty"`
	// AscsUri: Optional. Resource URI of the recognized ASCS host of the
	// application.
	AscsUri string `json:"ascsUri,omitempty"`
	// ErsInstanceNumber: Optional. Instance number of the ERS instance.
	ErsInstanceNumber string `json:"ersInstanceNumber,omitempty"`
	// KernelVersion: Optional. Kernel version for Netweaver running in the system.
	KernelVersion string `json:"kernelVersion,omitempty"`
	// NfsUri: Optional. Resource URI of the recognized shared NFS of the
	// application. May be empty if the application server has only a single node.
	NfsUri string `json:"nfsUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Abap") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Abap") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SapDiscoveryComponentApplicationProperties: A set of properties describing an SAP Application layer.

func (SapDiscoveryComponentApplicationProperties) MarshalJSON added in v0.133.0

type SapDiscoveryComponentDatabaseProperties added in v0.133.0

type SapDiscoveryComponentDatabaseProperties struct {
	// DatabaseSid: Optional. SID of the system database.
	DatabaseSid string `json:"databaseSid,omitempty"`
	// DatabaseType: Required. Type of the database. HANA, DB2, etc.
	//
	// Possible values:
	//   "DATABASE_TYPE_UNSPECIFIED" - Unspecified database type.
	//   "HANA" - SAP HANA
	//   "MAX_DB" - SAP MAX_DB
	//   "DB2" - IBM DB2
	DatabaseType string `json:"databaseType,omitempty"`
	// DatabaseVersion: Optional. The version of the database software running in
	// the system.
	DatabaseVersion string `json:"databaseVersion,omitempty"`
	// InstanceNumber: Optional. Instance number of the SAP instance.
	InstanceNumber string `json:"instanceNumber,omitempty"`
	// PrimaryInstanceUri: Required. URI of the recognized primary instance of the
	// database.
	PrimaryInstanceUri string `json:"primaryInstanceUri,omitempty"`
	// SharedNfsUri: Optional. URI of the recognized shared NFS of the database.
	// May be empty if the database has only a single node.
	SharedNfsUri string `json:"sharedNfsUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DatabaseSid") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DatabaseSid") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SapDiscoveryComponentDatabaseProperties: A set of properties describing an SAP Database layer.

func (SapDiscoveryComponentDatabaseProperties) MarshalJSON added in v0.133.0

func (s SapDiscoveryComponentDatabaseProperties) MarshalJSON() ([]byte, error)

type SapDiscoveryMetadata

type SapDiscoveryMetadata struct {
	// CustomerRegion: Optional. Customer region string for customer's use. Does
	// not represent GCP region.
	CustomerRegion string `json:"customerRegion,omitempty"`
	// DefinedSystem: Optional. Customer defined, something like "E-commerce pre
	// prod"
	DefinedSystem string `json:"definedSystem,omitempty"`
	// EnvironmentType: Optional. Should be "prod", "QA", "dev", "staging", etc.
	EnvironmentType string `json:"environmentType,omitempty"`
	// SapProduct: Optional. This SAP product name
	SapProduct string `json:"sapProduct,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CustomerRegion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CustomerRegion") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SapDiscoveryMetadata: Message describing SAP discovery system metadata

func (SapDiscoveryMetadata) MarshalJSON

func (s SapDiscoveryMetadata) MarshalJSON() ([]byte, error)

type SapDiscoveryResource

type SapDiscoveryResource struct {
	// InstanceProperties: Optional. A set of properties only applying to instance
	// type resources.
	InstanceProperties *SapDiscoveryResourceInstanceProperties `json:"instanceProperties,omitempty"`
	// RelatedResources: Optional. A list of resource URIs related to this
	// resource.
	RelatedResources []string `json:"relatedResources,omitempty"`
	// ResourceKind: Required. ComputeInstance, ComputeDisk, VPC, Bare Metal
	// server, etc.
	//
	// Possible values:
	//   "RESOURCE_KIND_UNSPECIFIED" - Unspecified resource kind.
	//   "RESOURCE_KIND_INSTANCE" - This is a compute instance.
	//   "RESOURCE_KIND_DISK" - This is a compute disk.
	//   "RESOURCE_KIND_ADDRESS" - This is a compute address.
	//   "RESOURCE_KIND_FILESTORE" - This is a filestore instance.
	//   "RESOURCE_KIND_HEALTH_CHECK" - This is a compute health check.
	//   "RESOURCE_KIND_FORWARDING_RULE" - This is a compute forwarding rule.
	//   "RESOURCE_KIND_BACKEND_SERVICE" - This is a compute backend service.
	//   "RESOURCE_KIND_SUBNETWORK" - This is a compute subnetwork.
	//   "RESOURCE_KIND_NETWORK" - This is a compute network.
	//   "RESOURCE_KIND_PUBLIC_ADDRESS" - This is a public accessible IP Address.
	//   "RESOURCE_KIND_INSTANCE_GROUP" - This is a compute instance group.
	ResourceKind string `json:"resourceKind,omitempty"`
	// ResourceType: Required. The type of this resource.
	//
	// Possible values:
	//   "RESOURCE_TYPE_UNSPECIFIED" - Undefined resource type.
	//   "RESOURCE_TYPE_COMPUTE" - This is a compute resource.
	//   "RESOURCE_TYPE_STORAGE" - This a storage resource.
	//   "RESOURCE_TYPE_NETWORK" - This is a network resource.
	ResourceType string `json:"resourceType,omitempty"`
	// ResourceUri: Required. URI of the resource, includes project, location, and
	// name.
	ResourceUri string `json:"resourceUri,omitempty"`
	// UpdateTime: Required. Unix timestamp of when this resource last had its
	// discovery data updated.
	UpdateTime string `json:"updateTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "InstanceProperties") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "InstanceProperties") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SapDiscoveryResource: Message describing a resource.

func (SapDiscoveryResource) MarshalJSON

func (s SapDiscoveryResource) MarshalJSON() ([]byte, error)

type SapDiscoveryResourceInstanceProperties added in v0.155.0

type SapDiscoveryResourceInstanceProperties struct {
	// AppInstances: Optional. App server instances on the host
	AppInstances []*SapDiscoveryResourceInstancePropertiesAppInstance `json:"appInstances,omitempty"`
	// ClusterInstances: Optional. A list of instance URIs that are part of a
	// cluster with this one.
	ClusterInstances []string `json:"clusterInstances,omitempty"`
	// InstanceNumber: Optional. The VM's instance number.
	InstanceNumber int64 `json:"instanceNumber,omitempty,string"`
	// InstanceRole: Optional. Bitmask of instance role, a resource may have
	// multiple roles at once.
	//
	// Possible values:
	//   "INSTANCE_ROLE_UNSPECIFIED" - Unspecified instance role.
	//   "INSTANCE_ROLE_ASCS" - Application central services.
	//   "INSTANCE_ROLE_ERS" - Enqueue replication server.
	//   "INSTANCE_ROLE_APP_SERVER" - Application server.
	//   "INSTANCE_ROLE_DATABASE" - Database node.
	//   "INSTANCE_ROLE_ASCS_ERS" - Combinations of roles. Application central
	// services and enqueue replication server.
	//   "INSTANCE_ROLE_ASCS_APP_SERVER" - Application central services and
	// application server.
	//   "INSTANCE_ROLE_ASCS_DATABASE" - Application central services and database.
	//   "INSTANCE_ROLE_ERS_APP_SERVER" - Enqueue replication server and
	// application server.
	//   "INSTANCE_ROLE_ERS_DATABASE" - Enqueue replication server and database.
	//   "INSTANCE_ROLE_APP_SERVER_DATABASE" - Application server and database.
	//   "INSTANCE_ROLE_ASCS_ERS_APP_SERVER" - Application central services,
	// enqueue replication server and application server.
	//   "INSTANCE_ROLE_ASCS_ERS_DATABASE" - Application central services, enqueue
	// replication server and database.
	//   "INSTANCE_ROLE_ASCS_APP_SERVER_DATABASE" - Application central services,
	// application server and database.
	//   "INSTANCE_ROLE_ERS_APP_SERVER_DATABASE" - Enqueue replication server,
	// application server and database.
	//   "INSTANCE_ROLE_ASCS_ERS_APP_SERVER_DATABASE" - Application central
	// services, enqueue replication server, application server and database.
	InstanceRole string `json:"instanceRole,omitempty"`
	// IsDrSite: Optional. Instance is part of a DR site.
	IsDrSite bool `json:"isDrSite,omitempty"`
	// VirtualHostname: Optional. A virtual hostname of the instance if it has one.
	VirtualHostname string `json:"virtualHostname,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AppInstances") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppInstances") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SapDiscoveryResourceInstanceProperties: A set of properties only present for an instance type resource

func (SapDiscoveryResourceInstanceProperties) MarshalJSON added in v0.155.0

func (s SapDiscoveryResourceInstanceProperties) MarshalJSON() ([]byte, error)

type SapDiscoveryResourceInstancePropertiesAppInstance added in v0.181.0

type SapDiscoveryResourceInstancePropertiesAppInstance struct {
	// Name: Optional. Instance name of the SAP application instance.
	Name string `json:"name,omitempty"`
	// Number: Optional. Instance number of the SAP application instance.
	Number string `json:"number,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SapDiscoveryResourceInstancePropertiesAppInstance: Fields to describe an SAP application server instance.

func (SapDiscoveryResourceInstancePropertiesAppInstance) MarshalJSON added in v0.181.0

type SapDiscoveryWorkloadProperties added in v0.166.0

type SapDiscoveryWorkloadProperties struct {
	// ProductVersions: Optional. List of SAP Products and their versions running
	// on the system.
	ProductVersions []*SapDiscoveryWorkloadPropertiesProductVersion `json:"productVersions,omitempty"`
	// SoftwareComponentVersions: Optional. A list of SAP software components and
	// their versions running on the system.
	SoftwareComponentVersions []*SapDiscoveryWorkloadPropertiesSoftwareComponentProperties `json:"softwareComponentVersions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ProductVersions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ProductVersions") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SapDiscoveryWorkloadProperties: A set of properties describing an SAP workload.

func (SapDiscoveryWorkloadProperties) MarshalJSON added in v0.166.0

func (s SapDiscoveryWorkloadProperties) MarshalJSON() ([]byte, error)

type SapDiscoveryWorkloadPropertiesProductVersion added in v0.166.0

type SapDiscoveryWorkloadPropertiesProductVersion struct {
	// Name: Optional. Name of the product.
	Name string `json:"name,omitempty"`
	// Version: Optional. Version of the product.
	Version string `json:"version,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SapDiscoveryWorkloadPropertiesProductVersion: A product name and version.

func (SapDiscoveryWorkloadPropertiesProductVersion) MarshalJSON added in v0.166.0

type SapDiscoveryWorkloadPropertiesSoftwareComponentProperties added in v0.166.0

type SapDiscoveryWorkloadPropertiesSoftwareComponentProperties struct {
	// ExtVersion: Optional. The component's minor version.
	ExtVersion string `json:"extVersion,omitempty"`
	// Name: Optional. Name of the component.
	Name string `json:"name,omitempty"`
	// Type: Optional. The component's type.
	Type string `json:"type,omitempty"`
	// Version: Optional. The component's major version.
	Version string `json:"version,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExtVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExtVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SapDiscoveryWorkloadPropertiesSoftwareComponentProperties: A SAP software component name, version, and type.

func (SapDiscoveryWorkloadPropertiesSoftwareComponentProperties) MarshalJSON added in v0.166.0

type SapValidation

type SapValidation struct {
	// ProjectId: Required. The project_id of the cloud project that the Insight
	// data comes from.
	ProjectId string `json:"projectId,omitempty"`
	// ValidationDetails: Optional. A list of SAP validation metrics data.
	ValidationDetails []*SapValidationValidationDetail `json:"validationDetails,omitempty"`
	// Zone: Optional. The zone of the instance that the Insight data comes from.
	Zone string `json:"zone,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ProjectId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ProjectId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SapValidation: A presentation of SAP workload insight. The schema of SAP workloads validation related data.

func (SapValidation) MarshalJSON

func (s SapValidation) MarshalJSON() ([]byte, error)

type SapValidationValidationDetail

type SapValidationValidationDetail struct {
	// Details: Optional. The pairs of metrics data: field name & field value.
	Details map[string]string `json:"details,omitempty"`
	// IsPresent: Optional. Was there a SAP system detected for this validation
	// type.
	IsPresent bool `json:"isPresent,omitempty"`
	// SapValidationType: Optional. The SAP system that the validation data is
	// from.
	//
	// Possible values:
	//   "SAP_VALIDATION_TYPE_UNSPECIFIED" - Unspecified type.
	//   "SYSTEM" - The SYSTEM validation type collects underlying system data from
	// the VM.
	//   "COROSYNC" - The COROSYNC validation type collects Corosync configuration
	// and runtime data. Corosync enables servers to interact as a HA cluster.
	//   "PACEMAKER" - The PACEMAKER validation type collects Pacemaker
	// configuration data. Pacemaker is a high-availability cluster resource
	// manager.
	//   "HANA" - The HANA validation type collects HANA configuration data. SAP
	// HANA is an in-memory, column-oriented, relational database management
	// system.
	//   "NETWEAVER" - The NETWEAVER validation type collects NetWeaver
	// configuration data. SAP NetWeaver is a software stack for many of SAP SE's
	// applications.
	//   "HANA_SECURITY" - The HANA_SECURITY validation type collects HANA
	// configuration data as it relates to SAP security best practices.
	//   "CUSTOM" - The CUSTOM validation type collects any customer-defined data
	// that does not fall into any of the other categories of validations.
	SapValidationType string `json:"sapValidationType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Details") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Details") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SapValidationValidationDetail: Message describing the SAP validation metrics.

func (SapValidationValidationDetail) MarshalJSON

func (s SapValidationValidationDetail) MarshalJSON() ([]byte, error)

type ScannedResource added in v0.118.0

type ScannedResource struct {
	// Resource: resource name
	Resource string `json:"resource,omitempty"`
	// Type: resource type
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Resource") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Resource") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ScannedResource: Message of scanned resource

func (ScannedResource) MarshalJSON added in v0.118.0

func (s ScannedResource) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type ShellCommand added in v0.187.0

type ShellCommand struct {
	// Args: args is a string of arguments to be passed to the command.
	Args string `json:"args,omitempty"`
	// Command: command is the name of the command to be executed.
	Command string `json:"command,omitempty"`
	// TimeoutSeconds: Optional. If not specified, the default timeout is 60
	// seconds.
	TimeoutSeconds int64 `json:"timeoutSeconds,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Args") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Args") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ShellCommand: * A ShellCommand is invoked via the agent's command line executor

func (ShellCommand) MarshalJSON added in v0.187.0

func (s ShellCommand) MarshalJSON() ([]byte, error)

type SqlserverValidation added in v0.123.0

type SqlserverValidation struct {
	// AgentVersion: Optional. The agent version collected this data point
	AgentVersion string `json:"agentVersion,omitempty"`
	// Instance: Required. The instance_name of the instance that the Insight data
	// comes from. According to https://linter.aip.dev/122/name-suffix: field names
	// should not use the _name suffix unless the field would be ambiguous without
	// it.
	Instance string `json:"instance,omitempty"`
	// ProjectId: Required. The project_id of the cloud project that the Insight
	// data comes from.
	ProjectId string `json:"projectId,omitempty"`
	// ValidationDetails: Optional. A list of SqlServer validation metrics data.
	ValidationDetails []*SqlserverValidationValidationDetail `json:"validationDetails,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AgentVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AgentVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlserverValidation: A presentation of SQLServer workload insight. The schema of SqlServer workloads validation related data.

func (SqlserverValidation) MarshalJSON added in v0.123.0

func (s SqlserverValidation) MarshalJSON() ([]byte, error)

type SqlserverValidationDetails added in v0.130.0

type SqlserverValidationDetails struct {
	// Fields: Required. Collected data is in format.
	Fields map[string]string `json:"fields,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Fields") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Fields") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlserverValidationDetails: Message containing collected data names and values.

func (SqlserverValidationDetails) MarshalJSON added in v0.130.0

func (s SqlserverValidationDetails) MarshalJSON() ([]byte, error)

type SqlserverValidationValidationDetail added in v0.123.0

type SqlserverValidationValidationDetail struct {
	// Details: Required. Details wraps map that represents collected data names
	// and values.
	Details []*SqlserverValidationDetails `json:"details,omitempty"`
	// Type: Optional. The Sqlserver system that the validation data is from.
	//
	// Possible values:
	//   "SQLSERVER_VALIDATION_TYPE_UNSPECIFIED" - Unspecified type.
	//   "OS" - The Sqlserver system named OS.
	//   "DB_LOG_DISK_SEPARATION" - The LOG_DISK_SEPARATION table.
	//   "DB_MAX_PARALLELISM" - The MAX_PARALLELISM table.
	//   "DB_CXPACKET_WAITS" - The CXPACKET_WAITS table.
	//   "DB_TRANSACTION_LOG_HANDLING" - The TRANSACTION_LOG_HANDLING table.
	//   "DB_VIRTUAL_LOG_FILE_COUNT" - The VIRTUAL_LOG_FILE_COUNT table.
	//   "DB_BUFFER_POOL_EXTENSION" - The BUFFER_POOL_EXTENSION table.
	//   "DB_MAX_SERVER_MEMORY" - The MAX_SERVER_MEMORY table.
	//   "INSTANCE_METRICS" - The INSTANCE_METRICS table.
	//   "DB_INDEX_FRAGMENTATION" - The DB_INDEX_FRAGMENTATION table.
	//   "DB_TABLE_INDEX_COMPRESSION" - The DB_TABLE_INDEX_COMPRESSION table.
	//   "DB_BACKUP_POLICY" - The DB_BACKUP_POLICY table.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Details") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Details") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlserverValidationValidationDetail: Message describing the Sqlserver validation metrics.

func (SqlserverValidationValidationDetail) MarshalJSON added in v0.123.0

func (s SqlserverValidationValidationDetail) MarshalJSON() ([]byte, error)

type Status

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `json:"code,omitempty"`
	// Details: A list of messages that carry the error details. There is a common
	// set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`
	// Message: A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	// google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Code") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (Status) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

type ViolationDetails added in v0.118.0

type ViolationDetails struct {
	// Asset: The name of the asset.
	Asset string `json:"asset,omitempty"`
	// Observed: Details of the violation.
	Observed map[string]string `json:"observed,omitempty"`
	// ServiceAccount: The service account associated with the resource.
	ServiceAccount string `json:"serviceAccount,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Asset") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Asset") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ViolationDetails: Message describing the violation in an evaluation result.

func (ViolationDetails) MarshalJSON added in v0.118.0

func (s ViolationDetails) MarshalJSON() ([]byte, error)

type WriteInsightRequest

type WriteInsightRequest struct {
	// AgentVersion: Optional. The agent version collected this data point.
	AgentVersion string `json:"agentVersion,omitempty"`
	// Insight: Required. The metrics data details.
	Insight *Insight `json:"insight,omitempty"`
	// RequestId: Optional. An optional request ID to identify requests. Specify a
	// unique request ID so that if you must retry your request, the server will
	// know to ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes since the first request. For example,
	// consider a situation where you make an initial request and the request times
	// out. If you make the request again with the same request ID, the server can
	// check if original operation with the same request ID was received, and if
	// so, will ignore the second request. This prevents clients from accidentally
	// creating duplicate commitments. The request ID must be a valid UUID with the
	// exception that zero UUID is not supported
	// (00000000-0000-0000-0000-000000000000).
	RequestId string `json:"requestId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AgentVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AgentVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

WriteInsightRequest: Request for sending the data insights.

func (WriteInsightRequest) MarshalJSON

func (s WriteInsightRequest) MarshalJSON() ([]byte, error)

type WriteInsightResponse

type WriteInsightResponse struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

WriteInsightResponse: The response for write insights request.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL