orgpolicy

package
Version: v0.48.0 Latest Latest
Warning

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

Go to latest
Published: Jun 7, 2021 License: BSD-3-Clause Imports: 15 Imported by: 0

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

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 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 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 OAuth flow), use option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// See, edit, configure, and delete your Google Cloud Platform data
	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 FoldersConstraintsListCall

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

func (*FoldersConstraintsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersConstraintsListCall) Do

Do executes the "orgpolicy.folders.constraints.list" call. Exactly one of *GoogleCloudOrgpolicyV2ListConstraintsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2ListConstraintsResponse.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 (*FoldersConstraintsListCall) Fields

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

func (*FoldersConstraintsListCall) Header

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

func (*FoldersConstraintsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*FoldersConstraintsListCall) PageSize

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

func (*FoldersConstraintsListCall) PageToken

PageToken sets the optional parameter "pageToken": Page token used to retrieve 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.

type FoldersConstraintsService

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

func NewFoldersConstraintsService

func NewFoldersConstraintsService(s *Service) *FoldersConstraintsService

func (*FoldersConstraintsService) List

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

- parent: The Cloud resource that parents the constraint. Must be in

one of the following forms: * `projects/{project_number}` *
`projects/{project_id}` * `folders/{folder_id}` *
`organizations/{organization_id}`.

type FoldersPoliciesCreateCall

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

func (*FoldersPoliciesCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersPoliciesCreateCall) Do

Do executes the "orgpolicy.folders.policies.create" call. Exactly one of *GoogleCloudOrgpolicyV2Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2Policy.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 (*FoldersPoliciesCreateCall) Fields

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

func (*FoldersPoliciesCreateCall) Header

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

type FoldersPoliciesDeleteCall

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

func (*FoldersPoliciesDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersPoliciesDeleteCall) Do

Do executes the "orgpolicy.folders.policies.delete" call. Exactly one of *GoogleProtobufEmpty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.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 (*FoldersPoliciesDeleteCall) Fields

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

func (*FoldersPoliciesDeleteCall) Header

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

type FoldersPoliciesGetCall

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

func (*FoldersPoliciesGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersPoliciesGetCall) Do

Do executes the "orgpolicy.folders.policies.get" call. Exactly one of *GoogleCloudOrgpolicyV2Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2Policy.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 (*FoldersPoliciesGetCall) Fields

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

func (*FoldersPoliciesGetCall) Header

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

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

func (*FoldersPoliciesGetCall) IfNoneMatch

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type FoldersPoliciesGetEffectivePolicyCall

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

func (*FoldersPoliciesGetEffectivePolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersPoliciesGetEffectivePolicyCall) Do

Do executes the "orgpolicy.folders.policies.getEffectivePolicy" call. Exactly one of *GoogleCloudOrgpolicyV2Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2Policy.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 (*FoldersPoliciesGetEffectivePolicyCall) Fields

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

func (*FoldersPoliciesGetEffectivePolicyCall) Header

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

func (*FoldersPoliciesGetEffectivePolicyCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type FoldersPoliciesListCall

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

func (*FoldersPoliciesListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersPoliciesListCall) Do

Do executes the "orgpolicy.folders.policies.list" call. Exactly one of *GoogleCloudOrgpolicyV2ListPoliciesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2ListPoliciesResponse.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 (*FoldersPoliciesListCall) Fields

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

func (*FoldersPoliciesListCall) Header

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

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

func (*FoldersPoliciesListCall) IfNoneMatch

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*FoldersPoliciesListCall) PageSize

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

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

func (*FoldersPoliciesListCall) PageToken

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

PageToken sets the optional parameter "pageToken": Page token used to retrieve 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.

type FoldersPoliciesPatchCall

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

func (*FoldersPoliciesPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersPoliciesPatchCall) Do

Do executes the "orgpolicy.folders.policies.patch" call. Exactly one of *GoogleCloudOrgpolicyV2Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2Policy.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 (*FoldersPoliciesPatchCall) Fields

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

func (*FoldersPoliciesPatchCall) Header

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

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

type FoldersPoliciesService

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

func NewFoldersPoliciesService

func NewFoldersPoliciesService(s *Service) *FoldersPoliciesService

func (*FoldersPoliciesService) Create

func (r *FoldersPoliciesService) Create(parent string, 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 policy already exists on the given Cloud resource.

- parent: The Cloud resource that will parent the new Policy. Must be

in 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 Org Policy does not exist.

- name: Name of the policy to delete. See `Policy` 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 the result of merging `Policies` in the resource hierarchy and evaluating conditions. The returned `Policy` will not have an `etag` or `condition` set because it is a computed `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.

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

rules.

func (*FoldersPoliciesService) List

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

- parent: The target Cloud resource that parents the set of

constraints and policies that will be returned from this call. Must
be in one of the following forms: * `projects/{project_number}` *
`projects/{project_id}` * `folders/{folder_id}` *
`organizations/{organization_id}`.

func (*FoldersPoliciesService) Patch

func (r *FoldersPoliciesService) Patch(name string, 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 etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields.

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

type FoldersService

type FoldersService struct {
	Constraints *FoldersConstraintsService

	Policies *FoldersPoliciesService
	// contains filtered or unexported fields
}

func NewFoldersService

func NewFoldersService(s *Service) *FoldersService

type GoogleCloudOrgpolicyV2Constraint

type GoogleCloudOrgpolicyV2Constraint struct {
	// BooleanConstraint: Defines this constraint as being a
	// BooleanConstraint.
	BooleanConstraint *GoogleCloudOrgpolicyV2ConstraintBooleanConstraint `json:"booleanConstraint,omitempty"`

	// ConstraintDefault: The evaluation behavior of this constraint in the
	// absence of 'Policy'.
	//
	// Possible values:
	//   "CONSTRAINT_DEFAULT_UNSPECIFIED" - This is only used for
	// distinguishing unset values and should never be used.
	//   "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.
	ConstraintDefault string `json:"constraintDefault,omitempty"`

	// Description: Detailed description of what this `Constraint` controls
	// as well as how and where it is enforced. Mutable.
	Description string `json:"description,omitempty"`

	// DisplayName: The human readable name. Mutable.
	DisplayName string `json:"displayName,omitempty"`

	// ListConstraint: Defines this constraint as being a ListConstraint.
	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".
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BooleanConstraint")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GoogleCloudOrgpolicyV2Constraint: A `constraint` describes a way to restrict resource's configuration. For example, you could enforce a constraint that controls which cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. `Constraints` can be configured by the organization's policy adminstrator to fit the needs of the organzation by setting a `policy` that includes `constraints` at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules please read about `policies`. `Constraints` have a default behavior determined by the `constraint_default` field, which is the enforcement behavior that is used in the absence of a `policy` being defined or inherited for the resource in question.

func (*GoogleCloudOrgpolicyV2Constraint) MarshalJSON

func (s *GoogleCloudOrgpolicyV2Constraint) MarshalJSON() ([]byte, error)

type GoogleCloudOrgpolicyV2ConstraintBooleanConstraint

type GoogleCloudOrgpolicyV2ConstraintBooleanConstraint struct {
}

GoogleCloudOrgpolicyV2ConstraintBooleanConstraint: A `Constraint` that is either enforced or not. For example a constraint `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM instance, serial port connections will not be opened to that instance.

type GoogleCloudOrgpolicyV2ConstraintListConstraint

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.
	SupportsIn bool `json:"supportsIn,omitempty"`

	// SupportsUnder: Indicates whether subtrees of Cloud 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.
	SupportsUnder bool `json:"supportsUnder,omitempty"`

	// ForceSendFields is a list of field names (e.g. "SupportsIn") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudOrgpolicyV2ConstraintListConstraint: A `Constraint` that allows or disallows a list of string values, which are configured by an Organization's policy administrator with a `Policy`.

func (*GoogleCloudOrgpolicyV2ConstraintListConstraint) MarshalJSON

type GoogleCloudOrgpolicyV2ListConstraintsResponse

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.
	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. "Constraints") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudOrgpolicyV2ListConstraintsResponse: The response returned from the ListConstraints method.

func (*GoogleCloudOrgpolicyV2ListConstraintsResponse) MarshalJSON

type GoogleCloudOrgpolicyV2ListPoliciesResponse

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.
	NextPageToken string `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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudOrgpolicyV2ListPoliciesResponse: The response returned from the ListPolicies method. It will be empty if no `Policies` are set on the resource.

func (*GoogleCloudOrgpolicyV2ListPoliciesResponse) MarshalJSON

type GoogleCloudOrgpolicyV2Policy

type GoogleCloudOrgpolicyV2Policy struct {
	// 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.
	Name string `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. "Name") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Name") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudOrgpolicyV2Policy: Defines a Cloud Organization `Policy` which is used to specify `Constraints` for configurations of Cloud Platform resources.

func (*GoogleCloudOrgpolicyV2Policy) MarshalJSON

func (s *GoogleCloudOrgpolicyV2Policy) MarshalJSON() ([]byte, error)

type GoogleCloudOrgpolicyV2PolicySpec

type GoogleCloudOrgpolicyV2PolicySpec struct {
	// Etag: An opaque tag indicating the current version of the `Policy`,
	// 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 `Policy` to use when executing a
	// read-modify-write loop. When the `Policy` is returned from a
	// `GetEffectivePolicy` request, the `etag` will be unset.
	Etag string `json:"etag,omitempty"`

	// InheritFromParent: Determines the inheritance behavior for this
	// `Policy`. If `inherit_from_parent` is true, PolicyRules 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.
	InheritFromParent bool `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.
	Reset bool `json:"reset,omitempty"`

	// Rules: Up to 10 PolicyRules are allowed. In Policies for boolean
	// constraints, the following requirements apply: - There must be one
	// and only one PolicyRule where condition is unset. -
	// BooleanPolicyRules with conditions must set `enforced` to the
	// opposite of the PolicyRule without a condition. - During policy
	// evaluation, PolicyRules 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`.
	UpdateTime string `json:"updateTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Etag") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudOrgpolicyV2PolicySpec: Defines a Cloud Organization `PolicySpec` which is used to specify `Constraints` for configurations of Cloud Platform resources.

func (*GoogleCloudOrgpolicyV2PolicySpec) MarshalJSON

func (s *GoogleCloudOrgpolicyV2PolicySpec) MarshalJSON() ([]byte, error)

type GoogleCloudOrgpolicyV2PolicySpecPolicyRule

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.
	AllowAll bool `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.
	DenyAll bool `json:"denyAll,omitempty"`

	// Enforce: If `true`, then the `Policy` is enforced. If `false`, then
	// any configuration is acceptable. This field can be set only in
	// Policies for boolean constraints.
	Enforce bool `json:"enforce,omitempty"`

	// Values: List of values to be used for this PolicyRule. 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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudOrgpolicyV2PolicySpecPolicyRule: A rule used to express this policy.

func (*GoogleCloudOrgpolicyV2PolicySpecPolicyRule) MarshalJSON

type GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues

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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues) MarshalJSON

type GoogleProtobufEmpty

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 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); } The JSON representation for `Empty` is empty JSON object `{}`.

type GoogleTypeExpr

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.
	Description string `json:"description,omitempty"`

	// Expression: Textual representation of an expression in Common
	// Expression Language syntax.
	Expression string `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.
	Location string `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.
	Title string `json:"title,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleTypeExpr: Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if 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 message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

func (*GoogleTypeExpr) MarshalJSON

func (s *GoogleTypeExpr) MarshalJSON() ([]byte, error)

type OrganizationsConstraintsListCall

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

func (*OrganizationsConstraintsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsConstraintsListCall) Do

Do executes the "orgpolicy.organizations.constraints.list" call. Exactly one of *GoogleCloudOrgpolicyV2ListConstraintsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2ListConstraintsResponse.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 (*OrganizationsConstraintsListCall) Fields

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

func (*OrganizationsConstraintsListCall) Header

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

func (*OrganizationsConstraintsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*OrganizationsConstraintsListCall) PageSize

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

func (*OrganizationsConstraintsListCall) PageToken

PageToken sets the optional parameter "pageToken": Page token used to retrieve 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.

type OrganizationsConstraintsService

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

func NewOrganizationsConstraintsService

func NewOrganizationsConstraintsService(s *Service) *OrganizationsConstraintsService

func (*OrganizationsConstraintsService) List

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

- parent: The Cloud resource that parents the constraint. Must be in

one of the following forms: * `projects/{project_number}` *
`projects/{project_id}` * `folders/{folder_id}` *
`organizations/{organization_id}`.

type OrganizationsPoliciesCreateCall

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

func (*OrganizationsPoliciesCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsPoliciesCreateCall) Do

Do executes the "orgpolicy.organizations.policies.create" call. Exactly one of *GoogleCloudOrgpolicyV2Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2Policy.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 (*OrganizationsPoliciesCreateCall) Fields

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

func (*OrganizationsPoliciesCreateCall) Header

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

type OrganizationsPoliciesDeleteCall

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

func (*OrganizationsPoliciesDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsPoliciesDeleteCall) Do

Do executes the "orgpolicy.organizations.policies.delete" call. Exactly one of *GoogleProtobufEmpty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.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 (*OrganizationsPoliciesDeleteCall) Fields

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

func (*OrganizationsPoliciesDeleteCall) Header

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

type OrganizationsPoliciesGetCall

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

func (*OrganizationsPoliciesGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsPoliciesGetCall) Do

Do executes the "orgpolicy.organizations.policies.get" call. Exactly one of *GoogleCloudOrgpolicyV2Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2Policy.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 (*OrganizationsPoliciesGetCall) Fields

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

func (*OrganizationsPoliciesGetCall) Header

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

func (*OrganizationsPoliciesGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type OrganizationsPoliciesGetEffectivePolicyCall

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

func (*OrganizationsPoliciesGetEffectivePolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsPoliciesGetEffectivePolicyCall) Do

Do executes the "orgpolicy.organizations.policies.getEffectivePolicy" call. Exactly one of *GoogleCloudOrgpolicyV2Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2Policy.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 (*OrganizationsPoliciesGetEffectivePolicyCall) Fields

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

func (*OrganizationsPoliciesGetEffectivePolicyCall) Header

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

func (*OrganizationsPoliciesGetEffectivePolicyCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type OrganizationsPoliciesListCall

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

func (*OrganizationsPoliciesListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsPoliciesListCall) Do

Do executes the "orgpolicy.organizations.policies.list" call. Exactly one of *GoogleCloudOrgpolicyV2ListPoliciesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2ListPoliciesResponse.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 (*OrganizationsPoliciesListCall) Fields

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

func (*OrganizationsPoliciesListCall) Header

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

func (*OrganizationsPoliciesListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*OrganizationsPoliciesListCall) PageSize

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

func (*OrganizationsPoliciesListCall) PageToken

PageToken sets the optional parameter "pageToken": Page token used to retrieve 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.

type OrganizationsPoliciesPatchCall

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

func (*OrganizationsPoliciesPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsPoliciesPatchCall) Do

Do executes the "orgpolicy.organizations.policies.patch" call. Exactly one of *GoogleCloudOrgpolicyV2Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2Policy.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 (*OrganizationsPoliciesPatchCall) Fields

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

func (*OrganizationsPoliciesPatchCall) Header

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

type OrganizationsPoliciesService

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

func NewOrganizationsPoliciesService

func NewOrganizationsPoliciesService(s *Service) *OrganizationsPoliciesService

func (*OrganizationsPoliciesService) Create

func (r *OrganizationsPoliciesService) Create(parent string, googlecloudorgpolicyv2policy *GoogleCloudOrgpolicyV2Policy) *OrganizationsPoliciesCreateCall

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 policy already exists on the given Cloud resource.

- parent: The Cloud resource that will parent the new Policy. Must be

in 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 Org Policy does not exist.

- name: Name of the policy to delete. See `Policy` 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 the result of merging `Policies` in the resource hierarchy and evaluating conditions. The returned `Policy` will not have an `etag` or `condition` set because it is a computed `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.

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

rules.

func (*OrganizationsPoliciesService) List

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

- parent: The target Cloud resource that parents the set of

constraints and policies that will be returned from this call. Must
be in one 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 etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields.

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

type OrganizationsService

type OrganizationsService struct {
	Constraints *OrganizationsConstraintsService

	Policies *OrganizationsPoliciesService
	// contains filtered or unexported fields
}

func NewOrganizationsService

func NewOrganizationsService(s *Service) *OrganizationsService

type ProjectsConstraintsListCall

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

func (*ProjectsConstraintsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsConstraintsListCall) Do

Do executes the "orgpolicy.projects.constraints.list" call. Exactly one of *GoogleCloudOrgpolicyV2ListConstraintsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2ListConstraintsResponse.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 (*ProjectsConstraintsListCall) Fields

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

func (*ProjectsConstraintsListCall) Header

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

func (*ProjectsConstraintsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsConstraintsListCall) PageSize

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

func (*ProjectsConstraintsListCall) PageToken

PageToken sets the optional parameter "pageToken": Page token used to retrieve 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.

type ProjectsConstraintsService

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

func NewProjectsConstraintsService

func NewProjectsConstraintsService(s *Service) *ProjectsConstraintsService

func (*ProjectsConstraintsService) List

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

- parent: The Cloud resource that parents the constraint. Must be in

one of the following forms: * `projects/{project_number}` *
`projects/{project_id}` * `folders/{folder_id}` *
`organizations/{organization_id}`.

type ProjectsPoliciesCreateCall

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

func (*ProjectsPoliciesCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsPoliciesCreateCall) Do

Do executes the "orgpolicy.projects.policies.create" call. Exactly one of *GoogleCloudOrgpolicyV2Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2Policy.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 (*ProjectsPoliciesCreateCall) Fields

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

func (*ProjectsPoliciesCreateCall) Header

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

type ProjectsPoliciesDeleteCall

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

func (*ProjectsPoliciesDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsPoliciesDeleteCall) Do

Do executes the "orgpolicy.projects.policies.delete" call. Exactly one of *GoogleProtobufEmpty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.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 (*ProjectsPoliciesDeleteCall) Fields

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

func (*ProjectsPoliciesDeleteCall) Header

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

type ProjectsPoliciesGetCall

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

func (*ProjectsPoliciesGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsPoliciesGetCall) Do

Do executes the "orgpolicy.projects.policies.get" call. Exactly one of *GoogleCloudOrgpolicyV2Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2Policy.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 (*ProjectsPoliciesGetCall) Fields

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

func (*ProjectsPoliciesGetCall) Header

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

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

func (*ProjectsPoliciesGetCall) IfNoneMatch

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsPoliciesGetEffectivePolicyCall

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

func (*ProjectsPoliciesGetEffectivePolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsPoliciesGetEffectivePolicyCall) Do

Do executes the "orgpolicy.projects.policies.getEffectivePolicy" call. Exactly one of *GoogleCloudOrgpolicyV2Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2Policy.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 (*ProjectsPoliciesGetEffectivePolicyCall) Fields

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

func (*ProjectsPoliciesGetEffectivePolicyCall) Header

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

func (*ProjectsPoliciesGetEffectivePolicyCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsPoliciesListCall

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

func (*ProjectsPoliciesListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsPoliciesListCall) Do

Do executes the "orgpolicy.projects.policies.list" call. Exactly one of *GoogleCloudOrgpolicyV2ListPoliciesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2ListPoliciesResponse.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 (*ProjectsPoliciesListCall) Fields

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

func (*ProjectsPoliciesListCall) Header

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

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

func (*ProjectsPoliciesListCall) IfNoneMatch

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsPoliciesListCall) PageSize

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

func (*ProjectsPoliciesListCall) PageToken

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

PageToken sets the optional parameter "pageToken": Page token used to retrieve 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.

type ProjectsPoliciesPatchCall

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

func (*ProjectsPoliciesPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsPoliciesPatchCall) Do

Do executes the "orgpolicy.projects.policies.patch" call. Exactly one of *GoogleCloudOrgpolicyV2Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudOrgpolicyV2Policy.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 (*ProjectsPoliciesPatchCall) Fields

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

func (*ProjectsPoliciesPatchCall) Header

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

type ProjectsPoliciesService

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

func NewProjectsPoliciesService

func NewProjectsPoliciesService(s *Service) *ProjectsPoliciesService

func (*ProjectsPoliciesService) Create

func (r *ProjectsPoliciesService) Create(parent string, 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 policy already exists on the given Cloud resource.

- parent: The Cloud resource that will parent the new Policy. Must be

in 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 Org Policy does not exist.

- name: Name of the policy to delete. See `Policy` 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 the result of merging `Policies` in the resource hierarchy and evaluating conditions. The returned `Policy` will not have an `etag` or `condition` set because it is a computed `Policy` across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.

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

rules.

func (*ProjectsPoliciesService) List

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

- parent: The target Cloud resource that parents the set of

constraints and policies that will be returned from this call. Must
be in one of the following forms: * `projects/{project_number}` *
`projects/{project_id}` * `folders/{folder_id}` *
`organizations/{organization_id}`.

func (*ProjectsPoliciesService) Patch

func (r *ProjectsPoliciesService) Patch(name string, 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 etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields.

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

type ProjectsService

type ProjectsService struct {
	Constraints *ProjectsConstraintsService

	Policies *ProjectsPoliciesService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

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

This function has been 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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto