cloudcontrolspartner

package
v0.204.0 Latest Latest
Warning

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

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

Documentation

Overview

Package cloudcontrolspartner provides access to the Cloud Controls Partner API.

For product documentation, see: https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest

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/cloudcontrolspartner/v1beta"
...
ctx := context.Background()
cloudcontrolspartnerService, err := cloudcontrolspartner.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:

cloudcontrolspartnerService, err := cloudcontrolspartner.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, ...)
cloudcontrolspartnerService, err := cloudcontrolspartner.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 AccessApprovalRequest

type AccessApprovalRequest struct {
	// Name: Identifier. Format:
	// `organizations/{organization}/locations/{location}/customers/{customer}/workl
	// oads/{workload}/accessApprovalRequests/{access_approval_request}`
	Name string `json:"name,omitempty"`
	// RequestTime: The time at which approval was requested.
	RequestTime string `json:"requestTime,omitempty"`
	// RequestedExpirationTime: The requested expiration for the approval. If the
	// request is approved, access will be granted from the time of approval until
	// the expiration time.
	RequestedExpirationTime string `json:"requestedExpirationTime,omitempty"`
	// RequestedReason: The justification for which approval is being requested.
	RequestedReason *AccessReason `json:"requestedReason,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:"-"`
}

AccessApprovalRequest: Details about the Access request.

func (AccessApprovalRequest) MarshalJSON

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

type AccessReason

type AccessReason struct {
	// Detail: More detail about certain reason types. See comments for each type
	// above.
	Detail string `json:"detail,omitempty"`
	// Type: Type of access justification.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Default value for proto, shouldn't be used.
	//   "CUSTOMER_INITIATED_SUPPORT" - Customer made a request or raised an issue
	// that required the principal to access customer data. `detail` is of the form
	// ("#####" is the issue ID): - "Feedback Report: #####" - "Case Number: #####"
	// - "Case ID: #####" - "E-PIN Reference: #####" - "Google-#####" - "T-#####"
	//   "GOOGLE_INITIATED_SERVICE" - The principal accessed customer data in order
	// to diagnose or resolve a suspected issue in services. Often this access is
	// used to confirm that customers are not affected by a suspected service issue
	// or to remediate a reversible system issue.
	//   "GOOGLE_INITIATED_REVIEW" - Google initiated service for security, fraud,
	// abuse, or compliance purposes.
	//   "THIRD_PARTY_DATA_REQUEST" - The principal was compelled to access
	// customer data in order to respond to a legal third party data request or
	// process, including legal processes from customers themselves.
	//   "GOOGLE_RESPONSE_TO_PRODUCTION_ALERT" - The principal accessed customer
	// data in order to diagnose or resolve a suspected issue in services or a
	// known outage.
	//   "CLOUD_INITIATED_ACCESS" - Similar to 'GOOGLE_INITIATED_SERVICE' or
	// 'GOOGLE_INITIATED_REVIEW', but with universe agnostic naming. The principal
	// accessed customer data in order to diagnose or resolve a suspected issue in
	// services or a known outage, or for security, fraud, abuse, or compliance
	// review purposes.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Detail") 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. "Detail") 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:"-"`
}

AccessReason: Reason for the access.

func (AccessReason) MarshalJSON

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

type ConnectionError

type ConnectionError struct {
	// ErrorDomain: The error domain for the error
	ErrorDomain string `json:"errorDomain,omitempty"`
	// ErrorMessage: The error message for the error
	ErrorMessage string `json:"errorMessage,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ErrorDomain") 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. "ErrorDomain") 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:"-"`
}

ConnectionError: Information around the error that occurred if the connection state is anything other than available or unspecified

func (ConnectionError) MarshalJSON

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

type Console

type Console struct {
	// AdditionalLinks: Additional urls for more information about steps
	AdditionalLinks []string `json:"additionalLinks,omitempty"`
	// ConsoleUris: Link to console page where violations can be resolved
	ConsoleUris []string `json:"consoleUris,omitempty"`
	// Steps: Steps to resolve violation via cloud console
	Steps []string `json:"steps,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AdditionalLinks") 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. "AdditionalLinks") 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:"-"`
}

Console: Remediation instructions to resolve violation via cloud console

func (Console) MarshalJSON

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

type Customer

type Customer struct {
	// CustomerOnboardingState: Output only. Container for customer onboarding
	// steps
	CustomerOnboardingState *CustomerOnboardingState `json:"customerOnboardingState,omitempty"`
	// DisplayName: Required. Display name for the customer
	DisplayName string `json:"displayName,omitempty"`
	// IsOnboarded: Output only. Indicates whether a customer is fully onboarded
	IsOnboarded bool `json:"isOnboarded,omitempty"`
	// Name: Identifier. Format:
	// `organizations/{organization}/locations/{location}/customers/{customer}`
	Name string `json:"name,omitempty"`
	// OrganizationDomain: Output only. The customer organization domain, extracted
	// from CRM Organization’s display_name field. e.g. "google.com"
	OrganizationDomain string `json:"organizationDomain,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CustomerOnboardingState") 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. "CustomerOnboardingState") 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:"-"`
}

Customer: Contains metadata around a Cloud Controls Partner Customer

func (Customer) MarshalJSON

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

type CustomerOnboardingState

type CustomerOnboardingState struct {
	// OnboardingSteps: List of customer onboarding steps
	OnboardingSteps []*CustomerOnboardingStep `json:"onboardingSteps,omitempty"`
	// ForceSendFields is a list of field names (e.g. "OnboardingSteps") 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. "OnboardingSteps") 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:"-"`
}

CustomerOnboardingState: Container for customer onboarding steps

func (CustomerOnboardingState) MarshalJSON

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

type CustomerOnboardingStep

type CustomerOnboardingStep struct {
	// CompletionState: Output only. Current state of the step
	//
	// Possible values:
	//   "COMPLETION_STATE_UNSPECIFIED" - Unspecified completion state.
	//   "PENDING" - Task started (has start date) but not yet completed.
	//   "SUCCEEDED" - Succeeded state.
	//   "FAILED" - Failed state.
	//   "NOT_APPLICABLE" - Not applicable state.
	CompletionState string `json:"completionState,omitempty"`
	// CompletionTime: The completion time of the onboarding step
	CompletionTime string `json:"completionTime,omitempty"`
	// StartTime: The starting time of the onboarding step
	StartTime string `json:"startTime,omitempty"`
	// Step: The onboarding step
	//
	// Possible values:
	//   "STEP_UNSPECIFIED" - Unspecified step
	//   "KAJ_ENROLLMENT" - KAJ Enrollment
	//   "CUSTOMER_ENVIRONMENT" - Customer Environment
	Step string `json:"step,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CompletionState") 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. "CompletionState") 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:"-"`
}

CustomerOnboardingStep: Container for customer onboarding information

func (CustomerOnboardingStep) MarshalJSON

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

type EkmConnection

type EkmConnection struct {
	// ConnectionError: The connection error that occurred if any
	ConnectionError *ConnectionError `json:"connectionError,omitempty"`
	// ConnectionName: Resource name of the EKM connection in the format:
	// projects/{project}/locations/{location}/ekmConnections/{ekm_connection}
	ConnectionName string `json:"connectionName,omitempty"`
	// ConnectionState: Output only. The connection state
	//
	// Possible values:
	//   "CONNECTION_STATE_UNSPECIFIED" - Unspecified EKM connection state
	//   "AVAILABLE" - Available EKM connection state
	//   "NOT_AVAILABLE" - Not available EKM connection state
	//   "ERROR" - Error EKM connection state
	//   "PERMISSION_DENIED" - Permission denied EKM connection state
	ConnectionState string `json:"connectionState,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConnectionError") 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. "ConnectionError") 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:"-"`
}

EkmConnection: Details about the EKM connection

func (EkmConnection) MarshalJSON

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

type EkmConnections

type EkmConnections struct {
	// EkmConnections: The EKM connections associated with the workload
	EkmConnections []*EkmConnection `json:"ekmConnections,omitempty"`
	// Name: Identifier. Format:
	// `organizations/{organization}/locations/{location}/customers/{customer}/workl
	// oads/{workload}/ekmConnections`
	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. "EkmConnections") 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. "EkmConnections") 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:"-"`
}

EkmConnections: The EKM connections associated with a workload

func (EkmConnections) MarshalJSON

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

type EkmMetadata

type EkmMetadata struct {
	// EkmEndpointUri: Endpoint for sending requests to the EKM for key
	// provisioning during Assured Workload creation.
	EkmEndpointUri string `json:"ekmEndpointUri,omitempty"`
	// EkmSolution: The Cloud EKM partner.
	//
	// Possible values:
	//   "EKM_SOLUTION_UNSPECIFIED" - Unspecified EKM solution
	//   "FORTANIX" - EKM Partner Fortanix
	//   "FUTUREX" - EKM Partner FutureX
	//   "THALES" - EKM Partner Thales
	//   "VIRTRU" - EKM Partner Virtu
	EkmSolution string `json:"ekmSolution,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EkmEndpointUri") 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. "EkmEndpointUri") 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:"-"`
}

EkmMetadata: Holds information needed by Mudbray to use partner EKMs for workloads.

func (EkmMetadata) MarshalJSON

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

type Empty added in v0.204.0

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 Gcloud

type Gcloud struct {
	// AdditionalLinks: Additional urls for more information about steps
	AdditionalLinks []string `json:"additionalLinks,omitempty"`
	// GcloudCommands: Gcloud command to resolve violation
	GcloudCommands []string `json:"gcloudCommands,omitempty"`
	// Steps: Steps to resolve violation via gcloud cli
	Steps []string `json:"steps,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AdditionalLinks") 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. "AdditionalLinks") 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:"-"`
}

Gcloud: Remediation instructions to resolve violation via gcloud cli

func (Gcloud) MarshalJSON

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

type Instructions

type Instructions struct {
	// ConsoleInstructions: Remediation instructions to resolve violation via cloud
	// console
	ConsoleInstructions *Console `json:"consoleInstructions,omitempty"`
	// GcloudInstructions: Remediation instructions to resolve violation via gcloud
	// cli
	GcloudInstructions *Gcloud `json:"gcloudInstructions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConsoleInstructions") 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. "ConsoleInstructions") 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:"-"`
}

Instructions: Instructions to remediate violation

func (Instructions) MarshalJSON

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

type ListAccessApprovalRequestsResponse

type ListAccessApprovalRequestsResponse struct {
	// AccessApprovalRequests: List of access approval requests
	AccessApprovalRequests []*AccessApprovalRequest `json:"accessApprovalRequests,omitempty"`
	// NextPageToken: A token that 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"`
	// 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. "AccessApprovalRequests") 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. "AccessApprovalRequests") 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:"-"`
}

ListAccessApprovalRequestsResponse: Response message for list access requests.

func (ListAccessApprovalRequestsResponse) MarshalJSON

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

type ListCustomersResponse

type ListCustomersResponse struct {
	// Customers: List of customers
	Customers []*Customer `json:"customers,omitempty"`
	// NextPageToken: A token that 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"`
	// 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. "Customers") 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. "Customers") 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:"-"`
}

ListCustomersResponse: Response message for list customer Customers requests

func (ListCustomersResponse) MarshalJSON

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

type ListViolationsResponse

type ListViolationsResponse struct {
	// NextPageToken: A token that 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"`
	// Unreachable: Workloads that could not be reached due to permission errors or
	// any other error. Ref: https://google.aip.dev/217
	Unreachable []string `json:"unreachable,omitempty"`
	// Violations: List of violation
	Violations []*Violation `json:"violations,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:"-"`
}

ListViolationsResponse: Response message for list customer violation requests

func (ListViolationsResponse) MarshalJSON

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

type ListWorkloadsResponse

type ListWorkloadsResponse struct {
	// NextPageToken: A token that 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"`
	// Unreachable: Locations that could not be reached.
	Unreachable []string `json:"unreachable,omitempty"`
	// Workloads: List of customer workloads
	Workloads []*Workload `json:"workloads,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:"-"`
}

ListWorkloadsResponse: Response message for list customer workloads requests.

func (ListWorkloadsResponse) MarshalJSON

func (s ListWorkloadsResponse) 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 OrganizationsLocationsCustomersCreateCall added in v0.204.0

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

func (*OrganizationsLocationsCustomersCreateCall) Context added in v0.204.0

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

func (*OrganizationsLocationsCustomersCreateCall) CustomerId added in v0.204.0

CustomerId sets the optional parameter "customerId": Required. The customer id to use for the customer, which will become the final component of the customer's resource name. The specified value must be a valid Google cloud organization id.

func (*OrganizationsLocationsCustomersCreateCall) Do added in v0.204.0

Do executes the "cloudcontrolspartner.organizations.locations.customers.create" call. Any non-2xx status code is an error. Response headers are in either *Customer.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 (*OrganizationsLocationsCustomersCreateCall) Fields added in v0.204.0

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

func (*OrganizationsLocationsCustomersCreateCall) Header added in v0.204.0

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

type OrganizationsLocationsCustomersDeleteCall added in v0.204.0

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

func (*OrganizationsLocationsCustomersDeleteCall) Context added in v0.204.0

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

func (*OrganizationsLocationsCustomersDeleteCall) Do added in v0.204.0

Do executes the "cloudcontrolspartner.organizations.locations.customers.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 (*OrganizationsLocationsCustomersDeleteCall) Fields added in v0.204.0

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

func (*OrganizationsLocationsCustomersDeleteCall) Header added in v0.204.0

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

type OrganizationsLocationsCustomersGetCall

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

func (*OrganizationsLocationsCustomersGetCall) Context

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

func (*OrganizationsLocationsCustomersGetCall) Do

Do executes the "cloudcontrolspartner.organizations.locations.customers.get" call. Any non-2xx status code is an error. Response headers are in either *Customer.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 (*OrganizationsLocationsCustomersGetCall) Fields

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

func (*OrganizationsLocationsCustomersGetCall) Header

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

func (*OrganizationsLocationsCustomersGetCall) 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 OrganizationsLocationsCustomersListCall

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

func (*OrganizationsLocationsCustomersListCall) Context

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

func (*OrganizationsLocationsCustomersListCall) Do

Do executes the "cloudcontrolspartner.organizations.locations.customers.list" call. Any non-2xx status code is an error. Response headers are in either *ListCustomersResponse.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 (*OrganizationsLocationsCustomersListCall) Fields

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

func (*OrganizationsLocationsCustomersListCall) Filter

Filter sets the optional parameter "filter": Filtering results

func (*OrganizationsLocationsCustomersListCall) Header

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

func (*OrganizationsLocationsCustomersListCall) 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 (*OrganizationsLocationsCustomersListCall) OrderBy

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

func (*OrganizationsLocationsCustomersListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of Customers to return. The service may return fewer than this value. If unspecified, at most 500 Customers will be returned.

func (*OrganizationsLocationsCustomersListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListCustomers` call. Provide this to retrieve the subsequent page.

func (*OrganizationsLocationsCustomersListCall) 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 OrganizationsLocationsCustomersPatchCall added in v0.204.0

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

func (*OrganizationsLocationsCustomersPatchCall) Context added in v0.204.0

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

func (*OrganizationsLocationsCustomersPatchCall) Do added in v0.204.0

Do executes the "cloudcontrolspartner.organizations.locations.customers.patch" call. Any non-2xx status code is an error. Response headers are in either *Customer.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 (*OrganizationsLocationsCustomersPatchCall) Fields added in v0.204.0

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

func (*OrganizationsLocationsCustomersPatchCall) Header added in v0.204.0

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

func (*OrganizationsLocationsCustomersPatchCall) UpdateMask added in v0.204.0

UpdateMask sets the optional parameter "updateMask": The list of fields to update

type OrganizationsLocationsCustomersService

type OrganizationsLocationsCustomersService struct {
	Workloads *OrganizationsLocationsCustomersWorkloadsService
	// contains filtered or unexported fields
}

func NewOrganizationsLocationsCustomersService

func NewOrganizationsLocationsCustomersService(s *Service) *OrganizationsLocationsCustomersService

func (*OrganizationsLocationsCustomersService) Create added in v0.204.0

Create: Creates a new customer.

  • parent: Parent resource Format: `organizations/{organization}/locations/{location}`.

func (*OrganizationsLocationsCustomersService) Delete added in v0.204.0

Delete: Delete details of a single customer

  • name: name of the resource to be deleted format: name=organizations/*/locations/*/customers/*.

func (*OrganizationsLocationsCustomersService) Get

Get: Gets details of a single customer

  • name: Format: `organizations/{organization}/locations/{location}/customers/{customer}`.

func (*OrganizationsLocationsCustomersService) List

List: Lists customers of a partner identified by its Google Cloud organization ID

  • parent: Parent resource Format: `organizations/{organization}/locations/{location}`.

func (*OrganizationsLocationsCustomersService) Patch added in v0.204.0

Patch: Update details of a single customer

  • name: Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`.

type OrganizationsLocationsCustomersWorkloadsAccessApprovalRequestsListCall

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

func (*OrganizationsLocationsCustomersWorkloadsAccessApprovalRequestsListCall) Context

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

func (*OrganizationsLocationsCustomersWorkloadsAccessApprovalRequestsListCall) Do

Do executes the "cloudcontrolspartner.organizations.locations.customers.workloads.accessApprovalRequests.list" call. Any non-2xx status code is an error. Response headers are in either *ListAccessApprovalRequestsResponse.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 (*OrganizationsLocationsCustomersWorkloadsAccessApprovalRequestsListCall) Fields

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

func (*OrganizationsLocationsCustomersWorkloadsAccessApprovalRequestsListCall) Filter

Filter sets the optional parameter "filter": Filtering results.

func (*OrganizationsLocationsCustomersWorkloadsAccessApprovalRequestsListCall) Header

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

func (*OrganizationsLocationsCustomersWorkloadsAccessApprovalRequestsListCall) 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 (*OrganizationsLocationsCustomersWorkloadsAccessApprovalRequestsListCall) OrderBy

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

func (*OrganizationsLocationsCustomersWorkloadsAccessApprovalRequestsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of access requests to return. The service may return fewer than this value. If unspecified, at most 500 access requests will be returned.

func (*OrganizationsLocationsCustomersWorkloadsAccessApprovalRequestsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListAccessApprovalRequests` call. Provide this to retrieve the subsequent page.

func (*OrganizationsLocationsCustomersWorkloadsAccessApprovalRequestsListCall) 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 OrganizationsLocationsCustomersWorkloadsAccessApprovalRequestsService

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

func (*OrganizationsLocationsCustomersWorkloadsAccessApprovalRequestsService) List

List: Deprecated: Only returns access approval requests directly associated with an assured workload folder.

  • parent: Parent resource Format: `organizations/{organization}/locations/{location}/customers/{customer}/wor kloads/{workload}`.

type OrganizationsLocationsCustomersWorkloadsGetCall

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

func (*OrganizationsLocationsCustomersWorkloadsGetCall) Context

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

func (*OrganizationsLocationsCustomersWorkloadsGetCall) Do

Do executes the "cloudcontrolspartner.organizations.locations.customers.workloads.get" call. Any non-2xx status code is an error. Response headers are in either *Workload.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 (*OrganizationsLocationsCustomersWorkloadsGetCall) Fields

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

func (*OrganizationsLocationsCustomersWorkloadsGetCall) Header

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

func (*OrganizationsLocationsCustomersWorkloadsGetCall) 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 OrganizationsLocationsCustomersWorkloadsGetEkmConnectionsCall

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

func (*OrganizationsLocationsCustomersWorkloadsGetEkmConnectionsCall) Context

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

func (*OrganizationsLocationsCustomersWorkloadsGetEkmConnectionsCall) Do

Do executes the "cloudcontrolspartner.organizations.locations.customers.workloads.getEkmConnections" call. Any non-2xx status code is an error. Response headers are in either *EkmConnections.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 (*OrganizationsLocationsCustomersWorkloadsGetEkmConnectionsCall) Fields

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

func (*OrganizationsLocationsCustomersWorkloadsGetEkmConnectionsCall) Header

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

func (*OrganizationsLocationsCustomersWorkloadsGetEkmConnectionsCall) 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 OrganizationsLocationsCustomersWorkloadsGetPartnerPermissionsCall

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

func (*OrganizationsLocationsCustomersWorkloadsGetPartnerPermissionsCall) Context

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

func (*OrganizationsLocationsCustomersWorkloadsGetPartnerPermissionsCall) Do

Do executes the "cloudcontrolspartner.organizations.locations.customers.workloads.getPartnerPermissions" call. Any non-2xx status code is an error. Response headers are in either *PartnerPermissions.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 (*OrganizationsLocationsCustomersWorkloadsGetPartnerPermissionsCall) Fields

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

func (*OrganizationsLocationsCustomersWorkloadsGetPartnerPermissionsCall) Header

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

func (*OrganizationsLocationsCustomersWorkloadsGetPartnerPermissionsCall) 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 OrganizationsLocationsCustomersWorkloadsListCall

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

func (*OrganizationsLocationsCustomersWorkloadsListCall) Context

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

func (*OrganizationsLocationsCustomersWorkloadsListCall) Do

Do executes the "cloudcontrolspartner.organizations.locations.customers.workloads.list" call. Any non-2xx status code is an error. Response headers are in either *ListWorkloadsResponse.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 (*OrganizationsLocationsCustomersWorkloadsListCall) Fields

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

func (*OrganizationsLocationsCustomersWorkloadsListCall) Filter

Filter sets the optional parameter "filter": Filtering results.

func (*OrganizationsLocationsCustomersWorkloadsListCall) Header

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

func (*OrganizationsLocationsCustomersWorkloadsListCall) 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 (*OrganizationsLocationsCustomersWorkloadsListCall) OrderBy

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

func (*OrganizationsLocationsCustomersWorkloadsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of workloads to return. The service may return fewer than this value. If unspecified, at most 500 workloads will be returned.

func (*OrganizationsLocationsCustomersWorkloadsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListWorkloads` call. Provide this to retrieve the subsequent page.

func (*OrganizationsLocationsCustomersWorkloadsListCall) 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 OrganizationsLocationsCustomersWorkloadsService

type OrganizationsLocationsCustomersWorkloadsService struct {
	AccessApprovalRequests *OrganizationsLocationsCustomersWorkloadsAccessApprovalRequestsService

	Violations *OrganizationsLocationsCustomersWorkloadsViolationsService
	// contains filtered or unexported fields
}

func NewOrganizationsLocationsCustomersWorkloadsService

func NewOrganizationsLocationsCustomersWorkloadsService(s *Service) *OrganizationsLocationsCustomersWorkloadsService

func (*OrganizationsLocationsCustomersWorkloadsService) Get

Get: Gets details of a single workload

  • name: Format: `organizations/{organization}/locations/{location}/customers/{customer}/wor kloads/{workload}`.

func (*OrganizationsLocationsCustomersWorkloadsService) GetEkmConnections

GetEkmConnections: Gets the EKM connections associated with a workload

  • name: Format: `organizations/{organization}/locations/{location}/customers/{customer}/wor kloads/{workload}/ekmConnections`.

func (*OrganizationsLocationsCustomersWorkloadsService) GetPartnerPermissions

GetPartnerPermissions: Gets the partner permissions granted for a workload

  • name: Name of the resource to get in the format: `organizations/{organization}/locations/{location}/customers/{customer}/wor kloads/{workload}/partnerPermissions`.

func (*OrganizationsLocationsCustomersWorkloadsService) List

List: Lists customer workloads for a given customer org id

  • parent: Parent resource Format: `organizations/{organization}/locations/{location}/customers/{customer}`.

type OrganizationsLocationsCustomersWorkloadsViolationsGetCall

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

func (*OrganizationsLocationsCustomersWorkloadsViolationsGetCall) Context

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

func (*OrganizationsLocationsCustomersWorkloadsViolationsGetCall) Do

Do executes the "cloudcontrolspartner.organizations.locations.customers.workloads.violations.get" call. Any non-2xx status code is an error. Response headers are in either *Violation.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 (*OrganizationsLocationsCustomersWorkloadsViolationsGetCall) Fields

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

func (*OrganizationsLocationsCustomersWorkloadsViolationsGetCall) Header

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

func (*OrganizationsLocationsCustomersWorkloadsViolationsGetCall) 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 OrganizationsLocationsCustomersWorkloadsViolationsListCall

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

func (*OrganizationsLocationsCustomersWorkloadsViolationsListCall) Context

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

func (*OrganizationsLocationsCustomersWorkloadsViolationsListCall) Do

Do executes the "cloudcontrolspartner.organizations.locations.customers.workloads.violations.list" call. Any non-2xx status code is an error. Response headers are in either *ListViolationsResponse.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 (*OrganizationsLocationsCustomersWorkloadsViolationsListCall) Fields

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

func (*OrganizationsLocationsCustomersWorkloadsViolationsListCall) Filter

Filter sets the optional parameter "filter": Filtering results

func (*OrganizationsLocationsCustomersWorkloadsViolationsListCall) Header

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

func (*OrganizationsLocationsCustomersWorkloadsViolationsListCall) 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 (*OrganizationsLocationsCustomersWorkloadsViolationsListCall) IntervalEndTime

IntervalEndTime sets the optional parameter "interval.endTime": Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

func (*OrganizationsLocationsCustomersWorkloadsViolationsListCall) IntervalStartTime

IntervalStartTime sets the optional parameter "interval.startTime": Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

func (*OrganizationsLocationsCustomersWorkloadsViolationsListCall) OrderBy

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

func (*OrganizationsLocationsCustomersWorkloadsViolationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of customers row to return. The service may return fewer than this value. If unspecified, at most 10 customers will be returned.

func (*OrganizationsLocationsCustomersWorkloadsViolationsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListViolations` call. Provide this to retrieve the subsequent page.

func (*OrganizationsLocationsCustomersWorkloadsViolationsListCall) 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 OrganizationsLocationsCustomersWorkloadsViolationsService

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

func (*OrganizationsLocationsCustomersWorkloadsViolationsService) Get

Get: Gets details of a single Violation.

  • name: Format: `organizations/{organization}/locations/{location}/customers/{customer}/wor kloads/{workload}/violations/{violation}`.

func (*OrganizationsLocationsCustomersWorkloadsViolationsService) List

List: Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per AIP-159 (https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of {customer} & {workload}. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workl oads/{workload}`

  • parent: Parent resource Format `organizations/{organization}/locations/{location}/customers/{customer}/wor kloads/{workload}`.

type OrganizationsLocationsGetPartnerCall

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

func (*OrganizationsLocationsGetPartnerCall) Context

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

func (*OrganizationsLocationsGetPartnerCall) Do

Do executes the "cloudcontrolspartner.organizations.locations.getPartner" call. Any non-2xx status code is an error. Response headers are in either *Partner.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 (*OrganizationsLocationsGetPartnerCall) Fields

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

func (*OrganizationsLocationsGetPartnerCall) Header

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

func (*OrganizationsLocationsGetPartnerCall) 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 OrganizationsLocationsService

type OrganizationsLocationsService struct {
	Customers *OrganizationsLocationsCustomersService
	// contains filtered or unexported fields
}

func NewOrganizationsLocationsService

func NewOrganizationsLocationsService(s *Service) *OrganizationsLocationsService

func (*OrganizationsLocationsService) GetPartner

GetPartner: Get details of a Partner.

- name: Format: `organizations/{organization}/locations/{location}/partner`.

type OrganizationsService

type OrganizationsService struct {
	Locations *OrganizationsLocationsService
	// contains filtered or unexported fields
}

func NewOrganizationsService

func NewOrganizationsService(s *Service) *OrganizationsService

type Partner

type Partner struct {
	// CreateTime: Output only. Time the resource was created
	CreateTime string `json:"createTime,omitempty"`
	// EkmSolutions: List of Google Cloud supported EKM partners supported by the
	// partner
	EkmSolutions []*EkmMetadata `json:"ekmSolutions,omitempty"`
	// Name: Identifier. The resource name of the partner. Format:
	// `organizations/{organization}/locations/{location}/partner` Example:
	// "organizations/123456/locations/us-central1/partner"
	Name string `json:"name,omitempty"`
	// OperatedCloudRegions: List of Google Cloud regions that the partner sells
	// services to customers. Valid Google Cloud regions found here:
	// https://cloud.google.com/compute/docs/regions-zones
	OperatedCloudRegions []string `json:"operatedCloudRegions,omitempty"`
	// PartnerProjectId: Google Cloud project ID in the partner's Google Cloud
	// organization for receiving enhanced Logs for Partners.
	PartnerProjectId string `json:"partnerProjectId,omitempty"`
	// Skus: List of SKUs the partner is offering
	Skus []*Sku `json:"skus,omitempty"`
	// UpdateTime: Output only. The last time the resource was updated
	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. "CreateTime") 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. "CreateTime") 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:"-"`
}

Partner: Message describing Partner resource

func (Partner) MarshalJSON

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

type PartnerPermissions

type PartnerPermissions struct {
	// Name: Identifier. Format:
	// `organizations/{organization}/locations/{location}/customers/{customer}/workl
	// oads/{workload}/partnerPermissions`
	Name string `json:"name,omitempty"`
	// PartnerPermissions: The partner permissions granted for the workload
	//
	// Possible values:
	//   "PERMISSION_UNSPECIFIED" - Unspecified partner permission
	//   "ACCESS_TRANSPARENCY_AND_EMERGENCY_ACCESS_LOGS" - Permission for Access
	// Transparency and emergency logs
	//   "ASSURED_WORKLOADS_MONITORING" - Permission for Assured Workloads
	// monitoring violations
	//   "ACCESS_APPROVAL_REQUESTS" - Permission for Access Approval requests
	//   "ASSURED_WORKLOADS_EKM_CONNECTION_STATUS" - Permission for External Key
	// Manager connection status
	//   "ACCESS_TRANSPARENCY_LOGS_SUPPORT_CASE_VIEWER" - Permission for support
	// case details for Access Transparency log entries
	PartnerPermissions []string `json:"partnerPermissions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// 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:"-"`
}

PartnerPermissions: The permissions granted to the partner for a workload

func (PartnerPermissions) MarshalJSON

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

type Remediation

type Remediation struct {
	// CompliantValues: Values that can resolve the violation For example: for list
	// org policy violations, this will either be the list of allowed or denied
	// values
	CompliantValues []string `json:"compliantValues,omitempty"`
	// Instructions: Required. Remediation instructions to resolve violations
	Instructions *Instructions `json:"instructions,omitempty"`
	// RemediationType: Output only. Remediation type based on the type of org
	// policy values violated
	//
	// Possible values:
	//   "REMEDIATION_TYPE_UNSPECIFIED" - Unspecified remediation type
	//   "REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION" - Remediation type for boolean
	// org policy
	//   "REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION" - Remediation type
	// for list org policy which have allowed values in the monitoring rule
	//   "REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION" - Remediation type
	// for list org policy which have denied values in the monitoring rule
	//   "REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION" -
	// Remediation type for gcp.restrictCmekCryptoKeyProjects
	//   "REMEDIATION_RESOURCE_VIOLATION" - Remediation type for resource
	// violation.
	RemediationType string `json:"remediationType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CompliantValues") 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. "CompliantValues") 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:"-"`
}

Remediation: Represents remediation guidance to resolve compliance violation for AssuredWorkload

func (Remediation) MarshalJSON

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

type Service

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

	Organizations *OrganizationsService
	// 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 Sku

type Sku struct {
	// DisplayName: Display name of the product identified by the SKU. A partner
	// may want to show partner branded names for their offerings such as local
	// sovereign cloud solutions.
	DisplayName string `json:"displayName,omitempty"`
	// Id: Argentum product SKU, that is associated with the partner offerings to
	// customers used by Syntro for billing purposes. SKUs can represent resold
	// Google products or support services.
	Id string `json:"id,omitempty"`
	// 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:"-"`
}

Sku: Represents the SKU a partner owns inside Google Cloud to sell to customers.

func (Sku) MarshalJSON

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

type Violation

type Violation struct {
	// BeginTime: Output only. Time of the event which triggered the Violation.
	BeginTime string `json:"beginTime,omitempty"`
	// Category: Output only. Category under which this violation is mapped. e.g.
	// Location, Service Usage, Access, Encryption, etc.
	Category string `json:"category,omitempty"`
	// Description: Output only. Description for the Violation. e.g. OrgPolicy
	// gcp.resourceLocations has non compliant value.
	Description string `json:"description,omitempty"`
	// FolderId: The folder_id of the violation
	FolderId int64 `json:"folderId,omitempty,string"`
	// Name: Identifier. Format:
	// `organizations/{organization}/locations/{location}/customers/{customer}/workl
	// oads/{workload}/violations/{violation}`
	Name string `json:"name,omitempty"`
	// NonCompliantOrgPolicy: Output only. Immutable. Name of the OrgPolicy which
	// was modified with non-compliant change and resulted this violation. Format:
	// `projects/{project_number}/policies/{constraint_name}`
	// `folders/{folder_id}/policies/{constraint_name}`
	// `organizations/{organization_id}/policies/{constraint_name}`
	NonCompliantOrgPolicy string `json:"nonCompliantOrgPolicy,omitempty"`
	// Remediation: Output only. Compliance violation remediation
	Remediation *Remediation `json:"remediation,omitempty"`
	// ResolveTime: Output only. Time of the event which fixed the Violation. If
	// the violation is ACTIVE this will be empty.
	ResolveTime string `json:"resolveTime,omitempty"`
	// State: Output only. State of the violation
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Unspecified state.
	//   "RESOLVED" - Violation is resolved.
	//   "UNRESOLVED" - Violation is Unresolved
	//   "EXCEPTION" - Violation is Exception
	State string `json:"state,omitempty"`
	// UpdateTime: Output only. The last time when the Violation record was
	// updated.
	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. "BeginTime") 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. "BeginTime") 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:"-"`
}

Violation: Details of resource Violation

func (Violation) MarshalJSON

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

type Workload

type Workload struct {
	// CreateTime: Output only. Time the resource was created.
	CreateTime string `json:"createTime,omitempty"`
	// Folder: Output only. The name of container folder of the assured workload
	Folder string `json:"folder,omitempty"`
	// FolderId: Output only. Folder id this workload is associated with
	FolderId int64 `json:"folderId,omitempty,string"`
	// IsOnboarded: Indicates whether a workload is fully onboarded.
	IsOnboarded bool `json:"isOnboarded,omitempty"`
	// KeyManagementProjectId: The project id of the key management project for the
	// workload
	KeyManagementProjectId string `json:"keyManagementProjectId,omitempty"`
	// Location: The Google Cloud location of the workload
	Location string `json:"location,omitempty"`
	// Name: Identifier. Format:
	// `organizations/{organization}/locations/{location}/customers/{customer}/workl
	// oads/{workload}`
	Name string `json:"name,omitempty"`
	// Partner: Partner associated with this workload.
	//
	// Possible values:
	//   "PARTNER_UNSPECIFIED" - Unknown Partner.
	//   "PARTNER_LOCAL_CONTROLS_BY_S3NS" - Enum representing S3NS (Thales)
	// partner.
	//   "PARTNER_SOVEREIGN_CONTROLS_BY_T_SYSTEMS" - Enum representing T_SYSTEM
	// (TSI) partner.
	//   "PARTNER_SOVEREIGN_CONTROLS_BY_SIA_MINSAIT" - Enum representing
	// SIA_MINSAIT (Indra) partner.
	//   "PARTNER_SOVEREIGN_CONTROLS_BY_PSN" - Enum representing PSN (TIM) partner.
	//   "PARTNER_SOVEREIGN_CONTROLS_BY_CNTXT" - Enum representing CNTXT (Kingdom
	// of Saudi Arabia) partner.
	//   "PARTNER_SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM" - Enum representing CNXT
	// (Kingdom of Saudi Arabia) partner offering without EKM provisioning.
	Partner string `json:"partner,omitempty"`
	// WorkloadOnboardingState: Container for workload onboarding steps.
	WorkloadOnboardingState *WorkloadOnboardingState `json:"workloadOnboardingState,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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:"-"`
}

Workload: Contains metadata around the Workload resource (https://cloud.google.com/assured-workloads/docs/reference/rest/Shared.Types/Workload) in the Assured Workloads API.

func (Workload) MarshalJSON

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

type WorkloadOnboardingState

type WorkloadOnboardingState struct {
	// OnboardingSteps: List of workload onboarding steps.
	OnboardingSteps []*WorkloadOnboardingStep `json:"onboardingSteps,omitempty"`
	// ForceSendFields is a list of field names (e.g. "OnboardingSteps") 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. "OnboardingSteps") 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:"-"`
}

WorkloadOnboardingState: Container for workload onboarding steps.

func (WorkloadOnboardingState) MarshalJSON

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

type WorkloadOnboardingStep

type WorkloadOnboardingStep struct {
	// CompletionState: Output only. The completion state of the onboarding step.
	//
	// Possible values:
	//   "COMPLETION_STATE_UNSPECIFIED" - Unspecified completion state.
	//   "PENDING" - Task started (has start date) but not yet completed.
	//   "SUCCEEDED" - Succeeded state.
	//   "FAILED" - Failed state.
	//   "NOT_APPLICABLE" - Not applicable state.
	CompletionState string `json:"completionState,omitempty"`
	// CompletionTime: The completion time of the onboarding step.
	CompletionTime string `json:"completionTime,omitempty"`
	// StartTime: The starting time of the onboarding step.
	StartTime string `json:"startTime,omitempty"`
	// Step: The onboarding step.
	//
	// Possible values:
	//   "STEP_UNSPECIFIED" - Unspecified step.
	//   "EKM_PROVISIONED" - EKM Provisioned step.
	//   "SIGNED_ACCESS_APPROVAL_CONFIGURED" - Signed Access Approval step.
	Step string `json:"step,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CompletionState") 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. "CompletionState") 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:"-"`
}

WorkloadOnboardingStep: Container for workload onboarding information.

func (WorkloadOnboardingStep) MarshalJSON

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

Jump to

Keyboard shortcuts

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