accessapproval

package
v0.190.0 Latest Latest
Warning

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

 Go to latest Published: Aug 1, 2024 License: BSD-3-Clause Imports: 16 Imported by: 1

Documentation

Overview

Package accessapproval provides access to the Access Approval API.

For product documentation, see: https://cloud.google.com/assured-workloads/access-approval/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/accessapproval/v1"
...
ctx := context.Background()
accessapprovalService, err := accessapproval.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: 

accessapprovalService, err := accessapproval.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, ...)
accessapprovalService, err := accessapproval.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 AccessApprovalServiceAccount added in v0.71.0 

type AccessApprovalServiceAccount struct {
	// AccountEmail: Email address of the service account.
	AccountEmail string `json:"accountEmail,omitempty"`
	// Name: The resource name of the Access Approval service account. Format is
	// one of: * "projects/{project}/serviceAccount" *
	// "folders/{folder}/serviceAccount" *
	// "organizations/{organization}/serviceAccount"
	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. "AccountEmail") 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. "AccountEmail") 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:"-"`
}

AccessApprovalServiceAccount: Access Approval service account related to a project/folder/organization.

func (AccessApprovalServiceAccount) MarshalJSON added in v0.71.0 

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

type AccessApprovalSettings 

type AccessApprovalSettings struct {
	// ActiveKeyVersion: The asymmetric crypto key version to use for signing
	// approval requests. Empty active_key_version indicates that a Google-managed
	// key should be used for signing. This property will be ignored if set by an
	// ancestor of this resource, and new non-empty values may not be set.
	ActiveKeyVersion string `json:"activeKeyVersion,omitempty"`
	// AncestorHasActiveKeyVersion: Output only. This field is read only (not
	// settable via UpdateAccessApprovalSettings method). If the field is true,
	// that indicates that an ancestor of this Project or Folder has set
	// active_key_version (this field will always be unset for the organization
	// since organizations do not have ancestors).
	AncestorHasActiveKeyVersion bool `json:"ancestorHasActiveKeyVersion,omitempty"`
	// EnrolledAncestor: Output only. This field is read only (not settable via
	// UpdateAccessApprovalSettings method). If the field is true, that indicates
	// that at least one service is enrolled for Access Approval in one or more
	// ancestors of the Project or Folder (this field will always be unset for the
	// organization since organizations do not have ancestors).
	EnrolledAncestor bool `json:"enrolledAncestor,omitempty"`
	// EnrolledServices: A list of Google Cloud Services for which the given
	// resource has Access Approval enrolled. Access requests for the resource
	// given by name against any of these services contained here will be required
	// to have explicit approval. If name refers to an organization, enrollment can
	// be done for individual services. If name refers to a folder or project,
	// enrollment can only be done on an all or nothing basis. If a cloud_product
	// is repeated in this list, the first entry will be honored and all following
	// entries will be discarded. A maximum of 10 enrolled services will be
	// enforced, to be expanded as the set of supported services is expanded.
	EnrolledServices []*EnrolledService `json:"enrolledServices,omitempty"`
	// InvalidKeyVersion: Output only. This field is read only (not settable via
	// UpdateAccessApprovalSettings method). If the field is true, that indicates
	// that there is some configuration issue with the active_key_version
	// configured at this level in the resource hierarchy (e.g. it doesn't exist or
	// the Access Approval service account doesn't have the correct permissions on
	// it, etc.) This key version is not necessarily the effective key version at
	// this level, as key versions are inherited top-down.
	InvalidKeyVersion bool `json:"invalidKeyVersion,omitempty"`
	// Name: The resource name of the settings. Format is one of: *
	// "projects/{project}/accessApprovalSettings" *
	// "folders/{folder}/accessApprovalSettings" *
	// "organizations/{organization}/accessApprovalSettings"
	Name string `json:"name,omitempty"`
	// NotificationEmails: A list of email addresses to which notifications
	// relating to approval requests should be sent. Notifications relating to a
	// resource will be sent to all emails in the settings of ancestor resources of
	// that resource. A maximum of 50 email addresses are allowed.
	NotificationEmails []string `json:"notificationEmails,omitempty"`
	// NotificationPubsubTopic: Optional. A pubsub topic to which notifications
	// relating to approval requests should be sent.
	NotificationPubsubTopic string `json:"notificationPubsubTopic,omitempty"`
	// PreferNoBroadApprovalRequests: This preference is communicated to Google
	// personnel when sending an approval request but can be overridden if
	// necessary.
	PreferNoBroadApprovalRequests bool `json:"preferNoBroadApprovalRequests,omitempty"`
	// PreferredRequestExpirationDays: This preference is shared with Google
	// personnel, but can be overridden if said personnel deems necessary. The
	// approver ultimately can set the expiration at approval time.
	PreferredRequestExpirationDays int64 `json:"preferredRequestExpirationDays,omitempty"`
	// RequestScopeMaxWidthPreference: Optional. A setting to indicate the maximum
	// width of an Access Approval request.
	//
	// Possible values:
	//   "REQUEST_SCOPE_MAX_WIDTH_PREFERENCE_UNSPECIFIED" - Default value for
	// proto, shouldn't be used.
	//   "ORGANIZATION" - This is the widest scope possible. It means the customer
	// has no scope restriction when it comes to Access Approval requests.
	//   "FOLDER" - Customer allows the scope of Access Approval requests as broad
	// as the Folder level.
	//   "PROJECT" - Customer allows the scope of Access Approval requests as broad
	// as the Project level.
	RequestScopeMaxWidthPreference string `json:"requestScopeMaxWidthPreference,omitempty"`
	// RequireCustomerVisibleJustification: Optional. A setting to require approval
	// request justifications to be customer visible.
	RequireCustomerVisibleJustification bool `json:"requireCustomerVisibleJustification,omitempty"`

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

AccessApprovalSettings: Settings on a Project/Folder/Organization related to Access Approval.

func (AccessApprovalSettings) MarshalJSON 

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

type AccessLocations 

type AccessLocations struct {
	// PrincipalOfficeCountry: The "home office" location of the principal. A
	// two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or
	// a region code. In some limited situations Google systems may refer refer to
	// a region code instead of a country code. Possible Region Codes: * ASI: Asia
	// * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South
	// America * ANT: Antarctica * ANY: Any location
	PrincipalOfficeCountry string `json:"principalOfficeCountry,omitempty"`
	// PrincipalPhysicalLocationCountry: Physical location of the principal at the
	// time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as
	// "US", "DE" or "GB" or a region code. In some limited situations Google
	// systems may refer refer to a region code instead of a country code. Possible
	// Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM:
	// North America * SAM: South America * ANT: Antarctica * ANY: Any location
	PrincipalPhysicalLocationCountry string `json:"principalPhysicalLocationCountry,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PrincipalOfficeCountry") 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. "PrincipalOfficeCountry") 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:"-"`
}

AccessLocations: Home office and physical location of the principal.

func (AccessLocations) MarshalJSON 

func (s AccessLocations) 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:"-"`
}

func (AccessReason) MarshalJSON 

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

type ApprovalRequest 

type ApprovalRequest struct {
	// Approve: Access was approved.
	Approve *ApproveDecision `json:"approve,omitempty"`
	// Dismiss: The request was dismissed.
	Dismiss *DismissDecision `json:"dismiss,omitempty"`
	// Name: The resource name of the request. Format is
	// "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
	Name string `json:"name,omitempty"`
	// RequestTime: The time at which approval was requested.
	RequestTime string `json:"requestTime,omitempty"`
	// RequestedDuration: The requested access duration.
	RequestedDuration string `json:"requestedDuration,omitempty"`
	// RequestedExpiration: The original requested expiration for the approval.
	// Calculated by adding the requested_duration to the request_time.
	RequestedExpiration string `json:"requestedExpiration,omitempty"`
	// RequestedLocations: The locations for which approval is being requested.
	RequestedLocations *AccessLocations `json:"requestedLocations,omitempty"`
	// RequestedReason: The justification for which approval is being requested.
	RequestedReason *AccessReason `json:"requestedReason,omitempty"`
	// RequestedResourceName: The resource for which approval is being requested.
	// The format of the resource name is defined at
	// https://cloud.google.com/apis/design/resource_names. The resource name here
	// may either be a "full" resource name (e.g.
	// "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative"
	// resource name (e.g. "shelves/shelf1/books/book2") as described in the
	// resource name specification.
	RequestedResourceName string `json:"requestedResourceName,omitempty"`
	// RequestedResourceProperties: Properties related to the resource represented
	// by requested_resource_name.
	RequestedResourceProperties *ResourceProperties `json:"requestedResourceProperties,omitempty"`

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

ApprovalRequest: A request for the customer to approve access to a resource.

func (ApprovalRequest) MarshalJSON 

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

type ApproveApprovalRequestMessage 

type ApproveApprovalRequestMessage struct {
	// ExpireTime: The expiration time of this approval.
	ExpireTime string `json:"expireTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExpireTime") 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. "ExpireTime") 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:"-"`
}

ApproveApprovalRequestMessage: Request to approve an ApprovalRequest.

func (ApproveApprovalRequestMessage) MarshalJSON 

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

type ApproveDecision 

type ApproveDecision struct {
	// ApproveTime: The time at which approval was granted.
	ApproveTime string `json:"approveTime,omitempty"`
	// AutoApproved: True when the request has been auto-approved.
	AutoApproved bool `json:"autoApproved,omitempty"`
	// ExpireTime: The time at which the approval expires.
	ExpireTime string `json:"expireTime,omitempty"`
	// InvalidateTime: If set, denotes the timestamp at which the approval is
	// invalidated.
	InvalidateTime string `json:"invalidateTime,omitempty"`
	// SignatureInfo: The signature for the ApprovalRequest and details on how it
	// was signed.
	SignatureInfo *SignatureInfo `json:"signatureInfo,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApproveTime") 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. "ApproveTime") 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:"-"`
}

ApproveDecision: A decision that has been made to approve access to a resource.

func (ApproveDecision) MarshalJSON 

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

type DismissApprovalRequestMessage 

type DismissApprovalRequestMessage struct {
}

DismissApprovalRequestMessage: Request to dismiss an approval request.

type DismissDecision 

type DismissDecision struct {
	// DismissTime: The time at which the approval request was dismissed.
	DismissTime string `json:"dismissTime,omitempty"`
	// Implicit: This field will be true if the ApprovalRequest was implicitly
	// dismissed due to inaction by the access approval approvers (the request is
	// not acted on by the approvers before the exiration time).
	Implicit bool `json:"implicit,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DismissTime") 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. "DismissTime") 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:"-"`
}

DismissDecision: A decision that has been made to dismiss an approval request.

func (DismissDecision) MarshalJSON 

func (s DismissDecision) 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 EnrolledService 

type EnrolledService struct {
	// CloudProduct: The product for which Access Approval will be enrolled.
	// Allowed values are listed below (case-sensitive): * all * GA * App Engine *
	// Artifact Registry * BigQuery * Certificate Authority Service * Cloud
	// Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer *
	// Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore *
	// Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT
	// * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc *
	// Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk *
	// Resource Manager * Secret Manager * Speaker ID Note: These values are
	// supported as input for legacy purposes, but will not be returned from the
	// API. * all * ga-only * appengine.googleapis.com *
	// artifactregistry.googleapis.com * bigquery.googleapis.com *
	// bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com
	// * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com *
	// compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com *
	// dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com *
	// orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com *
	// secretmanager.googleapis.com * speakerid.googleapis.com *
	// storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or
	// any of the XXX.googleapis.com will be translated to the associated product
	// name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in
	// all products supported at both 'GA' and 'Preview' levels. More information
	// about levels of support is available at
	// https://cloud.google.com/access-approval/docs/supported-services
	CloudProduct string `json:"cloudProduct,omitempty"`
	// EnrollmentLevel: The enrollment level of the service.
	//
	// Possible values:
	//   "ENROLLMENT_LEVEL_UNSPECIFIED" - Default value for proto, shouldn't be
	// used.
	//   "BLOCK_ALL" - Service is enrolled in Access Approval for all requests
	EnrollmentLevel string `json:"enrollmentLevel,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CloudProduct") 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. "CloudProduct") 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:"-"`
}

EnrolledService: Represents the enrollment of a cloud resource into a specific service.

func (EnrolledService) MarshalJSON 

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

type FoldersApprovalRequestsApproveCall 

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

func (*FoldersApprovalRequestsApproveCall) Context 

func (c *FoldersApprovalRequestsApproveCall) Context(ctx context.Context) *FoldersApprovalRequestsApproveCall

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

func (*FoldersApprovalRequestsApproveCall) Do 

func (c *FoldersApprovalRequestsApproveCall) Do(opts ...googleapi.CallOption) (*ApprovalRequest, error)

Do executes the "accessapproval.folders.approvalRequests.approve" call. Any non-2xx status code is an error. Response headers are in either *ApprovalRequest.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 (*FoldersApprovalRequestsApproveCall) Fields 

func (c *FoldersApprovalRequestsApproveCall) Fields(s ...googleapi.Field) *FoldersApprovalRequestsApproveCall

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

func (*FoldersApprovalRequestsApproveCall) Header 

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

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

type FoldersApprovalRequestsDismissCall 

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

func (*FoldersApprovalRequestsDismissCall) Context 

func (c *FoldersApprovalRequestsDismissCall) Context(ctx context.Context) *FoldersApprovalRequestsDismissCall

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

func (*FoldersApprovalRequestsDismissCall) Do 

func (c *FoldersApprovalRequestsDismissCall) Do(opts ...googleapi.CallOption) (*ApprovalRequest, error)

Do executes the "accessapproval.folders.approvalRequests.dismiss" call. Any non-2xx status code is an error. Response headers are in either *ApprovalRequest.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 (*FoldersApprovalRequestsDismissCall) Fields 

func (c *FoldersApprovalRequestsDismissCall) Fields(s ...googleapi.Field) *FoldersApprovalRequestsDismissCall

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

func (*FoldersApprovalRequestsDismissCall) Header 

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

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

type FoldersApprovalRequestsGetCall 

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

func (*FoldersApprovalRequestsGetCall) Context 

func (c *FoldersApprovalRequestsGetCall) Context(ctx context.Context) *FoldersApprovalRequestsGetCall

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

func (*FoldersApprovalRequestsGetCall) Do 

func (c *FoldersApprovalRequestsGetCall) Do(opts ...googleapi.CallOption) (*ApprovalRequest, error)

Do executes the "accessapproval.folders.approvalRequests.get" call. Any non-2xx status code is an error. Response headers are in either *ApprovalRequest.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 (*FoldersApprovalRequestsGetCall) Fields 

func (c *FoldersApprovalRequestsGetCall) Fields(s ...googleapi.Field) *FoldersApprovalRequestsGetCall

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

func (*FoldersApprovalRequestsGetCall) Header 

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

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

func (*FoldersApprovalRequestsGetCall) IfNoneMatch 

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

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 FoldersApprovalRequestsInvalidateCall added in v0.81.0 

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

func (*FoldersApprovalRequestsInvalidateCall) Context added in v0.81.0 

func (c *FoldersApprovalRequestsInvalidateCall) Context(ctx context.Context) *FoldersApprovalRequestsInvalidateCall

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

func (*FoldersApprovalRequestsInvalidateCall) Do added in v0.81.0 

func (c *FoldersApprovalRequestsInvalidateCall) Do(opts ...googleapi.CallOption) (*ApprovalRequest, error)

Do executes the "accessapproval.folders.approvalRequests.invalidate" call. Any non-2xx status code is an error. Response headers are in either *ApprovalRequest.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 (*FoldersApprovalRequestsInvalidateCall) Fields added in v0.81.0 

func (c *FoldersApprovalRequestsInvalidateCall) Fields(s ...googleapi.Field) *FoldersApprovalRequestsInvalidateCall

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

func (*FoldersApprovalRequestsInvalidateCall) Header added in v0.81.0 

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

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

type FoldersApprovalRequestsListCall 

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

func (*FoldersApprovalRequestsListCall) Context 

func (c *FoldersApprovalRequestsListCall) Context(ctx context.Context) *FoldersApprovalRequestsListCall

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

func (*FoldersApprovalRequestsListCall) Do 

func (c *FoldersApprovalRequestsListCall) Do(opts ...googleapi.CallOption) (*ListApprovalRequestsResponse, error)

Do executes the "accessapproval.folders.approvalRequests.list" call. Any non-2xx status code is an error. Response headers are in either *ListApprovalRequestsResponse.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 (*FoldersApprovalRequestsListCall) Fields 

func (c *FoldersApprovalRequestsListCall) Fields(s ...googleapi.Field) *FoldersApprovalRequestsListCall

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

func (*FoldersApprovalRequestsListCall) Filter 

func (c *FoldersApprovalRequestsListCall) Filter(filter string) *FoldersApprovalRequestsListCall

Filter sets the optional parameter "filter": A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.

func (*FoldersApprovalRequestsListCall) Header 

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

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

func (*FoldersApprovalRequestsListCall) IfNoneMatch 

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

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 (*FoldersApprovalRequestsListCall) PageSize 

func (c *FoldersApprovalRequestsListCall) PageSize(pageSize int64) *FoldersApprovalRequestsListCall

PageSize sets the optional parameter "pageSize": Requested page size.

func (*FoldersApprovalRequestsListCall) PageToken 

func (c *FoldersApprovalRequestsListCall) PageToken(pageToken string) *FoldersApprovalRequestsListCall

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

func (*FoldersApprovalRequestsListCall) Pages 

func (c *FoldersApprovalRequestsListCall) Pages(ctx context.Context, f func(*ListApprovalRequestsResponse) error) error

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 FoldersApprovalRequestsService 

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

func NewFoldersApprovalRequestsService 

func NewFoldersApprovalRequestsService(s *Service) *FoldersApprovalRequestsService

func (*FoldersApprovalRequestsService) Approve 

func (r *FoldersApprovalRequestsService) Approve(name string, approveapprovalrequestmessage *ApproveApprovalRequestMessage) *FoldersApprovalRequestsApproveCall

Approve: Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

- name: Name of the approval request to approve.

func (*FoldersApprovalRequestsService) Dismiss 

func (r *FoldersApprovalRequestsService) Dismiss(name string, dismissapprovalrequestmessage *DismissApprovalRequestMessage) *FoldersApprovalRequestsDismissCall

Dismiss: Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

- name: Name of the ApprovalRequest to dismiss.

func (*FoldersApprovalRequestsService) Get 

func (r *FoldersApprovalRequestsService) Get(name string) *FoldersApprovalRequestsGetCall

Get: Gets an approval request. Returns NOT_FOUND if the request does not exist.

  • name: The name of the approval request to retrieve. Format: "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".

func (*FoldersApprovalRequestsService) Invalidate added in v0.81.0 

func (r *FoldersApprovalRequestsService) Invalidate(name string, invalidateapprovalrequestmessage *InvalidateApprovalRequestMessage) *FoldersApprovalRequestsInvalidateCall

Invalidate: Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.

- name: Name of the ApprovalRequest to invalidate.

func (*FoldersApprovalRequestsService) List 

func (r *FoldersApprovalRequestsService) List(parent string) *FoldersApprovalRequestsListCall

List: Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

  • parent: The parent resource. This may be "projects/{project}", "folders/{folder}", or "organizations/{organization}".

type FoldersDeleteAccessApprovalSettingsCall 

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

func (*FoldersDeleteAccessApprovalSettingsCall) Context 

func (c *FoldersDeleteAccessApprovalSettingsCall) Context(ctx context.Context) *FoldersDeleteAccessApprovalSettingsCall

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

func (*FoldersDeleteAccessApprovalSettingsCall) Do 

func (c *FoldersDeleteAccessApprovalSettingsCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "accessapproval.folders.deleteAccessApprovalSettings" 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 (*FoldersDeleteAccessApprovalSettingsCall) Fields 

func (c *FoldersDeleteAccessApprovalSettingsCall) Fields(s ...googleapi.Field) *FoldersDeleteAccessApprovalSettingsCall

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

func (*FoldersDeleteAccessApprovalSettingsCall) Header 

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

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

type FoldersGetAccessApprovalSettingsCall 

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

func (*FoldersGetAccessApprovalSettingsCall) Context 

func (c *FoldersGetAccessApprovalSettingsCall) Context(ctx context.Context) *FoldersGetAccessApprovalSettingsCall

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

func (*FoldersGetAccessApprovalSettingsCall) Do 

func (c *FoldersGetAccessApprovalSettingsCall) Do(opts ...googleapi.CallOption) (*AccessApprovalSettings, error)

Do executes the "accessapproval.folders.getAccessApprovalSettings" call. Any non-2xx status code is an error. Response headers are in either *AccessApprovalSettings.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 (*FoldersGetAccessApprovalSettingsCall) Fields 

func (c *FoldersGetAccessApprovalSettingsCall) Fields(s ...googleapi.Field) *FoldersGetAccessApprovalSettingsCall

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

func (*FoldersGetAccessApprovalSettingsCall) Header 

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

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

func (*FoldersGetAccessApprovalSettingsCall) IfNoneMatch 

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

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 FoldersGetServiceAccountCall added in v0.71.0 

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

func (*FoldersGetServiceAccountCall) Context added in v0.71.0 

func (c *FoldersGetServiceAccountCall) Context(ctx context.Context) *FoldersGetServiceAccountCall

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

func (*FoldersGetServiceAccountCall) Do added in v0.71.0 

func (c *FoldersGetServiceAccountCall) Do(opts ...googleapi.CallOption) (*AccessApprovalServiceAccount, error)

Do executes the "accessapproval.folders.getServiceAccount" call. Any non-2xx status code is an error. Response headers are in either *AccessApprovalServiceAccount.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 (*FoldersGetServiceAccountCall) Fields added in v0.71.0 

func (c *FoldersGetServiceAccountCall) Fields(s ...googleapi.Field) *FoldersGetServiceAccountCall

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

func (*FoldersGetServiceAccountCall) Header added in v0.71.0 

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

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

func (*FoldersGetServiceAccountCall) IfNoneMatch added in v0.71.0 

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

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 FoldersService 

type FoldersService struct {
	ApprovalRequests *FoldersApprovalRequestsService
	// contains filtered or unexported fields
}

func NewFoldersService 

func NewFoldersService(s *Service) *FoldersService

func (*FoldersService) DeleteAccessApprovalSettings 

func (r *FoldersService) DeleteAccessApprovalSettings(name string) *FoldersDeleteAccessApprovalSettingsCall

DeleteAccessApprovalSettings: Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

- name: Name of the AccessApprovalSettings to delete.

func (*FoldersService) GetAccessApprovalSettings 

func (r *FoldersService) GetAccessApprovalSettings(name string) *FoldersGetAccessApprovalSettingsCall

GetAccessApprovalSettings: Gets the settings associated with a project, folder, or organization.

  • name: The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations}/{id}/accessApprovalSettings".

func (*FoldersService) GetServiceAccount added in v0.71.0 

func (r *FoldersService) GetServiceAccount(name string) *FoldersGetServiceAccountCall

GetServiceAccount: Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.

- name: Name of the AccessApprovalServiceAccount to retrieve.

func (*FoldersService) UpdateAccessApprovalSettings 

func (r *FoldersService) UpdateAccessApprovalSettings(name string, accessapprovalsettings *AccessApprovalSettings) *FoldersUpdateAccessApprovalSettingsCall

UpdateAccessApprovalSettings: Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

  • name: The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings".

type FoldersUpdateAccessApprovalSettingsCall 

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

func (*FoldersUpdateAccessApprovalSettingsCall) Context 

func (c *FoldersUpdateAccessApprovalSettingsCall) Context(ctx context.Context) *FoldersUpdateAccessApprovalSettingsCall

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

func (*FoldersUpdateAccessApprovalSettingsCall) Do 

func (c *FoldersUpdateAccessApprovalSettingsCall) Do(opts ...googleapi.CallOption) (*AccessApprovalSettings, error)

Do executes the "accessapproval.folders.updateAccessApprovalSettings" call. Any non-2xx status code is an error. Response headers are in either *AccessApprovalSettings.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 (*FoldersUpdateAccessApprovalSettingsCall) Fields 

func (c *FoldersUpdateAccessApprovalSettingsCall) Fields(s ...googleapi.Field) *FoldersUpdateAccessApprovalSettingsCall

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

func (*FoldersUpdateAccessApprovalSettingsCall) Header 

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

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

func (*FoldersUpdateAccessApprovalSettingsCall) UpdateMask 

func (c *FoldersUpdateAccessApprovalSettingsCall) UpdateMask(updateMask string) *FoldersUpdateAccessApprovalSettingsCall

UpdateMask sets the optional parameter "updateMask": The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.

type InvalidateApprovalRequestMessage added in v0.81.0 

type InvalidateApprovalRequestMessage struct {
}

InvalidateApprovalRequestMessage: Request to invalidate an existing approval.

type ListApprovalRequestsResponse 

type ListApprovalRequestsResponse struct {
	// ApprovalRequests: Approval request details.
	ApprovalRequests []*ApprovalRequest `json:"approvalRequests,omitempty"`
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more.
	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. "ApprovalRequests") 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. "ApprovalRequests") 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:"-"`
}

ListApprovalRequestsResponse: Response to listing of ApprovalRequest objects.

func (ListApprovalRequestsResponse) MarshalJSON 

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

type OrganizationsApprovalRequestsApproveCall 

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

func (*OrganizationsApprovalRequestsApproveCall) Context 

func (c *OrganizationsApprovalRequestsApproveCall) Context(ctx context.Context) *OrganizationsApprovalRequestsApproveCall

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

func (*OrganizationsApprovalRequestsApproveCall) Do 

func (c *OrganizationsApprovalRequestsApproveCall) Do(opts ...googleapi.CallOption) (*ApprovalRequest, error)

Do executes the "accessapproval.organizations.approvalRequests.approve" call. Any non-2xx status code is an error. Response headers are in either *ApprovalRequest.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 (*OrganizationsApprovalRequestsApproveCall) Fields 

func (c *OrganizationsApprovalRequestsApproveCall) Fields(s ...googleapi.Field) *OrganizationsApprovalRequestsApproveCall

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

func (*OrganizationsApprovalRequestsApproveCall) Header 

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

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

type OrganizationsApprovalRequestsDismissCall 

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

func (*OrganizationsApprovalRequestsDismissCall) Context 

func (c *OrganizationsApprovalRequestsDismissCall) Context(ctx context.Context) *OrganizationsApprovalRequestsDismissCall

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

func (*OrganizationsApprovalRequestsDismissCall) Do 

func (c *OrganizationsApprovalRequestsDismissCall) Do(opts ...googleapi.CallOption) (*ApprovalRequest, error)

Do executes the "accessapproval.organizations.approvalRequests.dismiss" call. Any non-2xx status code is an error. Response headers are in either *ApprovalRequest.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 (*OrganizationsApprovalRequestsDismissCall) Fields 

func (c *OrganizationsApprovalRequestsDismissCall) Fields(s ...googleapi.Field) *OrganizationsApprovalRequestsDismissCall

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

func (*OrganizationsApprovalRequestsDismissCall) Header 

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

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

type OrganizationsApprovalRequestsGetCall 

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

func (*OrganizationsApprovalRequestsGetCall) Context 

func (c *OrganizationsApprovalRequestsGetCall) Context(ctx context.Context) *OrganizationsApprovalRequestsGetCall

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

func (*OrganizationsApprovalRequestsGetCall) Do 

func (c *OrganizationsApprovalRequestsGetCall) Do(opts ...googleapi.CallOption) (*ApprovalRequest, error)

Do executes the "accessapproval.organizations.approvalRequests.get" call. Any non-2xx status code is an error. Response headers are in either *ApprovalRequest.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 (*OrganizationsApprovalRequestsGetCall) Fields 

func (c *OrganizationsApprovalRequestsGetCall) Fields(s ...googleapi.Field) *OrganizationsApprovalRequestsGetCall

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

func (*OrganizationsApprovalRequestsGetCall) Header 

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

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

func (*OrganizationsApprovalRequestsGetCall) IfNoneMatch 

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

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 OrganizationsApprovalRequestsInvalidateCall added in v0.81.0 

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

func (*OrganizationsApprovalRequestsInvalidateCall) Context added in v0.81.0 

func (c *OrganizationsApprovalRequestsInvalidateCall) Context(ctx context.Context) *OrganizationsApprovalRequestsInvalidateCall

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

func (*OrganizationsApprovalRequestsInvalidateCall) Do added in v0.81.0 

func (c *OrganizationsApprovalRequestsInvalidateCall) Do(opts ...googleapi.CallOption) (*ApprovalRequest, error)

Do executes the "accessapproval.organizations.approvalRequests.invalidate" call. Any non-2xx status code is an error. Response headers are in either *ApprovalRequest.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 (*OrganizationsApprovalRequestsInvalidateCall) Fields added in v0.81.0 

func (c *OrganizationsApprovalRequestsInvalidateCall) Fields(s ...googleapi.Field) *OrganizationsApprovalRequestsInvalidateCall

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

func (*OrganizationsApprovalRequestsInvalidateCall) Header added in v0.81.0 

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

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

type OrganizationsApprovalRequestsListCall 

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

func (*OrganizationsApprovalRequestsListCall) Context 

func (c *OrganizationsApprovalRequestsListCall) Context(ctx context.Context) *OrganizationsApprovalRequestsListCall

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

func (*OrganizationsApprovalRequestsListCall) Do 

func (c *OrganizationsApprovalRequestsListCall) Do(opts ...googleapi.CallOption) (*ListApprovalRequestsResponse, error)

Do executes the "accessapproval.organizations.approvalRequests.list" call. Any non-2xx status code is an error. Response headers are in either *ListApprovalRequestsResponse.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 (*OrganizationsApprovalRequestsListCall) Fields 

func (c *OrganizationsApprovalRequestsListCall) Fields(s ...googleapi.Field) *OrganizationsApprovalRequestsListCall

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

func (*OrganizationsApprovalRequestsListCall) Filter 

func (c *OrganizationsApprovalRequestsListCall) Filter(filter string) *OrganizationsApprovalRequestsListCall

Filter sets the optional parameter "filter": A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.

func (*OrganizationsApprovalRequestsListCall) Header 

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

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

func (*OrganizationsApprovalRequestsListCall) IfNoneMatch 

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

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 (*OrganizationsApprovalRequestsListCall) PageSize 

func (c *OrganizationsApprovalRequestsListCall) PageSize(pageSize int64) *OrganizationsApprovalRequestsListCall

PageSize sets the optional parameter "pageSize": Requested page size.

func (*OrganizationsApprovalRequestsListCall) PageToken 

func (c *OrganizationsApprovalRequestsListCall) PageToken(pageToken string) *OrganizationsApprovalRequestsListCall

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

func (*OrganizationsApprovalRequestsListCall) Pages 

func (c *OrganizationsApprovalRequestsListCall) Pages(ctx context.Context, f func(*ListApprovalRequestsResponse) error) error

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 OrganizationsApprovalRequestsService 

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

func NewOrganizationsApprovalRequestsService 

func NewOrganizationsApprovalRequestsService(s *Service) *OrganizationsApprovalRequestsService

func (*OrganizationsApprovalRequestsService) Approve 

func (r *OrganizationsApprovalRequestsService) Approve(name string, approveapprovalrequestmessage *ApproveApprovalRequestMessage) *OrganizationsApprovalRequestsApproveCall

Approve: Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

- name: Name of the approval request to approve.

func (*OrganizationsApprovalRequestsService) Dismiss 

func (r *OrganizationsApprovalRequestsService) Dismiss(name string, dismissapprovalrequestmessage *DismissApprovalRequestMessage) *OrganizationsApprovalRequestsDismissCall

Dismiss: Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

- name: Name of the ApprovalRequest to dismiss.

func (*OrganizationsApprovalRequestsService) Get 

func (r *OrganizationsApprovalRequestsService) Get(name string) *OrganizationsApprovalRequestsGetCall

Get: Gets an approval request. Returns NOT_FOUND if the request does not exist.

  • name: The name of the approval request to retrieve. Format: "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".

func (*OrganizationsApprovalRequestsService) Invalidate added in v0.81.0 

func (r *OrganizationsApprovalRequestsService) Invalidate(name string, invalidateapprovalrequestmessage *InvalidateApprovalRequestMessage) *OrganizationsApprovalRequestsInvalidateCall

Invalidate: Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.

- name: Name of the ApprovalRequest to invalidate.

func (*OrganizationsApprovalRequestsService) List 

func (r *OrganizationsApprovalRequestsService) List(parent string) *OrganizationsApprovalRequestsListCall

List: Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

  • parent: The parent resource. This may be "projects/{project}", "folders/{folder}", or "organizations/{organization}".

type OrganizationsDeleteAccessApprovalSettingsCall 

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

func (*OrganizationsDeleteAccessApprovalSettingsCall) Context 

func (c *OrganizationsDeleteAccessApprovalSettingsCall) Context(ctx context.Context) *OrganizationsDeleteAccessApprovalSettingsCall

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

func (*OrganizationsDeleteAccessApprovalSettingsCall) Do 

func (c *OrganizationsDeleteAccessApprovalSettingsCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "accessapproval.organizations.deleteAccessApprovalSettings" 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 (*OrganizationsDeleteAccessApprovalSettingsCall) Fields 

func (c *OrganizationsDeleteAccessApprovalSettingsCall) Fields(s ...googleapi.Field) *OrganizationsDeleteAccessApprovalSettingsCall

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

func (*OrganizationsDeleteAccessApprovalSettingsCall) Header 

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

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

type OrganizationsGetAccessApprovalSettingsCall 

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

func (*OrganizationsGetAccessApprovalSettingsCall) Context 

func (c *OrganizationsGetAccessApprovalSettingsCall) Context(ctx context.Context) *OrganizationsGetAccessApprovalSettingsCall

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

func (*OrganizationsGetAccessApprovalSettingsCall) Do 

func (c *OrganizationsGetAccessApprovalSettingsCall) Do(opts ...googleapi.CallOption) (*AccessApprovalSettings, error)

Do executes the "accessapproval.organizations.getAccessApprovalSettings" call. Any non-2xx status code is an error. Response headers are in either *AccessApprovalSettings.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 (*OrganizationsGetAccessApprovalSettingsCall) Fields 

func (c *OrganizationsGetAccessApprovalSettingsCall) Fields(s ...googleapi.Field) *OrganizationsGetAccessApprovalSettingsCall

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

func (*OrganizationsGetAccessApprovalSettingsCall) Header 

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

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

func (*OrganizationsGetAccessApprovalSettingsCall) IfNoneMatch 

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

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 OrganizationsGetServiceAccountCall added in v0.71.0 

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

func (*OrganizationsGetServiceAccountCall) Context added in v0.71.0 

func (c *OrganizationsGetServiceAccountCall) Context(ctx context.Context) *OrganizationsGetServiceAccountCall

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

func (*OrganizationsGetServiceAccountCall) Do added in v0.71.0 

func (c *OrganizationsGetServiceAccountCall) Do(opts ...googleapi.CallOption) (*AccessApprovalServiceAccount, error)

Do executes the "accessapproval.organizations.getServiceAccount" call. Any non-2xx status code is an error. Response headers are in either *AccessApprovalServiceAccount.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 (*OrganizationsGetServiceAccountCall) Fields added in v0.71.0 

func (c *OrganizationsGetServiceAccountCall) Fields(s ...googleapi.Field) *OrganizationsGetServiceAccountCall

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

func (*OrganizationsGetServiceAccountCall) Header added in v0.71.0 

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

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

func (*OrganizationsGetServiceAccountCall) IfNoneMatch added in v0.71.0 

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

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 OrganizationsService 

type OrganizationsService struct {
	ApprovalRequests *OrganizationsApprovalRequestsService
	// contains filtered or unexported fields
}

func NewOrganizationsService 

func NewOrganizationsService(s *Service) *OrganizationsService

func (*OrganizationsService) DeleteAccessApprovalSettings 

func (r *OrganizationsService) DeleteAccessApprovalSettings(name string) *OrganizationsDeleteAccessApprovalSettingsCall

DeleteAccessApprovalSettings: Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

- name: Name of the AccessApprovalSettings to delete.

func (*OrganizationsService) GetAccessApprovalSettings 

func (r *OrganizationsService) GetAccessApprovalSettings(name string) *OrganizationsGetAccessApprovalSettingsCall

GetAccessApprovalSettings: Gets the settings associated with a project, folder, or organization.

  • name: The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations}/{id}/accessApprovalSettings".

func (*OrganizationsService) GetServiceAccount added in v0.71.0 

func (r *OrganizationsService) GetServiceAccount(name string) *OrganizationsGetServiceAccountCall

GetServiceAccount: Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.

- name: Name of the AccessApprovalServiceAccount to retrieve.

func (*OrganizationsService) UpdateAccessApprovalSettings 

func (r *OrganizationsService) UpdateAccessApprovalSettings(name string, accessapprovalsettings *AccessApprovalSettings) *OrganizationsUpdateAccessApprovalSettingsCall

UpdateAccessApprovalSettings: Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

  • name: The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings".

type OrganizationsUpdateAccessApprovalSettingsCall 

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

func (*OrganizationsUpdateAccessApprovalSettingsCall) Context 

func (c *OrganizationsUpdateAccessApprovalSettingsCall) Context(ctx context.Context) *OrganizationsUpdateAccessApprovalSettingsCall

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

func (*OrganizationsUpdateAccessApprovalSettingsCall) Do 

func (c *OrganizationsUpdateAccessApprovalSettingsCall) Do(opts ...googleapi.CallOption) (*AccessApprovalSettings, error)

Do executes the "accessapproval.organizations.updateAccessApprovalSettings" call. Any non-2xx status code is an error. Response headers are in either *AccessApprovalSettings.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 (*OrganizationsUpdateAccessApprovalSettingsCall) Fields 

func (c *OrganizationsUpdateAccessApprovalSettingsCall) Fields(s ...googleapi.Field) *OrganizationsUpdateAccessApprovalSettingsCall

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

func (*OrganizationsUpdateAccessApprovalSettingsCall) Header 

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

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

func (*OrganizationsUpdateAccessApprovalSettingsCall) UpdateMask 

func (c *OrganizationsUpdateAccessApprovalSettingsCall) UpdateMask(updateMask string) *OrganizationsUpdateAccessApprovalSettingsCall

UpdateMask sets the optional parameter "updateMask": The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.

type ProjectsApprovalRequestsApproveCall 

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

func (*ProjectsApprovalRequestsApproveCall) Context 

func (c *ProjectsApprovalRequestsApproveCall) Context(ctx context.Context) *ProjectsApprovalRequestsApproveCall

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

func (*ProjectsApprovalRequestsApproveCall) Do 

func (c *ProjectsApprovalRequestsApproveCall) Do(opts ...googleapi.CallOption) (*ApprovalRequest, error)

Do executes the "accessapproval.projects.approvalRequests.approve" call. Any non-2xx status code is an error. Response headers are in either *ApprovalRequest.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 (*ProjectsApprovalRequestsApproveCall) Fields 

func (c *ProjectsApprovalRequestsApproveCall) Fields(s ...googleapi.Field) *ProjectsApprovalRequestsApproveCall

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

func (*ProjectsApprovalRequestsApproveCall) Header 

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

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

type ProjectsApprovalRequestsDismissCall 

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

func (*ProjectsApprovalRequestsDismissCall) Context 

func (c *ProjectsApprovalRequestsDismissCall) Context(ctx context.Context) *ProjectsApprovalRequestsDismissCall

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

func (*ProjectsApprovalRequestsDismissCall) Do 

func (c *ProjectsApprovalRequestsDismissCall) Do(opts ...googleapi.CallOption) (*ApprovalRequest, error)

Do executes the "accessapproval.projects.approvalRequests.dismiss" call. Any non-2xx status code is an error. Response headers are in either *ApprovalRequest.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 (*ProjectsApprovalRequestsDismissCall) Fields 

func (c *ProjectsApprovalRequestsDismissCall) Fields(s ...googleapi.Field) *ProjectsApprovalRequestsDismissCall

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

func (*ProjectsApprovalRequestsDismissCall) Header 

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

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

type ProjectsApprovalRequestsGetCall 

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

func (*ProjectsApprovalRequestsGetCall) Context 

func (c *ProjectsApprovalRequestsGetCall) Context(ctx context.Context) *ProjectsApprovalRequestsGetCall

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

func (*ProjectsApprovalRequestsGetCall) Do 

func (c *ProjectsApprovalRequestsGetCall) Do(opts ...googleapi.CallOption) (*ApprovalRequest, error)

Do executes the "accessapproval.projects.approvalRequests.get" call. Any non-2xx status code is an error. Response headers are in either *ApprovalRequest.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 (*ProjectsApprovalRequestsGetCall) Fields 

func (c *ProjectsApprovalRequestsGetCall) Fields(s ...googleapi.Field) *ProjectsApprovalRequestsGetCall

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

func (*ProjectsApprovalRequestsGetCall) Header 

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

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

func (*ProjectsApprovalRequestsGetCall) IfNoneMatch 

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

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 ProjectsApprovalRequestsInvalidateCall added in v0.81.0 

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

func (*ProjectsApprovalRequestsInvalidateCall) Context added in v0.81.0 

func (c *ProjectsApprovalRequestsInvalidateCall) Context(ctx context.Context) *ProjectsApprovalRequestsInvalidateCall

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

func (*ProjectsApprovalRequestsInvalidateCall) Do added in v0.81.0 

func (c *ProjectsApprovalRequestsInvalidateCall) Do(opts ...googleapi.CallOption) (*ApprovalRequest, error)

Do executes the "accessapproval.projects.approvalRequests.invalidate" call. Any non-2xx status code is an error. Response headers are in either *ApprovalRequest.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 (*ProjectsApprovalRequestsInvalidateCall) Fields added in v0.81.0 

func (c *ProjectsApprovalRequestsInvalidateCall) Fields(s ...googleapi.Field) *ProjectsApprovalRequestsInvalidateCall

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

func (*ProjectsApprovalRequestsInvalidateCall) Header added in v0.81.0 

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

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

type ProjectsApprovalRequestsListCall 

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

func (*ProjectsApprovalRequestsListCall) Context 

func (c *ProjectsApprovalRequestsListCall) Context(ctx context.Context) *ProjectsApprovalRequestsListCall

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

func (*ProjectsApprovalRequestsListCall) Do 

func (c *ProjectsApprovalRequestsListCall) Do(opts ...googleapi.CallOption) (*ListApprovalRequestsResponse, error)

Do executes the "accessapproval.projects.approvalRequests.list" call. Any non-2xx status code is an error. Response headers are in either *ListApprovalRequestsResponse.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 (*ProjectsApprovalRequestsListCall) Fields 

func (c *ProjectsApprovalRequestsListCall) Fields(s ...googleapi.Field) *ProjectsApprovalRequestsListCall

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

func (*ProjectsApprovalRequestsListCall) Filter 

func (c *ProjectsApprovalRequestsListCall) Filter(filter string) *ProjectsApprovalRequestsListCall

Filter sets the optional parameter "filter": A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.

func (*ProjectsApprovalRequestsListCall) Header 

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

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

func (*ProjectsApprovalRequestsListCall) IfNoneMatch 

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

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 (*ProjectsApprovalRequestsListCall) PageSize 

func (c *ProjectsApprovalRequestsListCall) PageSize(pageSize int64) *ProjectsApprovalRequestsListCall

PageSize sets the optional parameter "pageSize": Requested page size.

func (*ProjectsApprovalRequestsListCall) PageToken 

func (c *ProjectsApprovalRequestsListCall) PageToken(pageToken string) *ProjectsApprovalRequestsListCall

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

func (*ProjectsApprovalRequestsListCall) Pages 

func (c *ProjectsApprovalRequestsListCall) Pages(ctx context.Context, f func(*ListApprovalRequestsResponse) error) error

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 ProjectsApprovalRequestsService 

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

func NewProjectsApprovalRequestsService 

func NewProjectsApprovalRequestsService(s *Service) *ProjectsApprovalRequestsService

func (*ProjectsApprovalRequestsService) Approve 

func (r *ProjectsApprovalRequestsService) Approve(name string, approveapprovalrequestmessage *ApproveApprovalRequestMessage) *ProjectsApprovalRequestsApproveCall

Approve: Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

- name: Name of the approval request to approve.

func (*ProjectsApprovalRequestsService) Dismiss 

func (r *ProjectsApprovalRequestsService) Dismiss(name string, dismissapprovalrequestmessage *DismissApprovalRequestMessage) *ProjectsApprovalRequestsDismissCall

Dismiss: Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

- name: Name of the ApprovalRequest to dismiss.

func (*ProjectsApprovalRequestsService) Get 

func (r *ProjectsApprovalRequestsService) Get(name string) *ProjectsApprovalRequestsGetCall

Get: Gets an approval request. Returns NOT_FOUND if the request does not exist.

  • name: The name of the approval request to retrieve. Format: "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".

func (*ProjectsApprovalRequestsService) Invalidate added in v0.81.0 

func (r *ProjectsApprovalRequestsService) Invalidate(name string, invalidateapprovalrequestmessage *InvalidateApprovalRequestMessage) *ProjectsApprovalRequestsInvalidateCall

Invalidate: Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.

- name: Name of the ApprovalRequest to invalidate.

func (*ProjectsApprovalRequestsService) List 

func (r *ProjectsApprovalRequestsService) List(parent string) *ProjectsApprovalRequestsListCall

List: Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

  • parent: The parent resource. This may be "projects/{project}", "folders/{folder}", or "organizations/{organization}".

type ProjectsDeleteAccessApprovalSettingsCall 

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

func (*ProjectsDeleteAccessApprovalSettingsCall) Context 

func (c *ProjectsDeleteAccessApprovalSettingsCall) Context(ctx context.Context) *ProjectsDeleteAccessApprovalSettingsCall

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

func (*ProjectsDeleteAccessApprovalSettingsCall) Do 

func (c *ProjectsDeleteAccessApprovalSettingsCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "accessapproval.projects.deleteAccessApprovalSettings" 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 (*ProjectsDeleteAccessApprovalSettingsCall) Fields 

func (c *ProjectsDeleteAccessApprovalSettingsCall) Fields(s ...googleapi.Field) *ProjectsDeleteAccessApprovalSettingsCall

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

func (*ProjectsDeleteAccessApprovalSettingsCall) Header 

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

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

type ProjectsGetAccessApprovalSettingsCall 

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

func (*ProjectsGetAccessApprovalSettingsCall) Context 

func (c *ProjectsGetAccessApprovalSettingsCall) Context(ctx context.Context) *ProjectsGetAccessApprovalSettingsCall

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

func (*ProjectsGetAccessApprovalSettingsCall) Do 

func (c *ProjectsGetAccessApprovalSettingsCall) Do(opts ...googleapi.CallOption) (*AccessApprovalSettings, error)

Do executes the "accessapproval.projects.getAccessApprovalSettings" call. Any non-2xx status code is an error. Response headers are in either *AccessApprovalSettings.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 (*ProjectsGetAccessApprovalSettingsCall) Fields 

func (c *ProjectsGetAccessApprovalSettingsCall) Fields(s ...googleapi.Field) *ProjectsGetAccessApprovalSettingsCall

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

func (*ProjectsGetAccessApprovalSettingsCall) Header 

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

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

func (*ProjectsGetAccessApprovalSettingsCall) IfNoneMatch 

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

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 ProjectsGetServiceAccountCall added in v0.71.0 

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

func (*ProjectsGetServiceAccountCall) Context added in v0.71.0 

func (c *ProjectsGetServiceAccountCall) Context(ctx context.Context) *ProjectsGetServiceAccountCall

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

func (*ProjectsGetServiceAccountCall) Do added in v0.71.0 

func (c *ProjectsGetServiceAccountCall) Do(opts ...googleapi.CallOption) (*AccessApprovalServiceAccount, error)

Do executes the "accessapproval.projects.getServiceAccount" call. Any non-2xx status code is an error. Response headers are in either *AccessApprovalServiceAccount.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 (*ProjectsGetServiceAccountCall) Fields added in v0.71.0 

func (c *ProjectsGetServiceAccountCall) Fields(s ...googleapi.Field) *ProjectsGetServiceAccountCall

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

func (*ProjectsGetServiceAccountCall) Header added in v0.71.0 

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

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

func (*ProjectsGetServiceAccountCall) IfNoneMatch added in v0.71.0 

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

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 ProjectsService 

type ProjectsService struct {
	ApprovalRequests *ProjectsApprovalRequestsService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService) DeleteAccessApprovalSettings 

func (r *ProjectsService) DeleteAccessApprovalSettings(name string) *ProjectsDeleteAccessApprovalSettingsCall

DeleteAccessApprovalSettings: Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

- name: Name of the AccessApprovalSettings to delete.

func (*ProjectsService) GetAccessApprovalSettings 

func (r *ProjectsService) GetAccessApprovalSettings(name string) *ProjectsGetAccessApprovalSettingsCall

GetAccessApprovalSettings: Gets the settings associated with a project, folder, or organization.

  • name: The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations}/{id}/accessApprovalSettings".

func (*ProjectsService) GetServiceAccount added in v0.71.0 

func (r *ProjectsService) GetServiceAccount(name string) *ProjectsGetServiceAccountCall

GetServiceAccount: Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.

- name: Name of the AccessApprovalServiceAccount to retrieve.

func (*ProjectsService) UpdateAccessApprovalSettings 

func (r *ProjectsService) UpdateAccessApprovalSettings(name string, accessapprovalsettings *AccessApprovalSettings) *ProjectsUpdateAccessApprovalSettingsCall

UpdateAccessApprovalSettings: Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

  • name: The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings".

type ProjectsUpdateAccessApprovalSettingsCall 

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

func (*ProjectsUpdateAccessApprovalSettingsCall) Context 

func (c *ProjectsUpdateAccessApprovalSettingsCall) Context(ctx context.Context) *ProjectsUpdateAccessApprovalSettingsCall

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

func (*ProjectsUpdateAccessApprovalSettingsCall) Do 

func (c *ProjectsUpdateAccessApprovalSettingsCall) Do(opts ...googleapi.CallOption) (*AccessApprovalSettings, error)

Do executes the "accessapproval.projects.updateAccessApprovalSettings" call. Any non-2xx status code is an error. Response headers are in either *AccessApprovalSettings.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 (*ProjectsUpdateAccessApprovalSettingsCall) Fields 

func (c *ProjectsUpdateAccessApprovalSettingsCall) Fields(s ...googleapi.Field) *ProjectsUpdateAccessApprovalSettingsCall

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

func (*ProjectsUpdateAccessApprovalSettingsCall) Header 

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

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

func (*ProjectsUpdateAccessApprovalSettingsCall) UpdateMask 

func (c *ProjectsUpdateAccessApprovalSettingsCall) UpdateMask(updateMask string) *ProjectsUpdateAccessApprovalSettingsCall

UpdateMask sets the optional parameter "updateMask": The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.

type ResourceProperties 

type ResourceProperties struct {
	// ExcludesDescendants: Whether an approval will exclude the descendants of the
	// resource being requested.
	ExcludesDescendants bool `json:"excludesDescendants,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExcludesDescendants") 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. "ExcludesDescendants") 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:"-"`
}

ResourceProperties: The properties associated with the resource of the request.

func (ResourceProperties) MarshalJSON 

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

type Service 

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

	Folders *FoldersService

	Organizations *OrganizationsService

	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 SignatureInfo added in v0.71.0 

type SignatureInfo struct {
	// CustomerKmsKeyVersion: The resource name of the customer CryptoKeyVersion
	// used for signing.
	CustomerKmsKeyVersion string `json:"customerKmsKeyVersion,omitempty"`
	// GoogleKeyAlgorithm: The hashing algorithm used for signature verification.
	// It will only be present in the case of Google managed keys.
	//
	// Possible values:
	//   "CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED" - Not specified.
	//   "GOOGLE_SYMMETRIC_ENCRYPTION" - Creates symmetric encryption keys.
	//   "AES_128_GCM" - AES-GCM (Galois Counter Mode) using 128-bit keys.
	//   "AES_256_GCM" - AES-GCM (Galois Counter Mode) using 256-bit keys.
	//   "AES_128_CBC" - AES-CBC (Cipher Block Chaining Mode) using 128-bit keys.
	//   "AES_256_CBC" - AES-CBC (Cipher Block Chaining Mode) using 256-bit keys.
	//   "AES_128_CTR" - AES-CTR (Counter Mode) using 128-bit keys.
	//   "AES_256_CTR" - AES-CTR (Counter Mode) using 256-bit keys.
	//   "RSA_SIGN_PSS_2048_SHA256" - RSASSA-PSS 2048 bit key with a SHA256 digest.
	//   "RSA_SIGN_PSS_3072_SHA256" - RSASSA-PSS 3072 bit key with a SHA256 digest.
	//   "RSA_SIGN_PSS_4096_SHA256" - RSASSA-PSS 4096 bit key with a SHA256 digest.
	//   "RSA_SIGN_PSS_4096_SHA512" - RSASSA-PSS 4096 bit key with a SHA512 digest.
	//   "RSA_SIGN_PKCS1_2048_SHA256" - RSASSA-PKCS1-v1_5 with a 2048 bit key and a
	// SHA256 digest.
	//   "RSA_SIGN_PKCS1_3072_SHA256" - RSASSA-PKCS1-v1_5 with a 3072 bit key and a
	// SHA256 digest.
	//   "RSA_SIGN_PKCS1_4096_SHA256" - RSASSA-PKCS1-v1_5 with a 4096 bit key and a
	// SHA256 digest.
	//   "RSA_SIGN_PKCS1_4096_SHA512" - RSASSA-PKCS1-v1_5 with a 4096 bit key and a
	// SHA512 digest.
	//   "RSA_SIGN_RAW_PKCS1_2048" - RSASSA-PKCS1-v1_5 signing without encoding,
	// with a 2048 bit key.
	//   "RSA_SIGN_RAW_PKCS1_3072" - RSASSA-PKCS1-v1_5 signing without encoding,
	// with a 3072 bit key.
	//   "RSA_SIGN_RAW_PKCS1_4096" - RSASSA-PKCS1-v1_5 signing without encoding,
	// with a 4096 bit key.
	//   "RSA_DECRYPT_OAEP_2048_SHA256" - RSAES-OAEP 2048 bit key with a SHA256
	// digest.
	//   "RSA_DECRYPT_OAEP_3072_SHA256" - RSAES-OAEP 3072 bit key with a SHA256
	// digest.
	//   "RSA_DECRYPT_OAEP_4096_SHA256" - RSAES-OAEP 4096 bit key with a SHA256
	// digest.
	//   "RSA_DECRYPT_OAEP_4096_SHA512" - RSAES-OAEP 4096 bit key with a SHA512
	// digest.
	//   "RSA_DECRYPT_OAEP_2048_SHA1" - RSAES-OAEP 2048 bit key with a SHA1 digest.
	//   "RSA_DECRYPT_OAEP_3072_SHA1" - RSAES-OAEP 3072 bit key with a SHA1 digest.
	//   "RSA_DECRYPT_OAEP_4096_SHA1" - RSAES-OAEP 4096 bit key with a SHA1 digest.
	//   "EC_SIGN_P256_SHA256" - ECDSA on the NIST P-256 curve with a SHA256
	// digest. Other hash functions can also be used:
	// https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
	//   "EC_SIGN_P384_SHA384" - ECDSA on the NIST P-384 curve with a SHA384
	// digest. Other hash functions can also be used:
	// https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
	//   "EC_SIGN_SECP256K1_SHA256" - ECDSA on the non-NIST secp256k1 curve. This
	// curve is only supported for HSM protection level. Other hash functions can
	// also be used:
	// https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
	//   "EC_SIGN_ED25519" - EdDSA on the Curve25519 in pure mode (taking data as
	// input).
	//   "HMAC_SHA256" - HMAC-SHA256 signing with a 256 bit key.
	//   "HMAC_SHA1" - HMAC-SHA1 signing with a 160 bit key.
	//   "HMAC_SHA384" - HMAC-SHA384 signing with a 384 bit key.
	//   "HMAC_SHA512" - HMAC-SHA512 signing with a 512 bit key.
	//   "HMAC_SHA224" - HMAC-SHA224 signing with a 224 bit key.
	//   "EXTERNAL_SYMMETRIC_ENCRYPTION" - Algorithm representing symmetric
	// encryption by an external key manager.
	GoogleKeyAlgorithm string `json:"googleKeyAlgorithm,omitempty"`
	// GooglePublicKeyPem: The public key for the Google default signing, encoded
	// in PEM format. The signature was created using a private key which may be
	// verified using this public key.
	GooglePublicKeyPem string `json:"googlePublicKeyPem,omitempty"`
	// SerializedApprovalRequest: The ApprovalRequest that is serialized without
	// the SignatureInfo message field. This data is used with the hashing
	// algorithm to generate the digital signature, and it can be used for
	// signature verification.
	SerializedApprovalRequest string `json:"serializedApprovalRequest,omitempty"`
	// Signature: The digital signature.
	Signature string `json:"signature,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CustomerKmsKeyVersion") 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. "CustomerKmsKeyVersion") 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:"-"`
}

SignatureInfo: Information about the digital signature of the resource.

func (SignatureInfo) MarshalJSON added in v0.71.0 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.