Movatterモバイル変換


[0]ホーム

URL:


orgpolicy

package
v0.257.0Latest Latest
Warning

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

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:0

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package orgpolicy provides access to the Organization Policy API.

For product documentation, see:https://cloud.google.com/orgpolicy/docs/reference/rest/index.html

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany 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/orgpolicy/v2"...ctx := context.Background()orgpolicyService, err := orgpolicy.NewService(ctx)

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

Other authentication options

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

orgpolicyService, err := orgpolicy.NewService(ctx, option.WithAPIKey("AIza..."))

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

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

Seegoogle.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

typeFoldersConstraintsListCall

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

func (*FoldersConstraintsListCall)Context

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

func (*FoldersConstraintsListCall)Do

Do executes the "orgpolicy.folders.constraints.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2ListConstraintsResponse.ServerResponse.Header or (ifa response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*FoldersConstraintsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*FoldersConstraintsListCall)Header

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

func (*FoldersConstraintsListCall)IfNoneMatch

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

func (*FoldersConstraintsListCall)PageSize

PageSize sets the optional parameter "pageSize": Size of the pages to bereturned. This is currently unsupported and will be ignored. The server mayat any point start using this field to limit page size.

func (*FoldersConstraintsListCall)PageToken

PageToken sets the optional parameter "pageToken": Page token used toretrieve the next page. This is currently unsupported and will be ignored.The server may at any point start using this field.

func (*FoldersConstraintsListCall)Pages

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

typeFoldersConstraintsService

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

funcNewFoldersConstraintsService

func NewFoldersConstraintsService(s *Service) *FoldersConstraintsService

func (*FoldersConstraintsService)List

List: Lists constraints that could be applied on the specified resource.

  • parent: The Google Cloud resource that parents the constraint. Must be inone of the following forms: * `projects/{project_number}` *`projects/{project_id}` * `folders/{folder_id}` *`organizations/{organization_id}`.

typeFoldersPoliciesCreateCall

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

func (*FoldersPoliciesCreateCall)Context

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

func (*FoldersPoliciesCreateCall)Do

Do executes the "orgpolicy.folders.policies.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2Policy.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*FoldersPoliciesCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*FoldersPoliciesCreateCall)Header

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

typeFoldersPoliciesDeleteCall

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

func (*FoldersPoliciesDeleteCall)Context

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

func (*FoldersPoliciesDeleteCall)Do

Do executes the "orgpolicy.folders.policies.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*FoldersPoliciesDeleteCall)Etagadded inv0.154.0

Etag sets the optional parameter "etag": The current etag of policy. If anetag is provided and does not match the current etag of the policy, deletionwill be blocked and an ABORTED error will be returned.

func (*FoldersPoliciesDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*FoldersPoliciesDeleteCall)Header

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

typeFoldersPoliciesGetCall

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

func (*FoldersPoliciesGetCall)Context

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

func (*FoldersPoliciesGetCall)Do

Do executes the "orgpolicy.folders.policies.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2Policy.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*FoldersPoliciesGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*FoldersPoliciesGetCall)Header

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

func (*FoldersPoliciesGetCall)IfNoneMatch

func (c *FoldersPoliciesGetCall) IfNoneMatch(entityTagstring) *FoldersPoliciesGetCall

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

typeFoldersPoliciesGetEffectivePolicyCall

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

func (*FoldersPoliciesGetEffectivePolicyCall)Context

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

func (*FoldersPoliciesGetEffectivePolicyCall)Do

Do executes the "orgpolicy.folders.policies.getEffectivePolicy" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2Policy.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*FoldersPoliciesGetEffectivePolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*FoldersPoliciesGetEffectivePolicyCall)Header

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

func (*FoldersPoliciesGetEffectivePolicyCall)IfNoneMatch

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

typeFoldersPoliciesListCall

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

func (*FoldersPoliciesListCall)Context

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

func (*FoldersPoliciesListCall)Do

Do executes the "orgpolicy.folders.policies.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2ListPoliciesResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*FoldersPoliciesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*FoldersPoliciesListCall)Header

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

func (*FoldersPoliciesListCall)IfNoneMatch

func (c *FoldersPoliciesListCall) IfNoneMatch(entityTagstring) *FoldersPoliciesListCall

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

func (*FoldersPoliciesListCall)PageSize

PageSize sets the optional parameter "pageSize": Size of the pages to bereturned. This is currently unsupported and will be ignored. The server mayat any point start using this field to limit page size.

func (*FoldersPoliciesListCall)PageToken

PageToken sets the optional parameter "pageToken": Page token used toretrieve the next page. This is currently unsupported and will be ignored.The server may at any point start using this field.

func (*FoldersPoliciesListCall)Pages

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

typeFoldersPoliciesPatchCall

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

func (*FoldersPoliciesPatchCall)Context

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

func (*FoldersPoliciesPatchCall)Do

Do executes the "orgpolicy.folders.policies.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2Policy.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*FoldersPoliciesPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*FoldersPoliciesPatchCall)Header

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

func (*FoldersPoliciesPatchCall)UpdateMaskadded inv0.108.0

UpdateMask sets the optional parameter "updateMask": Field mask used tospecify the fields to be overwritten in the policy by the set. The fieldsspecified in the update_mask are relative to the policy, not the fullrequest.

typeFoldersPoliciesService

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

funcNewFoldersPoliciesService

func NewFoldersPoliciesService(s *Service) *FoldersPoliciesService

func (*FoldersPoliciesService)Create

func (r *FoldersPoliciesService) Create(parentstring, googlecloudorgpolicyv2policy *GoogleCloudOrgpolicyV2Policy) *FoldersPoliciesCreateCall

Create: Creates a policy. Returns a `google.rpc.Status` with`google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a`google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policyalready exists on the given Google Cloud resource.

  • parent: The Google Cloud resource that will parent the new policy. Must bein one of the following forms: * `projects/{project_number}` *`projects/{project_id}` * `folders/{folder_id}` *`organizations/{organization_id}`.

func (*FoldersPoliciesService)Delete

Delete: Deletes a policy. Returns a `google.rpc.Status` with`google.rpc.Code.NOT_FOUND` if the constraint or organization policy doesnot exist.

- name: Name of the policy to delete. See the policy entry for naming rules.

func (*FoldersPoliciesService)Get

Get: Gets a policy on a resource. If no policy is set on the resource,`NOT_FOUND` is returned. The `etag` value can be used with `UpdatePolicy()`to update a policy during read-modify-write.

- name: Resource name of the policy. See Policy for naming requirements.

func (*FoldersPoliciesService)GetEffectivePolicy

GetEffectivePolicy: Gets the effective policy on a resource. This is theresult of merging policies in the resource hierarchy and evaluatingconditions. The returned policy will not have an `etag` or `condition` setbecause it is an evaluated policy across multiple resources. Subtrees ofResource Manager resource hierarchy with 'under:' prefix will not beexpanded.

- name: The effective policy to compute. See Policy for naming requirements.

func (*FoldersPoliciesService)List

List: Retrieves all of the policies that exist on a particular resource.

  • parent: The target Google Cloud resource that parents the set ofconstraints and policies that will be returned from this call. Must be inone of the following forms: * `projects/{project_number}` *`projects/{project_id}` * `folders/{folder_id}` *`organizations/{organization_id}`.

func (*FoldersPoliciesService)Patch

func (r *FoldersPoliciesService) Patch(namestring, googlecloudorgpolicyv2policy *GoogleCloudOrgpolicyV2Policy) *FoldersPoliciesPatchCall

Patch: Updates a policy. Returns a `google.rpc.Status` with`google.rpc.Code.NOT_FOUND` if the constraint or the policy do not exist.Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etagsupplied in the request does not match the persisted etag of the policyNote: the supplied policy will perform a full overwrite of all fields.

  • name: Immutable. The resource name of the policy. Must be one of thefollowing forms, where `constraint_name` is the name of the constraintwhich this policy configures: *`projects/{project_number}/policies/{constraint_name}` *`folders/{folder_id}/policies/{constraint_name}` *`organizations/{organization_id}/policies/{constraint_name}` For example,`projects/123/policies/compute.disableSerialPortAccess`. Note:`projects/{project_id}/policies/{constraint_name}` is also an acceptablename for API requests, but responses will return the name using theequivalent project number.

typeFoldersService

type FoldersService struct {Constraints *FoldersConstraintsServicePolicies *FoldersPoliciesService// contains filtered or unexported fields}

funcNewFoldersService

func NewFoldersService(s *Service) *FoldersService

typeGoogleCloudOrgpolicyV2AlternatePolicySpecadded inv0.65.0

type GoogleCloudOrgpolicyV2AlternatePolicySpec struct {// Launch: Reference to the launch that will be used while audit logging and to// control the launch. Should be set only in the alternate policy.Launchstring `json:"launch,omitempty"`// Spec: Specify constraint for configurations of Google Cloud resources.Spec *GoogleCloudOrgpolicyV2PolicySpec `json:"spec,omitempty"`// ForceSendFields is a list of field names (e.g. "Launch") 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. "Launch") 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:"-"`}

GoogleCloudOrgpolicyV2AlternatePolicySpec: Similar to PolicySpec but with anextra 'launch' field for launch reference. The PolicySpec here is specificfor dry-run.

func (GoogleCloudOrgpolicyV2AlternatePolicySpec)MarshalJSONadded inv0.65.0

typeGoogleCloudOrgpolicyV2Constraint

type GoogleCloudOrgpolicyV2Constraint struct {// BooleanConstraint: Defines this constraint as being a boolean constraint.BooleanConstraint *GoogleCloudOrgpolicyV2ConstraintBooleanConstraint `json:"booleanConstraint,omitempty"`// ConstraintDefault: The evaluation behavior of this constraint in the absence// of a policy.//// Possible values://   "CONSTRAINT_DEFAULT_UNSPECIFIED" - This is only used for distinguishing// unset values and should never be used. Results in an error.//   "ALLOW" - Indicate that all values are allowed for list constraints.// Indicate that enforcement is off for boolean constraints.//   "DENY" - Indicate that all values are denied for list constraints.// Indicate that enforcement is on for boolean constraints.ConstraintDefaultstring `json:"constraintDefault,omitempty"`// Description: Detailed description of what this constraint controls as well// as how and where it is enforced. Mutable.Descriptionstring `json:"description,omitempty"`// DisplayName: The human readable name. Mutable.DisplayNamestring `json:"displayName,omitempty"`// EquivalentConstraint: Managed constraint and canned constraint sometimes can// have equivalents. This field is used to store the equivalent constraint// name.EquivalentConstraintstring `json:"equivalentConstraint,omitempty"`// ListConstraint: Defines this constraint as being a list constraint.ListConstraint *GoogleCloudOrgpolicyV2ConstraintListConstraint `json:"listConstraint,omitempty"`// Name: Immutable. The resource name of the constraint. Must be in one of the// following forms: * `projects/{project_number}/constraints/{constraint_name}`// * `folders/{folder_id}/constraints/{constraint_name}` *// `organizations/{organization_id}/constraints/{constraint_name}` For example,// "/projects/123/constraints/compute.disableSerialPortAccess".Namestring `json:"name,omitempty"`// SupportsDryRun: Shows if dry run is supported for this constraint or not.SupportsDryRunbool `json:"supportsDryRun,omitempty"`// SupportsSimulation: Shows if simulation is supported for this constraint or// not.SupportsSimulationbool `json:"supportsSimulation,omitempty"`// ForceSendFields is a list of field names (e.g. "BooleanConstraint") 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. "BooleanConstraint") 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:"-"`}

GoogleCloudOrgpolicyV2Constraint: A constraint describes a way to restrictresource's configuration. For example, you could enforce a constraint thatcontrols which Google Cloud services can be activated across anorganization, or whether a Compute Engine instance can have serial portconnections established. Constraints can be configured by the organizationpolicy administrator to fit the needs of the organization by setting apolicy that includes constraints at different locations in theorganization's resource hierarchy. Policies are inherited down the resourcehierarchy from higher levels, but can also be overridden. For details aboutthe inheritance rules, see `Policy`. Constraints have a default behaviordetermined by the `constraint_default` field, which is the enforcementbehavior that is used in the absence of a policy being defined or inheritedfor the resource in question.

func (GoogleCloudOrgpolicyV2Constraint)MarshalJSON

func (sGoogleCloudOrgpolicyV2Constraint) MarshalJSON() ([]byte,error)

typeGoogleCloudOrgpolicyV2ConstraintBooleanConstraint

type GoogleCloudOrgpolicyV2ConstraintBooleanConstraint struct {// CustomConstraintDefinition: Custom constraint definition. Defines this as a// managed constraint.CustomConstraintDefinition *GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition `json:"customConstraintDefinition,omitempty"`// ForceSendFields is a list of field names (e.g. "CustomConstraintDefinition")// 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. "CustomConstraintDefinition") 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:"-"`}

GoogleCloudOrgpolicyV2ConstraintBooleanConstraint: A constraint type isenforced or not enforced, which is configured in the `PolicyRule`. If`customConstraintDefinition` is defined, this constraint is a managedconstraint.

func (GoogleCloudOrgpolicyV2ConstraintBooleanConstraint)MarshalJSONadded inv0.204.0

typeGoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionadded inv0.204.0

type GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition struct {// ActionType: Allow or deny type.//// Possible values://   "ACTION_TYPE_UNSPECIFIED" - This is only used for distinguishing unset// values and should never be used. Results in an error.//   "ALLOW" - Allowed action type.//   "DENY" - Deny action type.ActionTypestring `json:"actionType,omitempty"`// Condition: Org policy condition/expression. For example:// `resource.instanceName.matches("[production|test]_.*_(\d)+")` or,// `resource.management.auto_upgrade == true` The max length of the condition// is 1000 characters.Conditionstring `json:"condition,omitempty"`// MethodTypes: All the operations being applied for this constraint.//// Possible values://   "METHOD_TYPE_UNSPECIFIED" - This is only used for distinguishing unset// values and should never be used. Results in an error.//   "CREATE" - Constraint applied when creating the resource.//   "UPDATE" - Constraint applied when updating the resource.//   "DELETE" - Constraint applied when deleting the resource. Not currently// supported.//   "REMOVE_GRANT" - Constraint applied when removing an IAM grant.//   "GOVERN_TAGS" - Constraint applied when enforcing forced tagging.MethodTypes []string `json:"methodTypes,omitempty"`// Parameters: Stores the structure of `Parameters` used by the constraint// condition. The key of `map` represents the name of the parameter.Parameters map[string]GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter `json:"parameters,omitempty"`// ResourceTypes: The resource instance type on which this policy applies.// Format will be of the form : `/` Example: *// `compute.googleapis.com/Instance`.ResourceTypes []string `json:"resourceTypes,omitempty"`// ForceSendFields is a list of field names (e.g. "ActionType") 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. "ActionType") 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:"-"`}

GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition: Customconstraint definition. Defines this as a managed constraint.

func (GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinition)MarshalJSONadded inv0.204.0

typeGoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameteradded inv0.204.0

type GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter struct {// DefaultValue: Sets the value of the parameter in an assignment if no value// is given.DefaultValue interface{} `json:"defaultValue,omitempty"`// Item: Determines the parameter's value structure. For example, `LIST` can be// specified by defining `type: LIST`, and `item: STRING`.//// Possible values://   "TYPE_UNSPECIFIED" - This is only used for distinguishing unset values and// should never be used. Results in an error.//   "LIST" - List parameter type.//   "STRING" - String parameter type.//   "BOOLEAN" - Boolean parameter type.Itemstring `json:"item,omitempty"`// Metadata: Defines subproperties primarily used by the UI to display// user-friendly information.Metadata *GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata `json:"metadata,omitempty"`// Type: Type of the parameter.//// Possible values://   "TYPE_UNSPECIFIED" - This is only used for distinguishing unset values and// should never be used. Results in an error.//   "LIST" - List parameter type.//   "STRING" - String parameter type.//   "BOOLEAN" - Boolean parameter type.Typestring `json:"type,omitempty"`// ValidValuesExpr: Provides a CEL expression to specify the acceptable// parameter values during assignment. For example, parameterName in// ("parameterValue1", "parameterValue2")ValidValuesExprstring `json:"validValuesExpr,omitempty"`// ForceSendFields is a list of field names (e.g. "DefaultValue") 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. "DefaultValue") 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:"-"`}

GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter: Definesa parameter structure.

func (GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameter)MarshalJSONadded inv0.204.0

typeGoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadataadded inv0.204.0

type GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata struct {// Description: Detailed description of what this `parameter` is and use of it.// Mutable.Descriptionstring `json:"description,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata:Defines Metadata structure.

func (GoogleCloudOrgpolicyV2ConstraintCustomConstraintDefinitionParameterMetadata)MarshalJSONadded inv0.204.0

typeGoogleCloudOrgpolicyV2ConstraintListConstraint

type GoogleCloudOrgpolicyV2ConstraintListConstraint struct {// SupportsIn: Indicates whether values grouped into categories can be used in// `Policy.allowed_values` and `Policy.denied_values`. For example,// "in:Python" would match any value in the 'Python' group.SupportsInbool `json:"supportsIn,omitempty"`// SupportsUnder: Indicates whether subtrees of the Resource Manager resource// hierarchy can be used in `Policy.allowed_values` and `Policy.denied_values`.// For example, "under:folders/123" would match any resource under the// 'folders/123' folder.SupportsUnderbool `json:"supportsUnder,omitempty"`// ForceSendFields is a list of field names (e.g. "SupportsIn") 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. "SupportsIn") 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:"-"`}

GoogleCloudOrgpolicyV2ConstraintListConstraint: A constraint type thatallows or disallows a list of string values, which are configured in the`PolicyRule`.

func (GoogleCloudOrgpolicyV2ConstraintListConstraint)MarshalJSON

typeGoogleCloudOrgpolicyV2CustomConstraintadded inv0.61.0

type GoogleCloudOrgpolicyV2CustomConstraint struct {// ActionType: Allow or deny type.//// Possible values://   "ACTION_TYPE_UNSPECIFIED" - This is only used for distinguishing unset// values and should never be used. Results in an error.//   "ALLOW" - Allowed action type.//   "DENY" - Deny action type.ActionTypestring `json:"actionType,omitempty"`// Condition: A Common Expression Language (CEL) condition which is used in the// evaluation of the constraint. For example:// `resource.instanceName.matches("[production|test]_.*_(\d)+")` or,// `resource.management.auto_upgrade == true` The max length of the condition// is 1000 characters.Conditionstring `json:"condition,omitempty"`// Description: Detailed information about this custom policy constraint. The// max length of the description is 2000 characters.Descriptionstring `json:"description,omitempty"`// DisplayName: One line display name for the UI. The max length of the// display_name is 200 characters.DisplayNamestring `json:"displayName,omitempty"`// MethodTypes: All the operations being applied for this constraint.//// Possible values://   "METHOD_TYPE_UNSPECIFIED" - This is only used for distinguishing unset// values and should never be used. Results in an error.//   "CREATE" - Constraint applied when creating the resource.//   "UPDATE" - Constraint applied when updating the resource.//   "DELETE" - Constraint applied when deleting the resource. Not currently// supported.//   "REMOVE_GRANT" - Constraint applied when removing an IAM grant.//   "GOVERN_TAGS" - Constraint applied when enforcing forced tagging.MethodTypes []string `json:"methodTypes,omitempty"`// Name: Immutable. Name of the constraint. This is unique within the// organization. Format of the name should be *// `organizations/{organization_id}/customConstraints/{custom_constraint_id}`// Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`// The max length is 70 characters and the minimum length is 1. Note that the// prefix `organizations/{organization_id}/customConstraints/` is not counted.Namestring `json:"name,omitempty"`// ResourceTypes: Immutable. The resource instance type on which this policy// applies. Format will be of the form : `/` Example: *// `compute.googleapis.com/Instance`.ResourceTypes []string `json:"resourceTypes,omitempty"`// UpdateTime: Output only. The last time this custom constraint was updated.// This represents the last time that the `CreateCustomConstraint` or// `UpdateCustomConstraint` methods were called.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ActionType") 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. "ActionType") 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:"-"`}

GoogleCloudOrgpolicyV2CustomConstraint: A custom constraint defined bycustomers which can *only* be applied to the given resource types andorganization. By creating a custom constraint, customers can apply policiesof this custom constraint. *Creating a custom constraint itself does NOTapply any policy enforcement*.

func (GoogleCloudOrgpolicyV2CustomConstraint)MarshalJSONadded inv0.61.0

typeGoogleCloudOrgpolicyV2ListConstraintsResponse

type GoogleCloudOrgpolicyV2ListConstraintsResponse struct {// Constraints: The collection of constraints that are available on the// targeted resource.Constraints []*GoogleCloudOrgpolicyV2Constraint `json:"constraints,omitempty"`// NextPageToken: Page token used to retrieve the next page. This is currently// not used.NextPageTokenstring `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. "Constraints") 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. "Constraints") 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:"-"`}

GoogleCloudOrgpolicyV2ListConstraintsResponse: The response returned fromthe ListConstraints method.

func (GoogleCloudOrgpolicyV2ListConstraintsResponse)MarshalJSON

typeGoogleCloudOrgpolicyV2ListCustomConstraintsResponseadded inv0.94.0

type GoogleCloudOrgpolicyV2ListCustomConstraintsResponse struct {// CustomConstraints: All custom and managed constraints that exist on the// organization resource. It will be empty if no custom constraints are set.CustomConstraints []*GoogleCloudOrgpolicyV2CustomConstraint `json:"customConstraints,omitempty"`// NextPageToken: Page token used to retrieve the next page. This is currently// not used, but the server may at any point start supplying a valid token.NextPageTokenstring `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. "CustomConstraints") 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. "CustomConstraints") 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:"-"`}

GoogleCloudOrgpolicyV2ListCustomConstraintsResponse: The response returnedfrom the ListCustomConstraints method. It will be empty if no custom ormanaged constraints are set on the organization resource.

func (GoogleCloudOrgpolicyV2ListCustomConstraintsResponse)MarshalJSONadded inv0.94.0

typeGoogleCloudOrgpolicyV2ListPoliciesResponse

type GoogleCloudOrgpolicyV2ListPoliciesResponse struct {// NextPageToken: Page token used to retrieve the next page. This is currently// not used, but the server may at any point start supplying a valid token.NextPageTokenstring `json:"nextPageToken,omitempty"`// Policies: All policies that exist on the resource. It will be empty if no// policies are set.Policies []*GoogleCloudOrgpolicyV2Policy `json:"policies,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudOrgpolicyV2ListPoliciesResponse: The response returned from theListPolicies method. It will be empty if no policies are set on theresource.

func (GoogleCloudOrgpolicyV2ListPoliciesResponse)MarshalJSON

typeGoogleCloudOrgpolicyV2Policy

type GoogleCloudOrgpolicyV2Policy struct {// Alternate: Deprecated.Alternate *GoogleCloudOrgpolicyV2AlternatePolicySpec `json:"alternate,omitempty"`// DryRunSpec: Dry-run policy. Audit-only policy, can be used to monitor how// the policy would have impacted the existing and future resources if it's// enforced.DryRunSpec *GoogleCloudOrgpolicyV2PolicySpec `json:"dryRunSpec,omitempty"`// Etag: Optional. An opaque tag indicating the current state of the policy,// used for concurrency control. This 'etag' is computed by the server based on// the value of other fields, and may be sent on update and delete requests to// ensure the client has an up-to-date value before proceeding.Etagstring `json:"etag,omitempty"`// Name: Immutable. The resource name of the policy. Must be one of the// following forms, where `constraint_name` is the name of the constraint which// this policy configures: *// `projects/{project_number}/policies/{constraint_name}` *// `folders/{folder_id}/policies/{constraint_name}` *// `organizations/{organization_id}/policies/{constraint_name}` For example,// `projects/123/policies/compute.disableSerialPortAccess`. Note:// `projects/{project_id}/policies/{constraint_name}` is also an acceptable// name for API requests, but responses will return the name using the// equivalent project number.Namestring `json:"name,omitempty"`// Spec: Basic information about the organization policy.Spec *GoogleCloudOrgpolicyV2PolicySpec `json:"spec,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Alternate") 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. "Alternate") 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:"-"`}

GoogleCloudOrgpolicyV2Policy: Defines an organization policy which is usedto specify constraints for configurations of Google Cloud resources.

func (GoogleCloudOrgpolicyV2Policy)MarshalJSON

func (sGoogleCloudOrgpolicyV2Policy) MarshalJSON() ([]byte,error)

typeGoogleCloudOrgpolicyV2PolicySpec

type GoogleCloudOrgpolicyV2PolicySpec struct {// Etag: An opaque tag indicating the current version of the policySpec, used// for concurrency control. This field is ignored if used in a `CreatePolicy`// request. When the policy is returned from either a `GetPolicy` or a// `ListPolicies` request, this `etag` indicates the version of the current// policySpec to use when executing a read-modify-write loop. When the policy// is returned from a `GetEffectivePolicy` request, the `etag` will be unset.Etagstring `json:"etag,omitempty"`// InheritFromParent: Determines the inheritance behavior for this policy. If// `inherit_from_parent` is true, policy rules set higher up in the hierarchy// (up to the closest root) are inherited and present in the effective policy.// If it is false, then no rules are inherited, and this policy becomes the new// root for evaluation. This field can be set only for policies which configure// list constraints.InheritFromParentbool `json:"inheritFromParent,omitempty"`// Reset: Ignores policies set above this resource and restores the// `constraint_default` enforcement behavior of the specific constraint at this// resource. This field can be set in policies for either list or boolean// constraints. If set, `rules` must be empty and `inherit_from_parent` must be// set to false.Resetbool `json:"reset,omitempty"`// Rules: In policies for boolean constraints, the following requirements// apply: - There must be one and only one policy rule where condition is// unset. - Boolean policy rules with conditions must set `enforced` to the// opposite of the policy rule without a condition. - During policy evaluation,// policy rules with conditions that are true for a target resource take// precedence.Rules []*GoogleCloudOrgpolicyV2PolicySpecPolicyRule `json:"rules,omitempty"`// UpdateTime: Output only. The time stamp this was previously updated. This// represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made// for that policy.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "Etag") 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. "Etag") 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:"-"`}

GoogleCloudOrgpolicyV2PolicySpec: Defines a Google Cloud policyspecification which is used to specify constraints for configurations ofGoogle Cloud resources.

func (GoogleCloudOrgpolicyV2PolicySpec)MarshalJSON

func (sGoogleCloudOrgpolicyV2PolicySpec) MarshalJSON() ([]byte,error)

typeGoogleCloudOrgpolicyV2PolicySpecPolicyRule

type GoogleCloudOrgpolicyV2PolicySpecPolicyRule struct {// AllowAll: Setting this to true means that all values are allowed. This field// can be set only in policies for list constraints.AllowAllbool `json:"allowAll,omitempty"`// Condition: A condition which determines whether this rule is used in the// evaluation of the policy. When set, the `expression` field in the `Expr'// must include from 1 to 10 subexpressions, joined by the "||" or "&&"// operators. Each subexpression must be of the form// "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". or// "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". where// key_name and value_name are the resource names for Label Keys and Values.// These names are available from the Tag Manager Service. An example// expression is: "resource.matchTag('123456789/environment, 'prod')". or// "resource.matchTagId('tagKeys/123', 'tagValues/456')".Condition *GoogleTypeExpr `json:"condition,omitempty"`// DenyAll: Setting this to true means that all values are denied. This field// can be set only in policies for list constraints.DenyAllbool `json:"denyAll,omitempty"`// Enforce: If `true`, then the policy is enforced. If `false`, then any// configuration is acceptable. This field can be set in policies for boolean// constraints, custom constraints and managed constraints.Enforcebool `json:"enforce,omitempty"`// Parameters: Optional. Required for managed constraints if parameters are// defined. Passes parameter values when policy enforcement is enabled. Ensure// that parameter value types match those defined in the constraint definition.// For example: “` { "allowedLocations" : ["us-east1", "us-west1"], "allowAll"// : true } “`Parametersgoogleapi.RawMessage `json:"parameters,omitempty"`// Values: List of values to be used for this policy rule. This field can be// set only in policies for list constraints.Values *GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "AllowAll") 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. "AllowAll") 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:"-"`}

GoogleCloudOrgpolicyV2PolicySpecPolicyRule: A rule used to express thispolicy.

func (GoogleCloudOrgpolicyV2PolicySpecPolicyRule)MarshalJSON

typeGoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues

type GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues struct {// AllowedValues: List of values allowed at this resource.AllowedValues []string `json:"allowedValues,omitempty"`// DeniedValues: List of values denied at this resource.DeniedValues []string `json:"deniedValues,omitempty"`// ForceSendFields is a list of field names (e.g. "AllowedValues") 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. "AllowedValues") 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:"-"`}

GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: A message that holdsspecific allowed and denied values. This message can define specific valuesand subtrees of the Resource Manager resource hierarchy (`Organizations`,`Folders`, `Projects`) that are allowed or denied. This is achieved by usingthe `under:` and optional `is:` prefixes. The `under:` prefix is used todenote resource subtree values. The `is:` prefix is used to denote specificvalues, and is required only if the value contains a ":". Values prefixedwith "is:" are treated the same as values with no prefix. Ancestry subtreesmust be in one of the following formats: - `projects/` (for example,`projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) -`organizations/` (for example, `organizations/1234`) The `supports_under`field of the associated `Constraint` defines whether ancestry prefixes canbe used.

func (GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues)MarshalJSON

typeGoogleProtobufEmpty

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

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

typeGoogleTypeExpr

type GoogleTypeExpr struct {// Description: Optional. Description of the expression. This is a longer text// which describes the expression, e.g. when hovered over it in a UI.Descriptionstring `json:"description,omitempty"`// Expression: Textual representation of an expression in Common Expression// Language syntax.Expressionstring `json:"expression,omitempty"`// Location: Optional. String indicating the location of the expression for// error reporting, e.g. a file name and a position in the file.Locationstring `json:"location,omitempty"`// Title: Optional. Title for the expression, i.e. a short string describing// its purpose. This can be used e.g. in UIs which allow to enter the// expression.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleTypeExpr: Represents a textual expression in the Common ExpressionLanguage (CEL) syntax. CEL is a C-like expression language. The syntax andsemantics of CEL are documented athttps://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determinesif a summary is less than 100 chars" expression: "document.summary.size() <100" Example (Equality): title: "Requestor is owner" description:"Determines if requestor is the document owner" expression: "document.owner== request.auth.claims.email" Example (Logic): title: "Public documents"description: "Determine whether the document should be publicly visible"expression: "document.type != 'private' && document.type != 'internal'"Example (Data Manipulation): title: "Notification string" description:"Create a notification string with a timestamp." expression: "'New messagereceived at ' + string(document.create_time)" The exact variables andfunctions that may be referenced within an expression are determined by theservice that evaluates it. See the service documentation for additionalinformation.

func (GoogleTypeExpr)MarshalJSON

func (sGoogleTypeExpr) MarshalJSON() ([]byte,error)

typeOrganizationsConstraintsListCall

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

func (*OrganizationsConstraintsListCall)Context

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

func (*OrganizationsConstraintsListCall)Do

Do executes the "orgpolicy.organizations.constraints.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2ListConstraintsResponse.ServerResponse.Header or (ifa response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*OrganizationsConstraintsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrganizationsConstraintsListCall)Header

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

func (*OrganizationsConstraintsListCall)IfNoneMatch

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

func (*OrganizationsConstraintsListCall)PageSize

PageSize sets the optional parameter "pageSize": Size of the pages to bereturned. This is currently unsupported and will be ignored. The server mayat any point start using this field to limit page size.

func (*OrganizationsConstraintsListCall)PageToken

PageToken sets the optional parameter "pageToken": Page token used toretrieve the next page. This is currently unsupported and will be ignored.The server may at any point start using this field.

func (*OrganizationsConstraintsListCall)Pages

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

typeOrganizationsConstraintsService

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

funcNewOrganizationsConstraintsService

func NewOrganizationsConstraintsService(s *Service) *OrganizationsConstraintsService

func (*OrganizationsConstraintsService)List

List: Lists constraints that could be applied on the specified resource.

  • parent: The Google Cloud resource that parents the constraint. Must be inone of the following forms: * `projects/{project_number}` *`projects/{project_id}` * `folders/{folder_id}` *`organizations/{organization_id}`.

typeOrganizationsCustomConstraintsCreateCalladded inv0.94.0

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

func (*OrganizationsCustomConstraintsCreateCall)Contextadded inv0.94.0

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

func (*OrganizationsCustomConstraintsCreateCall)Doadded inv0.94.0

Do executes the "orgpolicy.organizations.customConstraints.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2CustomConstraint.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*OrganizationsCustomConstraintsCreateCall)Fieldsadded inv0.94.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrganizationsCustomConstraintsCreateCall)Headeradded inv0.94.0

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

typeOrganizationsCustomConstraintsDeleteCalladded inv0.94.0

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

func (*OrganizationsCustomConstraintsDeleteCall)Contextadded inv0.94.0

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

func (*OrganizationsCustomConstraintsDeleteCall)Doadded inv0.94.0

Do executes the "orgpolicy.organizations.customConstraints.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*OrganizationsCustomConstraintsDeleteCall)Fieldsadded inv0.94.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrganizationsCustomConstraintsDeleteCall)Headeradded inv0.94.0

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

typeOrganizationsCustomConstraintsGetCalladded inv0.94.0

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

func (*OrganizationsCustomConstraintsGetCall)Contextadded inv0.94.0

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

func (*OrganizationsCustomConstraintsGetCall)Doadded inv0.94.0

Do executes the "orgpolicy.organizations.customConstraints.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2CustomConstraint.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*OrganizationsCustomConstraintsGetCall)Fieldsadded inv0.94.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrganizationsCustomConstraintsGetCall)Headeradded inv0.94.0

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

func (*OrganizationsCustomConstraintsGetCall)IfNoneMatchadded inv0.94.0

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

typeOrganizationsCustomConstraintsListCalladded inv0.94.0

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

func (*OrganizationsCustomConstraintsListCall)Contextadded inv0.94.0

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

func (*OrganizationsCustomConstraintsListCall)Doadded inv0.94.0

Do executes the "orgpolicy.organizations.customConstraints.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2ListCustomConstraintsResponse.ServerResponse.Headeror (if a response was returned at all) in error.(*googleapi.Error).Header.Use googleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*OrganizationsCustomConstraintsListCall)Fieldsadded inv0.94.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrganizationsCustomConstraintsListCall)Headeradded inv0.94.0

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

func (*OrganizationsCustomConstraintsListCall)IfNoneMatchadded inv0.94.0

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

func (*OrganizationsCustomConstraintsListCall)PageSizeadded inv0.94.0

PageSize sets the optional parameter "pageSize": Size of the pages to bereturned. This is currently unsupported and will be ignored. The server mayat any point start using this field to limit page size.

func (*OrganizationsCustomConstraintsListCall)PageTokenadded inv0.94.0

PageToken sets the optional parameter "pageToken": Page token used toretrieve the next page. This is currently unsupported and will be ignored.The server may at any point start using this field.

func (*OrganizationsCustomConstraintsListCall)Pagesadded inv0.94.0

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

typeOrganizationsCustomConstraintsPatchCalladded inv0.61.0

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

func (*OrganizationsCustomConstraintsPatchCall)Contextadded inv0.61.0

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

func (*OrganizationsCustomConstraintsPatchCall)Doadded inv0.61.0

Do executes the "orgpolicy.organizations.customConstraints.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2CustomConstraint.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*OrganizationsCustomConstraintsPatchCall)Fieldsadded inv0.61.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrganizationsCustomConstraintsPatchCall)Headeradded inv0.61.0

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

typeOrganizationsCustomConstraintsServiceadded inv0.61.0

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

funcNewOrganizationsCustomConstraintsServiceadded inv0.61.0

func NewOrganizationsCustomConstraintsService(s *Service) *OrganizationsCustomConstraintsService

func (*OrganizationsCustomConstraintsService)Createadded inv0.94.0

Create: Creates a custom constraint. Returns a `google.rpc.Status` with`google.rpc.Code.NOT_FOUND` if the organization does not exist. Returns a`google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the constraintalready exists on the given organization.

- parent: Must be in the following form: * `organizations/{organization_id}`.

func (*OrganizationsCustomConstraintsService)Deleteadded inv0.94.0

Delete: Deletes a custom constraint. Returns a `google.rpc.Status` with`google.rpc.Code.NOT_FOUND` if the constraint does not exist.

  • name: Name of the custom constraint to delete. See the custom constraintentry for naming rules.

func (*OrganizationsCustomConstraintsService)Getadded inv0.94.0

Get: Gets a custom or managed constraint. Returns a `google.rpc.Status` with`google.rpc.Code.NOT_FOUND` if the custom or managed constraint does notexist.

  • name: Resource name of the custom or managed constraint. See the customconstraint entry for naming requirements.

func (*OrganizationsCustomConstraintsService)Listadded inv0.94.0

List: Retrieves all of the custom constraints that exist on a particularorganization resource.

  • parent: The target Google Cloud resource that parents the set of customconstraints that will be returned from this call. Must be in one of thefollowing forms: * `organizations/{organization_id}`.

func (*OrganizationsCustomConstraintsService)Patchadded inv0.61.0

Patch: Updates a custom constraint. Returns a `google.rpc.Status` with`google.rpc.Code.NOT_FOUND` if the constraint does not exist. Note: thesupplied policy will perform a full overwrite of all fields.

  • name: Immutable. Name of the constraint. This is unique within theorganization. Format of the name should be *`organizations/{organization_id}/customConstraints/{custom_constraint_id}`Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`The max length is 70 characters and the minimum length is 1. Note that theprefix `organizations/{organization_id}/customConstraints/` is notcounted.

typeOrganizationsPoliciesCreateCall

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

func (*OrganizationsPoliciesCreateCall)Context

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

func (*OrganizationsPoliciesCreateCall)Do

Do executes the "orgpolicy.organizations.policies.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2Policy.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*OrganizationsPoliciesCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrganizationsPoliciesCreateCall)Header

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

typeOrganizationsPoliciesDeleteCall

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

func (*OrganizationsPoliciesDeleteCall)Context

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

func (*OrganizationsPoliciesDeleteCall)Do

Do executes the "orgpolicy.organizations.policies.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*OrganizationsPoliciesDeleteCall)Etagadded inv0.154.0

Etag sets the optional parameter "etag": The current etag of policy. If anetag is provided and does not match the current etag of the policy, deletionwill be blocked and an ABORTED error will be returned.

func (*OrganizationsPoliciesDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrganizationsPoliciesDeleteCall)Header

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

typeOrganizationsPoliciesGetCall

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

func (*OrganizationsPoliciesGetCall)Context

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

func (*OrganizationsPoliciesGetCall)Do

Do executes the "orgpolicy.organizations.policies.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2Policy.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*OrganizationsPoliciesGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrganizationsPoliciesGetCall)Header

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

func (*OrganizationsPoliciesGetCall)IfNoneMatch

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

typeOrganizationsPoliciesGetEffectivePolicyCall

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

func (*OrganizationsPoliciesGetEffectivePolicyCall)Context

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

func (*OrganizationsPoliciesGetEffectivePolicyCall)Do

Do executes the "orgpolicy.organizations.policies.getEffectivePolicy" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2Policy.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*OrganizationsPoliciesGetEffectivePolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrganizationsPoliciesGetEffectivePolicyCall)Header

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

func (*OrganizationsPoliciesGetEffectivePolicyCall)IfNoneMatch

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

typeOrganizationsPoliciesListCall

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

func (*OrganizationsPoliciesListCall)Context

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

func (*OrganizationsPoliciesListCall)Do

Do executes the "orgpolicy.organizations.policies.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2ListPoliciesResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*OrganizationsPoliciesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrganizationsPoliciesListCall)Header

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

func (*OrganizationsPoliciesListCall)IfNoneMatch

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

func (*OrganizationsPoliciesListCall)PageSize

PageSize sets the optional parameter "pageSize": Size of the pages to bereturned. This is currently unsupported and will be ignored. The server mayat any point start using this field to limit page size.

func (*OrganizationsPoliciesListCall)PageToken

PageToken sets the optional parameter "pageToken": Page token used toretrieve the next page. This is currently unsupported and will be ignored.The server may at any point start using this field.

func (*OrganizationsPoliciesListCall)Pages

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

typeOrganizationsPoliciesPatchCall

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

func (*OrganizationsPoliciesPatchCall)Context

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

func (*OrganizationsPoliciesPatchCall)Do

Do executes the "orgpolicy.organizations.policies.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2Policy.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*OrganizationsPoliciesPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*OrganizationsPoliciesPatchCall)Header

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

func (*OrganizationsPoliciesPatchCall)UpdateMaskadded inv0.108.0

UpdateMask sets the optional parameter "updateMask": Field mask used tospecify the fields to be overwritten in the policy by the set. The fieldsspecified in the update_mask are relative to the policy, not the fullrequest.

typeOrganizationsPoliciesService

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

funcNewOrganizationsPoliciesService

func NewOrganizationsPoliciesService(s *Service) *OrganizationsPoliciesService

func (*OrganizationsPoliciesService)Create

Create: Creates a policy. Returns a `google.rpc.Status` with`google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a`google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policyalready exists on the given Google Cloud resource.

  • parent: The Google Cloud resource that will parent the new policy. Must bein one of the following forms: * `projects/{project_number}` *`projects/{project_id}` * `folders/{folder_id}` *`organizations/{organization_id}`.

func (*OrganizationsPoliciesService)Delete

Delete: Deletes a policy. Returns a `google.rpc.Status` with`google.rpc.Code.NOT_FOUND` if the constraint or organization policy doesnot exist.

- name: Name of the policy to delete. See the policy entry for naming rules.

func (*OrganizationsPoliciesService)Get

Get: Gets a policy on a resource. If no policy is set on the resource,`NOT_FOUND` is returned. The `etag` value can be used with `UpdatePolicy()`to update a policy during read-modify-write.

- name: Resource name of the policy. See Policy for naming requirements.

func (*OrganizationsPoliciesService)GetEffectivePolicy

GetEffectivePolicy: Gets the effective policy on a resource. This is theresult of merging policies in the resource hierarchy and evaluatingconditions. The returned policy will not have an `etag` or `condition` setbecause it is an evaluated policy across multiple resources. Subtrees ofResource Manager resource hierarchy with 'under:' prefix will not beexpanded.

- name: The effective policy to compute. See Policy for naming requirements.

func (*OrganizationsPoliciesService)List

List: Retrieves all of the policies that exist on a particular resource.

  • parent: The target Google Cloud resource that parents the set ofconstraints and policies that will be returned from this call. Must be inone of the following forms: * `projects/{project_number}` *`projects/{project_id}` * `folders/{folder_id}` *`organizations/{organization_id}`.

func (*OrganizationsPoliciesService)Patch

Patch: Updates a policy. Returns a `google.rpc.Status` with`google.rpc.Code.NOT_FOUND` if the constraint or the policy do not exist.Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etagsupplied in the request does not match the persisted etag of the policyNote: the supplied policy will perform a full overwrite of all fields.

  • name: Immutable. The resource name of the policy. Must be one of thefollowing forms, where `constraint_name` is the name of the constraintwhich this policy configures: *`projects/{project_number}/policies/{constraint_name}` *`folders/{folder_id}/policies/{constraint_name}` *`organizations/{organization_id}/policies/{constraint_name}` For example,`projects/123/policies/compute.disableSerialPortAccess`. Note:`projects/{project_id}/policies/{constraint_name}` is also an acceptablename for API requests, but responses will return the name using theequivalent project number.

typeOrganizationsService

type OrganizationsService struct {Constraints *OrganizationsConstraintsServiceCustomConstraints *OrganizationsCustomConstraintsServicePolicies *OrganizationsPoliciesService// contains filtered or unexported fields}

funcNewOrganizationsService

func NewOrganizationsService(s *Service) *OrganizationsService

typeProjectsConstraintsListCall

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

func (*ProjectsConstraintsListCall)Context

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

func (*ProjectsConstraintsListCall)Do

Do executes the "orgpolicy.projects.constraints.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2ListConstraintsResponse.ServerResponse.Header or (ifa response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsConstraintsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsConstraintsListCall)Header

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

func (*ProjectsConstraintsListCall)IfNoneMatch

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

func (*ProjectsConstraintsListCall)PageSize

PageSize sets the optional parameter "pageSize": Size of the pages to bereturned. This is currently unsupported and will be ignored. The server mayat any point start using this field to limit page size.

func (*ProjectsConstraintsListCall)PageToken

PageToken sets the optional parameter "pageToken": Page token used toretrieve the next page. This is currently unsupported and will be ignored.The server may at any point start using this field.

func (*ProjectsConstraintsListCall)Pages

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

typeProjectsConstraintsService

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

funcNewProjectsConstraintsService

func NewProjectsConstraintsService(s *Service) *ProjectsConstraintsService

func (*ProjectsConstraintsService)List

List: Lists constraints that could be applied on the specified resource.

  • parent: The Google Cloud resource that parents the constraint. Must be inone of the following forms: * `projects/{project_number}` *`projects/{project_id}` * `folders/{folder_id}` *`organizations/{organization_id}`.

typeProjectsPoliciesCreateCall

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

func (*ProjectsPoliciesCreateCall)Context

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

func (*ProjectsPoliciesCreateCall)Do

Do executes the "orgpolicy.projects.policies.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2Policy.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsPoliciesCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsPoliciesCreateCall)Header

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

typeProjectsPoliciesDeleteCall

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

func (*ProjectsPoliciesDeleteCall)Context

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

func (*ProjectsPoliciesDeleteCall)Do

Do executes the "orgpolicy.projects.policies.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsPoliciesDeleteCall)Etagadded inv0.154.0

Etag sets the optional parameter "etag": The current etag of policy. If anetag is provided and does not match the current etag of the policy, deletionwill be blocked and an ABORTED error will be returned.

func (*ProjectsPoliciesDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsPoliciesDeleteCall)Header

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

typeProjectsPoliciesGetCall

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

func (*ProjectsPoliciesGetCall)Context

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

func (*ProjectsPoliciesGetCall)Do

Do executes the "orgpolicy.projects.policies.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2Policy.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsPoliciesGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsPoliciesGetCall)Header

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

func (*ProjectsPoliciesGetCall)IfNoneMatch

func (c *ProjectsPoliciesGetCall) IfNoneMatch(entityTagstring) *ProjectsPoliciesGetCall

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

typeProjectsPoliciesGetEffectivePolicyCall

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

func (*ProjectsPoliciesGetEffectivePolicyCall)Context

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

func (*ProjectsPoliciesGetEffectivePolicyCall)Do

Do executes the "orgpolicy.projects.policies.getEffectivePolicy" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2Policy.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsPoliciesGetEffectivePolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsPoliciesGetEffectivePolicyCall)Header

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

func (*ProjectsPoliciesGetEffectivePolicyCall)IfNoneMatch

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

typeProjectsPoliciesListCall

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

func (*ProjectsPoliciesListCall)Context

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

func (*ProjectsPoliciesListCall)Do

Do executes the "orgpolicy.projects.policies.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2ListPoliciesResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsPoliciesListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsPoliciesListCall)Header

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

func (*ProjectsPoliciesListCall)IfNoneMatch

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

func (*ProjectsPoliciesListCall)PageSize

PageSize sets the optional parameter "pageSize": Size of the pages to bereturned. This is currently unsupported and will be ignored. The server mayat any point start using this field to limit page size.

func (*ProjectsPoliciesListCall)PageToken

PageToken sets the optional parameter "pageToken": Page token used toretrieve the next page. This is currently unsupported and will be ignored.The server may at any point start using this field.

func (*ProjectsPoliciesListCall)Pages

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

typeProjectsPoliciesPatchCall

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

func (*ProjectsPoliciesPatchCall)Context

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

func (*ProjectsPoliciesPatchCall)Do

Do executes the "orgpolicy.projects.policies.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudOrgpolicyV2Policy.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsPoliciesPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsPoliciesPatchCall)Header

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

func (*ProjectsPoliciesPatchCall)UpdateMaskadded inv0.108.0

UpdateMask sets the optional parameter "updateMask": Field mask used tospecify the fields to be overwritten in the policy by the set. The fieldsspecified in the update_mask are relative to the policy, not the fullrequest.

typeProjectsPoliciesService

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

funcNewProjectsPoliciesService

func NewProjectsPoliciesService(s *Service) *ProjectsPoliciesService

func (*ProjectsPoliciesService)Create

func (r *ProjectsPoliciesService) Create(parentstring, googlecloudorgpolicyv2policy *GoogleCloudOrgpolicyV2Policy) *ProjectsPoliciesCreateCall

Create: Creates a policy. Returns a `google.rpc.Status` with`google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a`google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policyalready exists on the given Google Cloud resource.

  • parent: The Google Cloud resource that will parent the new policy. Must bein one of the following forms: * `projects/{project_number}` *`projects/{project_id}` * `folders/{folder_id}` *`organizations/{organization_id}`.

func (*ProjectsPoliciesService)Delete

Delete: Deletes a policy. Returns a `google.rpc.Status` with`google.rpc.Code.NOT_FOUND` if the constraint or organization policy doesnot exist.

- name: Name of the policy to delete. See the policy entry for naming rules.

func (*ProjectsPoliciesService)Get

Get: Gets a policy on a resource. If no policy is set on the resource,`NOT_FOUND` is returned. The `etag` value can be used with `UpdatePolicy()`to update a policy during read-modify-write.

- name: Resource name of the policy. See Policy for naming requirements.

func (*ProjectsPoliciesService)GetEffectivePolicy

GetEffectivePolicy: Gets the effective policy on a resource. This is theresult of merging policies in the resource hierarchy and evaluatingconditions. The returned policy will not have an `etag` or `condition` setbecause it is an evaluated policy across multiple resources. Subtrees ofResource Manager resource hierarchy with 'under:' prefix will not beexpanded.

- name: The effective policy to compute. See Policy for naming requirements.

func (*ProjectsPoliciesService)List

List: Retrieves all of the policies that exist on a particular resource.

  • parent: The target Google Cloud resource that parents the set ofconstraints and policies that will be returned from this call. Must be inone of the following forms: * `projects/{project_number}` *`projects/{project_id}` * `folders/{folder_id}` *`organizations/{organization_id}`.

func (*ProjectsPoliciesService)Patch

func (r *ProjectsPoliciesService) Patch(namestring, googlecloudorgpolicyv2policy *GoogleCloudOrgpolicyV2Policy) *ProjectsPoliciesPatchCall

Patch: Updates a policy. Returns a `google.rpc.Status` with`google.rpc.Code.NOT_FOUND` if the constraint or the policy do not exist.Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etagsupplied in the request does not match the persisted etag of the policyNote: the supplied policy will perform a full overwrite of all fields.

  • name: Immutable. The resource name of the policy. Must be one of thefollowing forms, where `constraint_name` is the name of the constraintwhich this policy configures: *`projects/{project_number}/policies/{constraint_name}` *`folders/{folder_id}/policies/{constraint_name}` *`organizations/{organization_id}/policies/{constraint_name}` For example,`projects/123/policies/compute.disableSerialPortAccess`. Note:`projects/{project_id}/policies/{constraint_name}` is also an acceptablename for API requests, but responses will return the name using theequivalent project number.

typeProjectsService

type ProjectsService struct {Constraints *ProjectsConstraintsServicePolicies *ProjectsPoliciesService// contains filtered or unexported fields}

funcNewProjectsService

func NewProjectsService(s *Service) *ProjectsService

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentFolders *FoldersServiceOrganizations *OrganizationsServiceProjects *ProjectsService// contains filtered or unexported fields}

funcNewdeprecated

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.

funcNewService

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

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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

[8]ページ先頭

©2009-2025 Movatter.jp