Movatterモバイル変換


[0]ホーム

URL:


cloudresourcemanager

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:712

Details

Repository

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

Links

Documentation

Overview

Package cloudresourcemanager provides access to the Cloud Resource Manager API.

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

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/cloudresourcemanager/v1"...ctx := context.Background()cloudresourcemanagerService, err := cloudresourcemanager.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

By default, all available scopes (see "Constants") are used to authenticate.To restrict scopes, usegoogle.golang.org/api/option.WithScopes:

cloudresourcemanagerService, err := cloudresourcemanager.NewService(ctx, option.WithScopes(cloudresourcemanager.CloudPlatformReadOnlyScope))

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

cloudresourcemanagerService, err := cloudresourcemanager.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, ...)cloudresourcemanagerService, err := cloudresourcemanager.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"// View your data across Google Cloud services and see the email address of// your Google AccountCloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeAncestor

type Ancestor struct {// ResourceId: Resource id of the ancestor.ResourceId *ResourceId `json:"resourceId,omitempty"`// ForceSendFields is a list of field names (e.g. "ResourceId") 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. "ResourceId") 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:"-"`}

Ancestor: Identifying information for a single ancestor of a project.

func (Ancestor)MarshalJSON

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

typeAuditConfig

type AuditConfig struct {// AuditLogConfigs: The configuration for logging of each type of permission.AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`// Service: Specifies a service that will be enabled for audit logging. For// example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices`// is a special value that covers all services.Servicestring `json:"service,omitempty"`// ForceSendFields is a list of field names (e.g. "AuditLogConfigs") 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. "AuditLogConfigs") 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:"-"`}

AuditConfig: Specifies the audit configuration for a service. Theconfiguration determines which permission types are logged, and whatidentities, if any, are exempted from logging. An AuditConfig must have oneor more AuditLogConfigs. If there are AuditConfigs for both `allServices`and a specific service, the union of the two AuditConfigs is used for thatservice: the log_types specified in each AuditConfig are enabled, and theexempted_members in each AuditLogConfig are exempted. Example Policy withmultiple AuditConfigs: { "audit_configs": [ { "service": "allServices","audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": ["user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type":"ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com","audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type":"DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } Forsampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READlogging. It also exempts `jose@example.com` from DATA_READ logging, and`aliya@example.com` from DATA_WRITE logging.

func (AuditConfig)MarshalJSON

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

typeAuditLogConfig

type AuditLogConfig struct {// ExemptedMembers: Specifies the identities that do not cause logging for this// type of permission. Follows the same format of Binding.members.ExemptedMembers []string `json:"exemptedMembers,omitempty"`// LogType: The log type that this config enables.//// Possible values://   "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.//   "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy//   "DATA_WRITE" - Data writes. Example: CloudSQL Users create//   "DATA_READ" - Data reads. Example: CloudSQL Users listLogTypestring `json:"logType,omitempty"`// ForceSendFields is a list of field names (e.g. "ExemptedMembers") 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. "ExemptedMembers") 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:"-"`}

AuditLogConfig: Provides the configuration for logging a type ofpermissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ","exempted_members": [ "user:jose@example.com" ] }, { "log_type":"DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, whileexempting jose@example.com from DATA_READ logging.

func (AuditLogConfig)MarshalJSON

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

typeBinding

type Binding struct {// Condition: The condition that is associated with this binding. If the// condition evaluates to `true`, then this binding applies to the current// request. If the condition evaluates to `false`, then this binding does not// apply to the current request. However, a different role binding might grant// the same role to one or more of the principals in this binding. To learn// which resources support conditions in their IAM policies, see the IAM// documentation// (https://cloud.google.com/iam/help/conditions/resource-policies).Condition *Expr `json:"condition,omitempty"`// Members: Specifies the principals requesting access for a Google Cloud// resource. `members` can have the following values: * `allUsers`: A special// identifier that represents anyone who is on the internet; with or without a// Google account. * `allAuthenticatedUsers`: A special identifier that// represents anyone who is authenticated with a Google account or a service// account. Does not include identities that come from external identity// providers (IdPs) through identity federation. * `user:{emailid}`: An email// address that represents a specific Google account. For example,// `alice@example.com` . * `serviceAccount:{emailid}`: An email address that// represents a Google service account. For example,// `my-other-app@appspot.gserviceaccount.com`. *// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An// identifier for a Kubernetes service account// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *// `group:{emailid}`: An email address that represents a Google group. For// example, `admins@example.com`. * `domain:{domain}`: The G Suite domain// (primary) that represents all the users of that domain. For example,// `google.com` or `example.com`. *// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/sub// ject/{subject_attribute_value}`: A single identity in a workforce identity// pool. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// group/{group_id}`: All workforce identities in a group. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// attribute.{attribute_name}/{attribute_value}`: All workforce identities with// a specific attribute value. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// *`: All identities in a workforce identity pool. *// `principal://iam.googleapis.com/projects/{project_number}/locations/global/wo// rkloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single// identity in a workload identity pool. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool// group. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}// `: All identities in a workload identity pool with a certain attribute. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/*`: All identities in a workload identity// pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus// unique identifier) representing a user that has been recently deleted. For// example, `alice@example.com?uid=123456789012345678901`. If the user is// recovered, this value reverts to `user:{emailid}` and the recovered user// retains the role in the binding. *// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus// unique identifier) representing a service account that has been recently// deleted. For example,// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the// service account is undeleted, this value reverts to// `serviceAccount:{emailid}` and the undeleted service account retains the// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email// address (plus unique identifier) representing a Google group that has been// recently deleted. For example,// `admins@example.com?uid=123456789012345678901`. If the group is recovered,// this value reverts to `group:{emailid}` and the recovered group retains the// role in the binding. *// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool// _id}/subject/{subject_attribute_value}`: Deleted single identity in a// workforce identity pool. For example,// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-po// ol-id/subject/my-subject-attribute-value`.Members []string `json:"members,omitempty"`// Role: Role that is assigned to the list of `members`, or principals. For// example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview// of the IAM roles and permissions, see the IAM documentation// (https://cloud.google.com/iam/docs/roles-overview). For a list of the// available pre-defined roles, see here// (https://cloud.google.com/iam/docs/understanding-roles).Rolestring `json:"role,omitempty"`// ForceSendFields is a list of field names (e.g. "Condition") 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. "Condition") 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:"-"`}

Binding: Associates `members`, or principals, with a `role`.

func (Binding)MarshalJSON

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

typeBooleanConstraint

type BooleanConstraint struct {}

BooleanConstraint: A `Constraint` that is either enforced or not. Forexample a constraint `constraints/compute.disableSerialPortAccess`. If it isenforced on a VM instance, serial port connections will not be opened tothat instance.

typeBooleanPolicy

type BooleanPolicy struct {// Enforced: If `true`, then the `Policy` is enforced. If `false`, then any// configuration is acceptable. Suppose you have a `Constraint`// `constraints/compute.disableSerialPortAccess` with `constraint_default` set// to `ALLOW`. A `Policy` for that `Constraint` exhibits the following// behavior: - If the `Policy` at this resource has enforced set to `false`,// serial port connection attempts will be allowed. - If the `Policy` at this// resource has enforced set to `true`, serial port connection attempts will be// refused. - If the `Policy` at this resource is `RestoreDefault`, serial port// connection attempts will be allowed. - If no `Policy` is set at this// resource or anywhere higher in the resource hierarchy, serial port// connection attempts will be allowed. - If no `Policy` is set at this// resource, but one exists higher in the resource hierarchy, the behavior is// as if the`Policy` were set at this resource. The following examples// demonstrate the different possible layerings: Example 1 (nearest// `Constraint` wins): `organizations/foo` has a `Policy` with: {enforced:// false} `projects/bar` has no `Policy` set. The constraint at `projects/bar`// and `organizations/foo` will not be enforced. Example 2 (enforcement gets// replaced): `organizations/foo` has a `Policy` with: {enforced: false}// `projects/bar` has a `Policy` with: {enforced: true} The constraint at// `organizations/foo` is not enforced. The constraint at `projects/bar` is// enforced. Example 3 (RestoreDefault): `organizations/foo` has a `Policy`// with: {enforced: true} `projects/bar` has a `Policy` with: {RestoreDefault:// {}} The constraint at `organizations/foo` is enforced. The constraint at// `projects/bar` is not enforced, because `constraint_default` for the// `Constraint` is `ALLOW`.Enforcedbool `json:"enforced,omitempty"`// ForceSendFields is a list of field names (e.g. "Enforced") 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. "Enforced") 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:"-"`}

BooleanPolicy: Used in `policy_type` to specify how `boolean_policy` willbehave at this resource.

func (BooleanPolicy)MarshalJSON

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

typeClearOrgPolicyRequest

type ClearOrgPolicyRequest struct {// Constraint: Name of the `Constraint` of the `Policy` to clear.Constraintstring `json:"constraint,omitempty"`// Etag: The current version, for concurrency control. Not sending an `etag`// will cause the `Policy` to be cleared blindly.Etagstring `json:"etag,omitempty"`// ForceSendFields is a list of field names (e.g. "Constraint") 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. "Constraint") 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:"-"`}

ClearOrgPolicyRequest: The request sent to the ClearOrgPolicy method.

func (ClearOrgPolicyRequest)MarshalJSON

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

typeCloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperationadded inv0.35.0

type CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation struct {// DestinationParent: The resource name of the folder or organization we are// either creating the folder under or moving the folder to.DestinationParentstring `json:"destinationParent,omitempty"`// DisplayName: The display name of the folder.DisplayNamestring `json:"displayName,omitempty"`// OperationType: The type of this operation.//// Possible values://   "OPERATION_TYPE_UNSPECIFIED" - Operation type not specified.//   "CREATE" - A create folder operation.//   "MOVE" - A move folder operation.OperationTypestring `json:"operationType,omitempty"`// SourceParent: The resource name of the folder's parent. Only applicable when// the operation_type is MOVE.SourceParentstring `json:"sourceParent,omitempty"`// ForceSendFields is a list of field names (e.g. "DestinationParent") 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. "DestinationParent") 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:"-"`}

CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation:Metadata describing a long running folder operation

func (CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation)MarshalJSONadded inv0.35.0

typeCloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperationadded inv0.35.0

type CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation struct {// DestinationParent: The resource name of the folder or organization we are// either creating the folder under or moving the folder to.DestinationParentstring `json:"destinationParent,omitempty"`// DisplayName: The display name of the folder.DisplayNamestring `json:"displayName,omitempty"`// OperationType: The type of this operation.//// Possible values://   "OPERATION_TYPE_UNSPECIFIED" - Operation type not specified.//   "CREATE" - A create folder operation.//   "MOVE" - A move folder operation.OperationTypestring `json:"operationType,omitempty"`// SourceParent: The resource name of the folder's parent. Only applicable when// the operation_type is MOVE.SourceParentstring `json:"sourceParent,omitempty"`// ForceSendFields is a list of field names (e.g. "DestinationParent") 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. "DestinationParent") 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:"-"`}

CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation:Metadata describing a long running folder operation

func (CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation)MarshalJSONadded inv0.35.0

typeConstraint

type Constraint struct {// BooleanConstraint: Defines this constraint as being a BooleanConstraint.BooleanConstraint *BooleanConstraint `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.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"`// ListConstraint: Defines this constraint as being a ListConstraint.ListConstraint *ListConstraint `json:"listConstraint,omitempty"`// Name: Immutable value, required to globally be unique. For example,// `constraints/serviceuser.services`Namestring `json:"name,omitempty"`// Version: Version of the `Constraint`. Default version is 0;Versionint64 `json:"version,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:"-"`}

Constraint: A `Constraint` describes a way in which a resource'sconfiguration can be restricted. For example, it controls which cloudservices can be activated across an organization, or whether a ComputeEngine instance can have serial port connections established. `Constraints`can be configured by the organization's policy administrator to fit theneeds of the organzation by setting Policies for `Constraints` at differentlocations in the organization's resource hierarchy. Policies are inheriteddown the resource hierarchy from higher levels, but can also be overridden.For details about the inheritance rules please read about Policies(/resource-manager/reference/rest/v1/Policy). `Constraints` have a defaultbehavior determined by the `constraint_default` field, which is theenforcement behavior that is used in the absence of a `Policy` being definedor inherited for the resource in question.

func (Constraint)MarshalJSON

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

typeCreateFolderMetadataadded inv0.36.0

type CreateFolderMetadata struct {// DisplayName: The display name of the folder.DisplayNamestring `json:"displayName,omitempty"`// Parent: The resource name of the folder or organization we are creating the// folder under.Parentstring `json:"parent,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CreateFolderMetadata: Metadata pertaining to the Folder creation process.

func (CreateFolderMetadata)MarshalJSONadded inv0.36.0

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

typeCreateProjectMetadataadded inv0.36.0

type CreateProjectMetadata struct {// CreateTime: Creation time of the project creation workflow.CreateTimestring `json:"createTime,omitempty"`// Gettable: True if the project can be retrieved using `GetProject`. No other// operations on the project are guaranteed to work until the project creation// is complete.Gettablebool `json:"gettable,omitempty"`// Ready: True if the project creation process is complete.Readybool `json:"ready,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CreateProjectMetadata: A status object which is used as the `metadata` fieldfor the Operation returned by CreateProject. It provides insight for whensignificant phases of Project creation have completed.

func (CreateProjectMetadata)MarshalJSONadded inv0.36.0

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

typeCreateTagBindingMetadataadded inv0.45.0

type CreateTagBindingMetadata struct {}

CreateTagBindingMetadata: Runtime operation information for creating aTagValue.

typeCreateTagKeyMetadataadded inv0.36.0

type CreateTagKeyMetadata struct {}

CreateTagKeyMetadata: Runtime operation information for creating a TagKey.

typeCreateTagValueMetadataadded inv0.36.0

type CreateTagValueMetadata struct {}

CreateTagValueMetadata: Runtime operation information for creating aTagValue.

typeDeleteFolderMetadataadded inv0.36.0

type DeleteFolderMetadata struct {}

DeleteFolderMetadata: A status object which is used as the `metadata` fieldfor the `Operation` returned by `DeleteFolder`.

typeDeleteOrganizationMetadataadded inv0.36.0

type DeleteOrganizationMetadata struct {}

DeleteOrganizationMetadata: A status object which is used as the `metadata`field for the operation returned by DeleteOrganization.

typeDeleteProjectMetadataadded inv0.36.0

type DeleteProjectMetadata struct {}

DeleteProjectMetadata: A status object which is used as the `metadata` fieldfor the Operation returned by `DeleteProject`.

typeDeleteTagBindingMetadataadded inv0.45.0

type DeleteTagBindingMetadata struct {}

DeleteTagBindingMetadata: Runtime operation information for deleting aTagBinding.

typeDeleteTagKeyMetadataadded inv0.36.0

type DeleteTagKeyMetadata struct {}

DeleteTagKeyMetadata: Runtime operation information for deleting a TagKey.

typeDeleteTagValueMetadataadded inv0.36.0

type DeleteTagValueMetadata struct {}

DeleteTagValueMetadata: Runtime operation information for deleting aTagValue.

typeEmpty

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

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

typeExpr

type Expr 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:"-"`}

Expr: Represents a textual expression in the Common Expression Language(CEL) syntax. CEL is a C-like expression language. The syntax and semanticsof CEL are documented athttps://github.com/google/cel-spec. Example(Comparison): title: "Summary size limit" description: "Determines if asummary is less than 100 chars" expression: "document.summary.size() < 100"Example (Equality): title: "Requestor is owner" description: "Determines ifrequestor 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 (Expr)MarshalJSON

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

typeFolderOperation

type FolderOperation struct {// DestinationParent: The resource name of the folder or organization we are// either creating the folder under or moving the folder to.DestinationParentstring `json:"destinationParent,omitempty"`// DisplayName: The display name of the folder.DisplayNamestring `json:"displayName,omitempty"`// OperationType: The type of this operation.//// Possible values://   "OPERATION_TYPE_UNSPECIFIED" - Operation type not specified.//   "CREATE" - A create folder operation.//   "MOVE" - A move folder operation.OperationTypestring `json:"operationType,omitempty"`// SourceParent: The resource name of the folder's parent. Only applicable when// the operation_type is MOVE.SourceParentstring `json:"sourceParent,omitempty"`// ForceSendFields is a list of field names (e.g. "DestinationParent") 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. "DestinationParent") 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:"-"`}

FolderOperation: Metadata describing a long running folder operation

func (FolderOperation)MarshalJSON

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

typeFolderOperationError

type FolderOperationError struct {// ErrorMessageId: The type of operation error experienced.//// Possible values://   "ERROR_TYPE_UNSPECIFIED" - The error type was unrecognized or unspecified.//   "ACTIVE_FOLDER_HEIGHT_VIOLATION" - The attempted action would violate the// max folder depth constraint.//   "MAX_CHILD_FOLDERS_VIOLATION" - The attempted action would violate the max// child folders constraint.//   "FOLDER_NAME_UNIQUENESS_VIOLATION" - The attempted action would violate// the locally-unique folder display_name constraint.//   "RESOURCE_DELETED_VIOLATION" - The resource being moved has been deleted.//   "PARENT_DELETED_VIOLATION" - The resource a folder was being added to has// been deleted.//   "CYCLE_INTRODUCED_VIOLATION" - The attempted action would introduce cycle// in resource path.//   "FOLDER_BEING_MOVED_VIOLATION" - The attempted action would move a folder// that is already being moved.//   "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION" - The folder the caller is trying// to delete contains active resources.//   "DELETED_FOLDER_HEIGHT_VIOLATION" - The attempted action would violate the// max deleted folder depth constraint.//   "FOLDER_TO_DELETE_CONFIGURED_CAPABILITY_VIOLATION" - The folder being// deleted has a configured capability.ErrorMessageIdstring `json:"errorMessageId,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorMessageId") 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. "ErrorMessageId") 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:"-"`}

FolderOperationError: A classification of the Folder Operation error.

func (FolderOperationError)MarshalJSON

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

typeFoldersClearOrgPolicyCall

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

func (*FoldersClearOrgPolicyCall)Context

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

func (*FoldersClearOrgPolicyCall)Do

Do executes the "cloudresourcemanager.folders.clearOrgPolicy" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*FoldersClearOrgPolicyCall)Fields

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

func (*FoldersClearOrgPolicyCall)Header

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

typeFoldersGetEffectiveOrgPolicyCall

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

func (*FoldersGetEffectiveOrgPolicyCall)Context

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

func (*FoldersGetEffectiveOrgPolicyCall)Do

Do executes the "cloudresourcemanager.folders.getEffectiveOrgPolicy" call.Any non-2xx status code is an error. Response headers are in either*OrgPolicy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*FoldersGetEffectiveOrgPolicyCall)Fields

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

func (*FoldersGetEffectiveOrgPolicyCall)Header

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

typeFoldersGetOrgPolicyCall

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

func (*FoldersGetOrgPolicyCall)Context

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

func (*FoldersGetOrgPolicyCall)Do

Do executes the "cloudresourcemanager.folders.getOrgPolicy" call.Any non-2xx status code is an error. Response headers are in either*OrgPolicy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*FoldersGetOrgPolicyCall)Fields

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

func (*FoldersGetOrgPolicyCall)Header

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

typeFoldersListAvailableOrgPolicyConstraintsCall

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

func (*FoldersListAvailableOrgPolicyConstraintsCall)Context

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

func (*FoldersListAvailableOrgPolicyConstraintsCall)Do

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

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

func (*FoldersListAvailableOrgPolicyConstraintsCall)Header

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

func (*FoldersListAvailableOrgPolicyConstraintsCall)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.

typeFoldersListOrgPoliciesCall

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

func (*FoldersListOrgPoliciesCall)Context

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

func (*FoldersListOrgPoliciesCall)Do

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

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

func (*FoldersListOrgPoliciesCall)Header

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

func (*FoldersListOrgPoliciesCall)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.

typeFoldersService

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

funcNewFoldersService

func NewFoldersService(s *Service) *FoldersService

func (*FoldersService)ClearOrgPolicy

func (r *FoldersService) ClearOrgPolicy(resourcestring, clearorgpolicyrequest *ClearOrgPolicyRequest) *FoldersClearOrgPolicyCall

ClearOrgPolicy: Clears a `Policy` from a resource.

- resource: Name of the resource for the `Policy` to clear.

func (*FoldersService)GetEffectiveOrgPolicy

func (r *FoldersService) GetEffectiveOrgPolicy(resourcestring, geteffectiveorgpolicyrequest *GetEffectiveOrgPolicyRequest) *FoldersGetEffectiveOrgPolicyCall

GetEffectiveOrgPolicy: Gets the effective `Policy` on a resource. This isthe result of merging `Policies` in the resource hierarchy. The returned`Policy` will not have an `etag`set because it is a computed `Policy` acrossmultiple resources. Subtrees of Resource Manager resource hierarchy with'under:' prefix will not be expanded.

  • resource: The name of the resource to start computing the effective`Policy`.

func (*FoldersService)GetOrgPolicy

func (r *FoldersService) GetOrgPolicy(resourcestring, getorgpolicyrequest *GetOrgPolicyRequest) *FoldersGetOrgPolicyCall

GetOrgPolicy: Gets a `Policy` on a resource. If no `Policy` is set on theresource, a `Policy` is returned with default values including`POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can beused with `SetOrgPolicy()` to create or update a `Policy` duringread-modify-write.

- resource: Name of the resource the `Policy` is set on.

func (*FoldersService)ListAvailableOrgPolicyConstraints

func (r *FoldersService) ListAvailableOrgPolicyConstraints(resourcestring, listavailableorgpolicyconstraintsrequest *ListAvailableOrgPolicyConstraintsRequest) *FoldersListAvailableOrgPolicyConstraintsCall

ListAvailableOrgPolicyConstraints: Lists `Constraints` that could be appliedon the specified resource.

- resource: Name of the resource to list `Constraints` for.

func (*FoldersService)ListOrgPolicies

func (r *FoldersService) ListOrgPolicies(resourcestring, listorgpoliciesrequest *ListOrgPoliciesRequest) *FoldersListOrgPoliciesCall

ListOrgPolicies: Lists all the `Policies` set for a particular resource.

- resource: Name of the resource to list Policies for.

func (*FoldersService)SetOrgPolicy

func (r *FoldersService) SetOrgPolicy(resourcestring, setorgpolicyrequest *SetOrgPolicyRequest) *FoldersSetOrgPolicyCall

SetOrgPolicy: Updates the specified `Policy` on the resource. Creates a new`Policy` for that `Constraint` on the resource if one does not exist. Notsupplying an `etag` on the request `Policy` results in an unconditionalwrite of the `Policy`.

- resource: Resource name of the resource to attach the `Policy`.

typeFoldersSetOrgPolicyCall

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

func (*FoldersSetOrgPolicyCall)Context

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

func (*FoldersSetOrgPolicyCall)Do

Do executes the "cloudresourcemanager.folders.setOrgPolicy" call.Any non-2xx status code is an error. Response headers are in either*OrgPolicy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*FoldersSetOrgPolicyCall)Fields

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

func (*FoldersSetOrgPolicyCall)Header

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

typeGetAncestryRequest

type GetAncestryRequest struct {}

GetAncestryRequest: The request sent to the GetAncestry method.

typeGetAncestryResponse

type GetAncestryResponse struct {// Ancestor: Ancestors are ordered from bottom to top of the resource// hierarchy. The first ancestor is the project itself, followed by the// project's parent, etc..Ancestor []*Ancestor `json:"ancestor,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Ancestor") 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. "Ancestor") 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:"-"`}

GetAncestryResponse: Response from the projects.getAncestry method.

func (GetAncestryResponse)MarshalJSON

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

typeGetEffectiveOrgPolicyRequest

type GetEffectiveOrgPolicyRequest struct {// Constraint: The name of the `Constraint` to compute the effective `Policy`.Constraintstring `json:"constraint,omitempty"`// ForceSendFields is a list of field names (e.g. "Constraint") 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. "Constraint") 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:"-"`}

GetEffectiveOrgPolicyRequest: The request sent to the GetEffectiveOrgPolicymethod.

func (GetEffectiveOrgPolicyRequest)MarshalJSON

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

typeGetIamPolicyRequest

type GetIamPolicyRequest struct {// Options: OPTIONAL: A `GetPolicyOptions` object for specifying options to// `GetIamPolicy`.Options *GetPolicyOptions `json:"options,omitempty"`// ForceSendFields is a list of field names (e.g. "Options") 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. "Options") 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:"-"`}

GetIamPolicyRequest: Request message for `GetIamPolicy` method.

func (GetIamPolicyRequest)MarshalJSONadded inv0.8.0

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

typeGetOrgPolicyRequest

type GetOrgPolicyRequest struct {// Constraint: Name of the `Constraint` to get the `Policy`.Constraintstring `json:"constraint,omitempty"`// ForceSendFields is a list of field names (e.g. "Constraint") 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. "Constraint") 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:"-"`}

GetOrgPolicyRequest: The request sent to the GetOrgPolicy method.

func (GetOrgPolicyRequest)MarshalJSON

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

typeGetPolicyOptionsadded inv0.8.0

type GetPolicyOptions struct {// RequestedPolicyVersion: Optional. The maximum policy version that will be// used to format the policy. Valid values are 0, 1, and 3. Requests specifying// an invalid value will be rejected. Requests for policies with any// conditional role bindings must specify version 3. Policies with no// conditional role bindings may specify any valid value or leave the field// unset. The policy in the response might use the policy version that you// specified, or it might use a lower policy version. For example, if you// specify version 3, but the policy has no conditional role bindings, the// response uses version 1. To learn which resources support conditions in// their IAM policies, see the IAM documentation// (https://cloud.google.com/iam/help/conditions/resource-policies).RequestedPolicyVersionint64 `json:"requestedPolicyVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "RequestedPolicyVersion") 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. "RequestedPolicyVersion") 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:"-"`}

GetPolicyOptions: Encapsulates settings provided to GetIamPolicy.

func (GetPolicyOptions)MarshalJSONadded inv0.8.0

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

typeLien

type Lien struct {// CreateTime: The creation time of this Lien.CreateTimestring `json:"createTime,omitempty"`// Name: A system-generated unique identifier for this Lien. Example:// `liens/1234abcd`Namestring `json:"name,omitempty"`// Origin: A stable, user-visible/meaningful string identifying the origin of// the Lien, intended to be inspected programmatically. Maximum length of 200// characters. Example: 'compute.googleapis.com'Originstring `json:"origin,omitempty"`// Parent: A reference to the resource this Lien is attached to. The server// will validate the parent against those for which Liens are supported.// Example: `projects/1234`Parentstring `json:"parent,omitempty"`// Reason: Concise user-visible strings indicating why an action cannot be// performed on a resource. Maximum length of 200 characters. Example: 'Holds// production API key'Reasonstring `json:"reason,omitempty"`// Restrictions: The types of operations which should be blocked as a result of// this Lien. Each value should correspond to an IAM permission. The server// will validate the permissions against those for which Liens are supported.// An empty list is meaningless and will be rejected. Example:// ['resourcemanager.projects.delete']Restrictions []string `json:"restrictions,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Lien: A Lien represents an encumbrance on the actions that can be performedon a resource.

func (Lien)MarshalJSON

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

typeLiensCreateCall

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

func (*LiensCreateCall)Context

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

func (*LiensCreateCall)Do

func (c *LiensCreateCall) Do(opts ...googleapi.CallOption) (*Lien,error)

Do executes the "cloudresourcemanager.liens.create" call.Any non-2xx status code is an error. Response headers are in either*Lien.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*LiensCreateCall)Fields

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

func (*LiensCreateCall)Header

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

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

typeLiensDeleteCall

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

func (*LiensDeleteCall)Context

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

func (*LiensDeleteCall)Do

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

func (*LiensDeleteCall)Fields

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

func (*LiensDeleteCall)Header

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

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

typeLiensGetCall

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

func (*LiensGetCall)Context

func (c *LiensGetCall) Context(ctxcontext.Context) *LiensGetCall

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

func (*LiensGetCall)Do

func (c *LiensGetCall) Do(opts ...googleapi.CallOption) (*Lien,error)

Do executes the "cloudresourcemanager.liens.get" call.Any non-2xx status code is an error. Response headers are in either*Lien.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*LiensGetCall)Fields

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

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

func (*LiensGetCall)Header

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

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

func (*LiensGetCall)IfNoneMatch

func (c *LiensGetCall) IfNoneMatch(entityTagstring) *LiensGetCall

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.

typeLiensListCall

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

func (*LiensListCall)Context

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

func (*LiensListCall)Do

Do executes the "cloudresourcemanager.liens.list" call.Any non-2xx status code is an error. Response headers are in either*ListLiensResponse.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 (*LiensListCall)Fields

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

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

func (*LiensListCall)Header

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

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

func (*LiensListCall)IfNoneMatch

func (c *LiensListCall) IfNoneMatch(entityTagstring) *LiensListCall

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

func (c *LiensListCall) PageSize(pageSizeint64) *LiensListCall

PageSize sets the optional parameter "pageSize": The maximum number of itemsto return. This is a suggestion for the server. The server can return fewerliens than requested. If unspecified, server picks an appropriate default.

func (*LiensListCall)PageToken

func (c *LiensListCall) PageToken(pageTokenstring) *LiensListCall

PageToken sets the optional parameter "pageToken": The `next_page_token`value returned from a previous List request, if any.

func (*LiensListCall)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.

func (*LiensListCall)Parent

func (c *LiensListCall) Parent(parentstring) *LiensListCall

Parent sets the optional parameter "parent": Required. The name of theresource to list all attached Liens. For example, `projects/1234`.(google.api.field_policy).resource_type annotation is not set since theparent depends on the meta api implementation. This field could be a projector other sub project resources.

typeLiensService

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

funcNewLiensService

func NewLiensService(s *Service) *LiensService

func (*LiensService)Create

func (r *LiensService) Create(lien *Lien) *LiensCreateCall

Create: Create a Lien which applies to the resource denoted by the `parent`field. Callers of this method will require permission on the `parent`resource. For example, applying to `projects/1234` requires permission`resourcemanager.projects.updateLiens`. NOTE: Some resources may limit thenumber of Liens which may be applied.

func (*LiensService)Delete

func (r *LiensService) Delete(nameidstring) *LiensDeleteCall

Delete: Delete a Lien by `name`. Callers of this method will requirepermission on the `parent` resource. For example, a Lien with a `parent` of`projects/1234` requires permission `resourcemanager.projects.updateLiens`.

- name: The name/identifier of the Lien to delete.

func (*LiensService)Get

func (r *LiensService) Get(nameidstring) *LiensGetCall

Get: Retrieve a Lien by `name`. Callers of this method will requirepermission on the `parent` resource. For example, a Lien with a `parent` of`projects/1234` requires permission `resourcemanager.projects.get`

- name: The name/identifier of the Lien.

func (*LiensService)List

func (r *LiensService) List() *LiensListCall

List: List all Liens applied to the `parent` resource. Callers of thismethod will require permission on the `parent` resource. For example, a Lienwith a `parent` of `projects/1234` requires permission`resourcemanager.projects.get`.

typeListAvailableOrgPolicyConstraintsRequest

type ListAvailableOrgPolicyConstraintsRequest struct {// 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.PageSizeint64 `json:"pageSize,omitempty"`// 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.PageTokenstring `json:"pageToken,omitempty"`// ForceSendFields is a list of field names (e.g. "PageSize") 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. "PageSize") 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:"-"`}

ListAvailableOrgPolicyConstraintsRequest: The request sent to the`ListAvailableOrgPolicyConstraints` method on the project, folder, ororganization.

func (ListAvailableOrgPolicyConstraintsRequest)MarshalJSON

typeListAvailableOrgPolicyConstraintsResponse

type ListAvailableOrgPolicyConstraintsResponse struct {// Constraints: The collection of constraints that are settable on the request// resource.Constraints []*Constraint `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:"-"`}

ListAvailableOrgPolicyConstraintsResponse: The response returned from the`ListAvailableOrgPolicyConstraints` method. Returns all `Constraints` thatcould be set at this level of the hierarchy (contrast with the response from`ListPolicies`, which returns all policies which are set).

func (ListAvailableOrgPolicyConstraintsResponse)MarshalJSON

typeListConstraint

type ListConstraint struct {// SuggestedValue: Optional. The Google Cloud Console will try to default to a// configuration that matches the value specified in this `Constraint`.SuggestedValuestring `json:"suggestedValue,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.SupportsUnderbool `json:"supportsUnder,omitempty"`// ForceSendFields is a list of field names (e.g. "SuggestedValue") 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. "SuggestedValue") 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:"-"`}

ListConstraint: A `Constraint` that allows or disallows a list of stringvalues, which are configured by an Organization's policy administrator witha `Policy`.

func (ListConstraint)MarshalJSON

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

typeListLiensResponse

type ListLiensResponse struct {// Liens: A list of Liens.Liens []*Lien `json:"liens,omitempty"`// NextPageToken: Token to retrieve the next page of results, or empty if there// are no more results in the list.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. "Liens") 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. "Liens") 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:"-"`}

ListLiensResponse: The response message for Liens.ListLiens.

func (ListLiensResponse)MarshalJSON

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

typeListOrgPoliciesRequest

type ListOrgPoliciesRequest struct {// 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.PageSizeint64 `json:"pageSize,omitempty"`// 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.PageTokenstring `json:"pageToken,omitempty"`// ForceSendFields is a list of field names (e.g. "PageSize") 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. "PageSize") 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:"-"`}

ListOrgPoliciesRequest: The request sent to the ListOrgPolicies method.

func (ListOrgPoliciesRequest)MarshalJSON

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

typeListOrgPoliciesResponse

type ListOrgPoliciesResponse 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: The `Policies` that are set on the resource. It will be empty if// no `Policies` are set.Policies []*OrgPolicy `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:"-"`}

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

func (ListOrgPoliciesResponse)MarshalJSON

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

typeListPolicy

type ListPolicy struct {// AllValues: The policy all_values state.//// Possible values://   "ALL_VALUES_UNSPECIFIED" - Indicates that allowed_values or denied_values// must be set.//   "ALLOW" - A policy with this set allows all values.//   "DENY" - A policy with this set denies all values.AllValuesstring `json:"allValues,omitempty"`// AllowedValues: List of values allowed at this resource. Can only be set if// `all_values` is set to `ALL_VALUES_UNSPECIFIED`.AllowedValues []string `json:"allowedValues,omitempty"`// DeniedValues: List of values denied at this resource. Can only be set if// `all_values` is set to `ALL_VALUES_UNSPECIFIED`.DeniedValues []string `json:"deniedValues,omitempty"`// InheritFromParent: Determines the inheritance behavior for this `Policy`. By// default, a `ListPolicy` set at a resource supersedes any `Policy` set// anywhere up the resource hierarchy. However, if `inherit_from_parent` is set// to `true`, then the values from the effective `Policy` of the parent// resource are inherited, meaning the values set in this `Policy` are added to// the values inherited up the hierarchy. Setting `Policy` hierarchies that// inherit both allowed values and denied values isn't recommended in most// circumstances to keep the configuration simple and understandable. However,// it is possible to set a `Policy` with `allowed_values` set that inherits a// `Policy` with `denied_values` set. In this case, the values that are allowed// must be in `allowed_values` and not present in `denied_values`. For example,// suppose you have a `Constraint` `constraints/serviceuser.services`, which// has a `constraint_type` of `list_constraint`, and with `constraint_default`// set to `ALLOW`. Suppose that at the Organization level, a `Policy` is// applied that restricts the allowed API activations to {`E1`, `E2`}. Then, if// a `Policy` is applied to a project below the Organization that has// `inherit_from_parent` set to `false` and field all_values set to DENY, then// an attempt to activate any API will be denied. The following examples// demonstrate different possible layerings for `projects/bar` parented by// `organizations/foo`: Example 1 (no inherited values): `organizations/foo`// has a `Policy` with values: {allowed_values: "E1" allowed_values:"E2"}// `projects/bar` has `inherit_from_parent` `false` and values:// {allowed_values: "E3" allowed_values: "E4"} The accepted values at// `organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar`// are `E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a// `Policy` with values: {allowed_values: "E1" allowed_values:"E2"}// `projects/bar` has a `Policy` with values: {value: "E3" value: "E4"// inherit_from_parent: true} The accepted values at `organizations/foo` are// `E1`, `E2`. The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and// `E4`. Example 3 (inheriting both allowed and denied values):// `organizations/foo` has a `Policy` with values: {allowed_values: "E1"// allowed_values: "E2"} `projects/bar` has a `Policy` with: {denied_values:// "E1"} The accepted values at `organizations/foo` are `E1`, `E2`. The value// accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault):// `organizations/foo` has a `Policy` with values: {allowed_values: "E1"// allowed_values:"E2"} `projects/bar` has a `Policy` with values:// {RestoreDefault: {}} The accepted values at `organizations/foo` are `E1`,// `E2`. The accepted values at `projects/bar` are either all or none depending// on the value of `constraint_default` (if `ALLOW`, all; if `DENY`, none).// Example 5 (no policy inherits parent policy): `organizations/foo` has no// `Policy` set. `projects/bar` has no `Policy` set. The accepted values at// both levels are either all or none depending on the value of// `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 6// (ListConstraint allowing all): `organizations/foo` has a `Policy` with// values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a// `Policy` with: {all: ALLOW} The accepted values at `organizations/foo` are// `E1`, E2`. Any value is accepted at `projects/bar`. Example 7// (ListConstraint allowing none): `organizations/foo` has a `Policy` with// values: {allowed_values: "E1" allowed_values: "E2"} `projects/bar` has a// `Policy` with: {all: DENY} The accepted values at `organizations/foo` are// `E1`, E2`. No value is accepted at `projects/bar`. Example 10 (allowed and// denied subtrees of Resource Manager hierarchy): Given the following resource// hierarchy O1->{F1, F2}; F1->{P1}; F2->{P2, P3}, `organizations/foo` has a// `Policy` with values: {allowed_values: "under:organizations/O1"}// `projects/bar` has a `Policy` with: {allowed_values: "under:projects/P3"}// {denied_values: "under:folders/F2"} The accepted values at// `organizations/foo` are `organizations/O1`, `folders/F1`, `folders/F2`,// `projects/P1`, `projects/P2`, `projects/P3`. The accepted values at// `projects/bar` are `organizations/O1`, `folders/F1`, `projects/P1`.InheritFromParentbool `json:"inheritFromParent,omitempty"`// SuggestedValue: Optional. The Google Cloud Console will try to default to a// configuration that matches the value specified in this `Policy`. If// `suggested_value` is not set, it will inherit the value specified higher in// the hierarchy, unless `inherit_from_parent` is `false`.SuggestedValuestring `json:"suggestedValue,omitempty"`// ForceSendFields is a list of field names (e.g. "AllValues") 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. "AllValues") 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:"-"`}

ListPolicy: Used in `policy_type` to specify how `list_policy` behaves atthis resource. `ListPolicy` can define specific values and subtrees of CloudResource Manager resource hierarchy (`Organizations`, `Folders`, `Projects`)that are allowed or denied by setting the `allowed_values` and`denied_values` fields. This is achieved by using the `under:` and optional`is:` prefixes. The `under:` prefix is used to denote resource subtreevalues. The `is:` prefix is used to denote specific values, and is requiredonly if the value contains a ":". Values prefixed with "is:" are treated thesame as values with no prefix. Ancestry subtrees must be in one of thefollowing 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. You can set`allowed_values` and `denied_values` in the same `Policy` if `all_values` is`ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny allvalues. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values`and `denied_values` must be unset.

func (ListPolicy)MarshalJSON

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

typeListProjectsResponse

type ListProjectsResponse struct {// NextPageToken: Pagination token. If the result set is too large to fit in a// single response, this token is returned. It encodes the position of the// current result cursor. Feeding this value into a new list request with the// `page_token` parameter gives the next page of the results. When// `next_page_token` is not filled in, there is no next page and the list// returned is the last page in the result set. Pagination tokens have a// limited lifetime.NextPageTokenstring `json:"nextPageToken,omitempty"`// Projects: The list of Projects that matched the list filter. This list can// be paginated.Projects []*Project `json:"projects,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:"-"`}

ListProjectsResponse: A page of the response received from the ListProjectsmethod. A paginated response where more pages are available has`next_page_token` set. This token can be used in a subsequent request toretrieve the next request page.

func (ListProjectsResponse)MarshalJSON

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

typeMoveFolderMetadataadded inv0.36.0

type MoveFolderMetadata struct {// DestinationParent: The resource name of the folder or organization to move// the folder to.DestinationParentstring `json:"destinationParent,omitempty"`// DisplayName: The display name of the folder.DisplayNamestring `json:"displayName,omitempty"`// SourceParent: The resource name of the folder's parent.SourceParentstring `json:"sourceParent,omitempty"`// ForceSendFields is a list of field names (e.g. "DestinationParent") 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. "DestinationParent") 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:"-"`}

MoveFolderMetadata: Metadata pertaining to the folder move process.

func (MoveFolderMetadata)MarshalJSONadded inv0.36.0

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

typeMoveProjectMetadataadded inv0.36.0

type MoveProjectMetadata struct {}

MoveProjectMetadata: A status object which is used as the `metadata` fieldfor the Operation returned by MoveProject.

typeOperation

type Operation struct {// Done: If the value is `false`, it means the operation is still in progress.// If `true`, the operation is completed, and either `error` or `response` is// available.Donebool `json:"done,omitempty"`// Error: The error result of the operation in case of failure or cancellation.Error *Status `json:"error,omitempty"`// Metadata: Service-specific metadata associated with the operation. It// typically contains progress information and common metadata such as create// time. Some services might not provide such metadata. Any method that returns// a long-running operation should document the metadata type, if any.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: The server-assigned name, which is only unique within the same service// that originally returns it. If you use the default HTTP mapping, the `name`// should be a resource name ending with `operations/{unique_id}`.Namestring `json:"name,omitempty"`// Response: The normal, successful response of the operation. If the original// method returns no data on success, such as `Delete`, the response is// `google.protobuf.Empty`. If the original method is standard// `Get`/`Create`/`Update`, the response should be the resource. For other// methods, the response should have the type `XxxResponse`, where `Xxx` is the// original method name. For example, if the original method name is// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.Responsegoogleapi.RawMessage `json:"response,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Done") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Done") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

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

func (Operation)MarshalJSON

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

typeOperationsGetCall

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

func (*OperationsGetCall)Context

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

func (*OperationsGetCall)Do

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

func (*OperationsGetCall)Fields

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

func (*OperationsGetCall)Header

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

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

func (*OperationsGetCall)IfNoneMatch

func (c *OperationsGetCall) IfNoneMatch(entityTagstring) *OperationsGetCall

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.

typeOperationsService

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

funcNewOperationsService

func NewOperationsService(s *Service) *OperationsService

func (*OperationsService)Get

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

- name: The name of the operation resource.

typeOrgPolicy

type OrgPolicy struct {// BooleanPolicy: For boolean `Constraints`, whether to enforce the// `Constraint` or not.BooleanPolicy *BooleanPolicy `json:"booleanPolicy,omitempty"`// Constraint: The name of the `Constraint` the `Policy` is configuring, for// example, `constraints/serviceuser.services`. A list of available constraints// (/resource-manager/docs/organization-policy/org-policy-constraints) is// available. Immutable after creation.Constraintstring `json:"constraint,omitempty"`// Etag: An opaque tag indicating the current version of the `Policy`, used for// concurrency control. When the `Policy` is returned from either a `GetPolicy`// or a `ListOrgPolicy` 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. When the `Policy` is used in a `SetOrgPolicy` method, use the `etag`// value that was returned from a `GetOrgPolicy` request as part of a// read-modify-write loop for concurrency control. Not setting the `etag`in a// `SetOrgPolicy` request will result in an unconditional write of the// `Policy`.Etagstring `json:"etag,omitempty"`// ListPolicy: List of values either allowed or disallowed.ListPolicy *ListPolicy `json:"listPolicy,omitempty"`// RestoreDefault: Restores the default behavior of the constraint; independent// of `Constraint` type.RestoreDefault *RestoreDefault `json:"restoreDefault,omitempty"`// UpdateTime: The time stamp the `Policy` was previously updated. This is set// by the server, not specified by the caller, and represents the last time a// call to `SetOrgPolicy` was made for that `Policy`. Any value set by the// client will be ignored.UpdateTimestring `json:"updateTime,omitempty"`// Version: Version of the `Policy`. Default version is 0;Versionint64 `json:"version,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BooleanPolicy") 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. "BooleanPolicy") 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:"-"`}

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

func (OrgPolicy)MarshalJSON

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

typeOrganization

type Organization struct {// CreationTime: Timestamp when the Organization was created. Assigned by the// server.CreationTimestring `json:"creationTime,omitempty"`// DisplayName: A human-readable string that refers to the Organization in the// Google Cloud console. This string is set by the server and cannot be// changed. The string will be set to the primary domain (for example,// "google.com") of the G Suite customer that owns the organization.DisplayNamestring `json:"displayName,omitempty"`// LifecycleState: The organization's current lifecycle state. Assigned by the// server.//// Possible values://   "LIFECYCLE_STATE_UNSPECIFIED" - Unspecified state. This is only useful for// distinguishing unset values.//   "ACTIVE" - The normal and active state.//   "DELETE_REQUESTED" - The organization has been marked for deletion by the// user.LifecycleStatestring `json:"lifecycleState,omitempty"`// Name: Output only. The resource name of the organization. This is the// organization's relative path in the API. Its format is// "organizations/[organization_id]". For example, "organizations/1234".Namestring `json:"name,omitempty"`// Owner: The owner of this Organization. The owner should be specified on// creation. Once set, it cannot be changed. This field is required.Owner *OrganizationOwner `json:"owner,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreationTime") 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. "CreationTime") 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:"-"`}

Organization: The root node in the resource hierarchy to which a particularentity's (e.g., company) resources belong.

func (Organization)MarshalJSON

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

typeOrganizationOwner

type OrganizationOwner struct {// DirectoryCustomerId: The G Suite customer id used in the Directory API.DirectoryCustomerIdstring `json:"directoryCustomerId,omitempty"`// ForceSendFields is a list of field names (e.g. "DirectoryCustomerId") 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. "DirectoryCustomerId") 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:"-"`}

OrganizationOwner: The entity that owns an Organization. The lifetime of theOrganization and all of its descendants are bound to the`OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organizationand all its descendants will be deleted.

func (OrganizationOwner)MarshalJSON

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

typeOrganizationsClearOrgPolicyCall

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

func (*OrganizationsClearOrgPolicyCall)Context

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

func (*OrganizationsClearOrgPolicyCall)Do

Do executes the "cloudresourcemanager.organizations.clearOrgPolicy" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsClearOrgPolicyCall)Fields

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

func (*OrganizationsClearOrgPolicyCall)Header

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

typeOrganizationsGetCall

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

func (*OrganizationsGetCall)Context

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

func (*OrganizationsGetCall)Do

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

func (*OrganizationsGetCall)Fields

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

func (*OrganizationsGetCall)Header

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

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

func (*OrganizationsGetCall)IfNoneMatch

func (c *OrganizationsGetCall) IfNoneMatch(entityTagstring) *OrganizationsGetCall

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.

typeOrganizationsGetEffectiveOrgPolicyCall

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

func (*OrganizationsGetEffectiveOrgPolicyCall)Context

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

func (*OrganizationsGetEffectiveOrgPolicyCall)Do

Do executes the "cloudresourcemanager.organizations.getEffectiveOrgPolicy" call.Any non-2xx status code is an error. Response headers are in either*OrgPolicy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsGetEffectiveOrgPolicyCall)Fields

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

func (*OrganizationsGetEffectiveOrgPolicyCall)Header

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

typeOrganizationsGetIamPolicyCall

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

func (*OrganizationsGetIamPolicyCall)Context

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

func (*OrganizationsGetIamPolicyCall)Do

Do executes the "cloudresourcemanager.organizations.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsGetIamPolicyCall)Fields

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

func (*OrganizationsGetIamPolicyCall)Header

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

typeOrganizationsGetOrgPolicyCall

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

func (*OrganizationsGetOrgPolicyCall)Context

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

func (*OrganizationsGetOrgPolicyCall)Do

Do executes the "cloudresourcemanager.organizations.getOrgPolicy" call.Any non-2xx status code is an error. Response headers are in either*OrgPolicy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsGetOrgPolicyCall)Fields

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

func (*OrganizationsGetOrgPolicyCall)Header

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

typeOrganizationsListAvailableOrgPolicyConstraintsCall

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

func (*OrganizationsListAvailableOrgPolicyConstraintsCall)Context

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

func (*OrganizationsListAvailableOrgPolicyConstraintsCall)Do

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

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

func (*OrganizationsListAvailableOrgPolicyConstraintsCall)Header

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

func (*OrganizationsListAvailableOrgPolicyConstraintsCall)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.

typeOrganizationsListOrgPoliciesCall

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

func (*OrganizationsListOrgPoliciesCall)Context

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

func (*OrganizationsListOrgPoliciesCall)Do

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

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

func (*OrganizationsListOrgPoliciesCall)Header

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

func (*OrganizationsListOrgPoliciesCall)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.

typeOrganizationsSearchCall

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

func (*OrganizationsSearchCall)Context

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

func (*OrganizationsSearchCall)Do

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

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

func (*OrganizationsSearchCall)Header

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

func (*OrganizationsSearchCall)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.

typeOrganizationsService

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

funcNewOrganizationsService

func NewOrganizationsService(s *Service) *OrganizationsService

func (*OrganizationsService)ClearOrgPolicy

func (r *OrganizationsService) ClearOrgPolicy(resourcestring, clearorgpolicyrequest *ClearOrgPolicyRequest) *OrganizationsClearOrgPolicyCall

ClearOrgPolicy: Clears a `Policy` from a resource.

- resource: Name of the resource for the `Policy` to clear.

func (*OrganizationsService)Get

Get: Fetches an Organization resource identified by the specified resourcename.

  • name: The resource name of the Organization to fetch. This is theorganization's relative path in the API, formatted as"organizations/[organizationId]". For example, "organizations/1234".

func (*OrganizationsService)GetEffectiveOrgPolicy

func (r *OrganizationsService) GetEffectiveOrgPolicy(resourcestring, geteffectiveorgpolicyrequest *GetEffectiveOrgPolicyRequest) *OrganizationsGetEffectiveOrgPolicyCall

GetEffectiveOrgPolicy: Gets the effective `Policy` on a resource. This isthe result of merging `Policies` in the resource hierarchy. The returned`Policy` will not have an `etag`set because it is a computed `Policy` acrossmultiple resources. Subtrees of Resource Manager resource hierarchy with'under:' prefix will not be expanded.

  • resource: The name of the resource to start computing the effective`Policy`.

func (*OrganizationsService)GetIamPolicy

func (r *OrganizationsService) GetIamPolicy(resourcestring, getiampolicyrequest *GetIamPolicyRequest) *OrganizationsGetIamPolicyCall

GetIamPolicy: Gets the access control policy for an Organization resource.May be empty if no such policy or resource exists. The `resource` fieldshould be the organization's resource name, e.g. "organizations/123".Authorization requires the Google IAM permission`resourcemanager.organizations.getIamPolicy` on the specified organization

func (*OrganizationsService)GetOrgPolicy

func (r *OrganizationsService) GetOrgPolicy(resourcestring, getorgpolicyrequest *GetOrgPolicyRequest) *OrganizationsGetOrgPolicyCall

GetOrgPolicy: Gets a `Policy` on a resource. If no `Policy` is set on theresource, a `Policy` is returned with default values including`POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can beused with `SetOrgPolicy()` to create or update a `Policy` duringread-modify-write.

- resource: Name of the resource the `Policy` is set on.

func (*OrganizationsService)ListAvailableOrgPolicyConstraints

func (r *OrganizationsService) ListAvailableOrgPolicyConstraints(resourcestring, listavailableorgpolicyconstraintsrequest *ListAvailableOrgPolicyConstraintsRequest) *OrganizationsListAvailableOrgPolicyConstraintsCall

ListAvailableOrgPolicyConstraints: Lists `Constraints` that could be appliedon the specified resource.

- resource: Name of the resource to list `Constraints` for.

func (*OrganizationsService)ListOrgPolicies

func (r *OrganizationsService) ListOrgPolicies(resourcestring, listorgpoliciesrequest *ListOrgPoliciesRequest) *OrganizationsListOrgPoliciesCall

ListOrgPolicies: Lists all the `Policies` set for a particular resource.

- resource: Name of the resource to list Policies for.

func (*OrganizationsService)Search

func (r *OrganizationsService) Search(searchorganizationsrequest *SearchOrganizationsRequest) *OrganizationsSearchCall

Search: Searches Organization resources that are visible to the user andsatisfy the specified filter. This method returns Organizations in anunspecified order. New Organizations do not necessarily appear at the end ofthe results. Search will only return organizations on which the user has thepermission `resourcemanager.organizations.get` or has super adminprivileges.

func (*OrganizationsService)SetIamPolicy

func (r *OrganizationsService) SetIamPolicy(resourcestring, setiampolicyrequest *SetIamPolicyRequest) *OrganizationsSetIamPolicyCall

SetIamPolicy: Sets the access control policy on an Organization resource.Replaces any existing policy. The `resource` field should be theorganization's resource name, e.g. "organizations/123". Authorizationrequires the Google IAM permission`resourcemanager.organizations.setIamPolicy` on the specified organization

func (*OrganizationsService)SetOrgPolicy

func (r *OrganizationsService) SetOrgPolicy(resourcestring, setorgpolicyrequest *SetOrgPolicyRequest) *OrganizationsSetOrgPolicyCall

SetOrgPolicy: Updates the specified `Policy` on the resource. Creates a new`Policy` for that `Constraint` on the resource if one does not exist. Notsupplying an `etag` on the request `Policy` results in an unconditionalwrite of the `Policy`.

- resource: Resource name of the resource to attach the `Policy`.

func (*OrganizationsService)TestIamPermissions

func (r *OrganizationsService) TestIamPermissions(resourcestring, testiampermissionsrequest *TestIamPermissionsRequest) *OrganizationsTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specifiedOrganization. The `resource` field should be the organization's resourcename, e.g. "organizations/123". There are no permissions required for makingthis API call.

typeOrganizationsSetIamPolicyCall

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

func (*OrganizationsSetIamPolicyCall)Context

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

func (*OrganizationsSetIamPolicyCall)Do

Do executes the "cloudresourcemanager.organizations.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsSetIamPolicyCall)Fields

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

func (*OrganizationsSetIamPolicyCall)Header

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

typeOrganizationsSetOrgPolicyCall

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

func (*OrganizationsSetOrgPolicyCall)Context

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

func (*OrganizationsSetOrgPolicyCall)Do

Do executes the "cloudresourcemanager.organizations.setOrgPolicy" call.Any non-2xx status code is an error. Response headers are in either*OrgPolicy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsSetOrgPolicyCall)Fields

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

func (*OrganizationsSetOrgPolicyCall)Header

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

typeOrganizationsTestIamPermissionsCall

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

func (*OrganizationsTestIamPermissionsCall)Context

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

func (*OrganizationsTestIamPermissionsCall)Do

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

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

func (*OrganizationsTestIamPermissionsCall)Header

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

typePolicy

type Policy struct {// AuditConfigs: Specifies cloud audit logging configuration for this policy.AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`// Bindings: Associates a list of `members`, or principals, with a `role`.// Optionally, may specify a `condition` that determines how and when the// `bindings` are applied. Each of the `bindings` must contain at least one// principal. The `bindings` in a `Policy` can refer to up to 1,500 principals;// up to 250 of these principals can be Google groups. Each occurrence of a// principal counts towards these limits. For example, if the `bindings` grant// 50 different roles to `user:alice@example.com`, and not to any other// principal, then you can add another 1,450 principals to the `bindings` in// the `Policy`.Bindings []*Binding `json:"bindings,omitempty"`// Etag: `etag` is used for optimistic concurrency control as a way to help// prevent simultaneous updates of a policy from overwriting each other. It is// strongly suggested that systems make use of the `etag` in the// read-modify-write cycle to perform policy updates in order to avoid race// conditions: An `etag` is returned in the response to `getIamPolicy`, and// systems are expected to put that etag in the request to `setIamPolicy` to// ensure that their change will be applied to the same version of the policy.// **Important:** If you use IAM Conditions, you must include the `etag` field// whenever you call `setIamPolicy`. If you omit this field, then IAM allows// you to overwrite a version `3` policy with a version `1` policy, and all of// the conditions in the version `3` policy are lost.Etagstring `json:"etag,omitempty"`// Version: Specifies the format of the policy. Valid values are `0`, `1`, and// `3`. Requests that specify an invalid value are rejected. Any operation that// affects conditional role bindings must specify version `3`. This requirement// applies to the following operations: * Getting a policy that includes a// conditional role binding * Adding a conditional role binding to a policy *// Changing a conditional role binding in a policy * Removing any role binding,// with or without a condition, from a policy that includes conditions// **Important:** If you use IAM Conditions, you must include the `etag` field// whenever you call `setIamPolicy`. If you omit this field, then IAM allows// you to overwrite a version `3` policy with a version `1` policy, and all of// the conditions in the version `3` policy are lost. If a policy does not// include any conditions, operations on that policy may specify any valid// version or leave the field unset. To learn which resources support// conditions in their IAM policies, see the IAM documentation// (https://cloud.google.com/iam/help/conditions/resource-policies).Versionint64 `json:"version,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AuditConfigs") 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. "AuditConfigs") 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:"-"`}

Policy: An Identity and Access Management (IAM) policy, which specifiesaccess controls for Google Cloud resources. A `Policy` is a collection of`bindings`. A `binding` binds one or more `members`, or principals, to asingle `role`. Principals can be user accounts, service accounts, Googlegroups, and domains (such as G Suite). A `role` is a named list ofpermissions; each `role` can be an IAM predefined role or a user-createdcustom role. For some types of Google Cloud resources, a `binding` can alsospecify a `condition`, which is a logical expression that allows access to aresource only if the expression evaluates to `true`. A condition can addconstraints based on attributes of the request, the resource, or both. Tolearn which resources support conditions in their IAM policies, see the IAMdocumentation(https://cloud.google.com/iam/help/conditions/resource-policies). **JSONexample:** ``` { "bindings": [ { "role":"roles/resourcemanager.organizationAdmin", "members": ["user:mike@example.com", "group:admins@example.com", "domain:google.com","serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role":"roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com" ], "condition": { "title": "expirable access","description": "Does not grant access after Sep 2020", "expression":"request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag":"BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: -members: - user:mike@example.com - group:admins@example.com -domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.comrole: roles/resourcemanager.organizationAdmin - members: -user:eve@example.com role: roles/resourcemanager.organizationViewercondition: title: expirable access description: Does not grant access afterSep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z')etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features,see the IAM documentation (https://cloud.google.com/iam/docs/).

func (Policy)MarshalJSON

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

typeProject

type Project struct {// ConfiguredCapabilities: Output only. If this project is a Management// Project, list of capabilities configured on the parent folder. Note,// presence of any capability implies that this is a Management Project.// Example: `folders/123/capabilities/app-management`. OUTPUT ONLY.ConfiguredCapabilities []string `json:"configuredCapabilities,omitempty"`// CreateTime: Creation time. Read-only.CreateTimestring `json:"createTime,omitempty"`// Labels: The labels associated with this Project. Label keys must be between// 1 and 63 characters long and must conform to the following regular// expression: a-z{0,62}. Label values must be between 0 and 63 characters long// and must conform to the regular expression [a-z0-9_-]{0,63}. A label value// can be empty. No more than 256 labels can be associated with a given// resource. Clients should store labels in a representation such as JSON that// does not depend on specific characters being disallowed. Example:// "environment" : "dev" Read-write.Labels map[string]string `json:"labels,omitempty"`// LifecycleState: The Project lifecycle state. Read-only.//// Possible values://   "LIFECYCLE_STATE_UNSPECIFIED" - Unspecified state. This is only// used/useful for distinguishing unset values.//   "ACTIVE" - The normal and active state.//   "DELETE_REQUESTED" - The project has been marked for deletion by the user// (by invoking DeleteProject) or by the system (Google Cloud Platform). This// can generally be reversed by invoking UndeleteProject.//   "DELETE_IN_PROGRESS" - This lifecycle state is no longer used and not// returned by the API.LifecycleStatestring `json:"lifecycleState,omitempty"`// Name: The optional user-assigned display name of the Project. When present// it must be between 4 to 30 characters. Allowed characters are: lowercase and// uppercase letters, numbers, hyphen, single-quote, double-quote, space, and// exclamation point. Example: `My Project` Read-write.Namestring `json:"name,omitempty"`// Parent: An optional reference to a parent Resource. Supported parent types// include "organization" and "folder". Once set, the parent cannot be cleared.// The `parent` can be set on creation or using the `UpdateProject` method; the// end user must have the `resourcemanager.projects.create` permission on the// parent.Parent *ResourceId `json:"parent,omitempty"`// ProjectId: The unique, user-assigned ID of the Project. It must be 6 to 30// lowercase letters, digits, or hyphens. It must start with a letter. Trailing// hyphens are prohibited. Example: `tokyo-rain-123` Read-only after creation.ProjectIdstring `json:"projectId,omitempty"`// ProjectNumber: The number uniquely identifying the project. Example:// `415104041262` Read-only.ProjectNumberint64 `json:"projectNumber,omitempty,string"`// Tags: Optional. Input only. Immutable. Tag keys/values directly bound to// this project. Each item in the map must be expressed as " : ". For example:// "123/environment" : "production", "123/costCenter" : "marketing" Note:// Currently this field is in Preview.Tags map[string]string `json:"tags,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ConfiguredCapabilities") 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. "ConfiguredCapabilities") 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:"-"`}

Project: A Project is a high-level Google Cloud Platform entity. It is acontainer for ACLs, APIs, App Engine Apps, VMs, and other Google CloudPlatform resources.

func (Project)MarshalJSON

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

typeProjectCreationStatus

type ProjectCreationStatus struct {// CreateTime: Creation time of the project creation workflow.CreateTimestring `json:"createTime,omitempty"`// Gettable: True if the project can be retrieved using GetProject. No other// operations on the project are guaranteed to work until the project creation// is complete.Gettablebool `json:"gettable,omitempty"`// Ready: True if the project creation process is complete.Readybool `json:"ready,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ProjectCreationStatus: A status object which is used as the `metadata` fieldfor the Operation returned by CreateProject. It provides insight for whensignificant phases of Project creation have completed.

func (ProjectCreationStatus)MarshalJSON

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

typeProjectsClearOrgPolicyCall

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

func (*ProjectsClearOrgPolicyCall)Context

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

func (*ProjectsClearOrgPolicyCall)Do

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

func (*ProjectsClearOrgPolicyCall)Fields

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

func (*ProjectsClearOrgPolicyCall)Header

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

typeProjectsCreateCall

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

func (*ProjectsCreateCall)Context

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

func (*ProjectsCreateCall)Do

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

func (*ProjectsCreateCall)Fields

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

func (*ProjectsCreateCall)Header

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

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

typeProjectsDeleteCall

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

func (*ProjectsDeleteCall)Context

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

func (*ProjectsDeleteCall)Do

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

func (*ProjectsDeleteCall)Fields

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

func (*ProjectsDeleteCall)Header

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

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

typeProjectsGetAncestryCall

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

func (*ProjectsGetAncestryCall)Context

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

func (*ProjectsGetAncestryCall)Do

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

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

func (*ProjectsGetAncestryCall)Header

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

typeProjectsGetCall

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

func (*ProjectsGetCall)Context

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

func (*ProjectsGetCall)Do

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

func (*ProjectsGetCall)Fields

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

func (*ProjectsGetCall)Header

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

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

func (*ProjectsGetCall)IfNoneMatch

func (c *ProjectsGetCall) IfNoneMatch(entityTagstring) *ProjectsGetCall

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.

typeProjectsGetEffectiveOrgPolicyCall

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

func (*ProjectsGetEffectiveOrgPolicyCall)Context

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

func (*ProjectsGetEffectiveOrgPolicyCall)Do

Do executes the "cloudresourcemanager.projects.getEffectiveOrgPolicy" call.Any non-2xx status code is an error. Response headers are in either*OrgPolicy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGetEffectiveOrgPolicyCall)Fields

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

func (*ProjectsGetEffectiveOrgPolicyCall)Header

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

typeProjectsGetIamPolicyCall

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

func (*ProjectsGetIamPolicyCall)Context

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

func (*ProjectsGetIamPolicyCall)Do

Do executes the "cloudresourcemanager.projects.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGetIamPolicyCall)Fields

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

func (*ProjectsGetIamPolicyCall)Header

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

typeProjectsGetOrgPolicyCall

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

func (*ProjectsGetOrgPolicyCall)Context

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

func (*ProjectsGetOrgPolicyCall)Do

Do executes the "cloudresourcemanager.projects.getOrgPolicy" call.Any non-2xx status code is an error. Response headers are in either*OrgPolicy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGetOrgPolicyCall)Fields

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

func (*ProjectsGetOrgPolicyCall)Header

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

typeProjectsListAvailableOrgPolicyConstraintsCall

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

func (*ProjectsListAvailableOrgPolicyConstraintsCall)Context

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

func (*ProjectsListAvailableOrgPolicyConstraintsCall)Do

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

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

func (*ProjectsListAvailableOrgPolicyConstraintsCall)Header

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

func (*ProjectsListAvailableOrgPolicyConstraintsCall)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.

typeProjectsListCall

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

func (*ProjectsListCall)Context

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

func (*ProjectsListCall)Do

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

func (*ProjectsListCall)Fields

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

func (*ProjectsListCall)Filter

func (c *ProjectsListCall) Filter(filterstring) *ProjectsListCall

Filter sets the optional parameter "filter": An expression for filtering theresults of the request. Filter rules are case insensitive. If multiplefields are included in a filter query, the query will return results thatmatch any of the fields. Some eligible fields for filtering are: + `name` +`id` + `labels.` (where *key* is the name of a label) + `parent.type` +`parent.id` + `lifecycleState` Some examples of filter queries: | Query |Description ||------------------|-----------------------------------------------------| |name:how* | The project's name starts with "how". | | name:Howl | Theproject's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | |NAME:howl | Equivalent to above. | | labels.color:* | The project has thelabel `color`. | | labels.color:red | The project's label `color` has thevalue `red`. | | labels.color:red labels.size:big | The project's label`color` has the value `red` or its label `size` has the value `big`. | |lifecycleState:DELETE_REQUESTED | Only show projects that are pendingdeletion.| If no filter is specified, the call will return projects forwhich the user has the `resourcemanager.projects.get` permission. NOTE: Toperform a by-parent query (eg., what projects are directly in a Folder), thecaller must have the `resourcemanager.projects.list` permission on theparent and the filter must contain both a `parent.type` and a `parent.id`restriction (example: "parent.type:folder parent.id:123"). In this case analternate search index is used which provides more consistent results.

func (*ProjectsListCall)Header

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

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

func (*ProjectsListCall)IfNoneMatch

func (c *ProjectsListCall) IfNoneMatch(entityTagstring) *ProjectsListCall

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

func (c *ProjectsListCall) PageSize(pageSizeint64) *ProjectsListCall

PageSize sets the optional parameter "pageSize": The maximum number ofProjects to return in the response. The server can return fewer Projectsthan requested. If unspecified, server picks an appropriate default.

func (*ProjectsListCall)PageToken

func (c *ProjectsListCall) PageToken(pageTokenstring) *ProjectsListCall

PageToken sets the optional parameter "pageToken": A pagination tokenreturned from a previous call to ListProjects that indicates from wherelisting should continue.

func (*ProjectsListCall)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.

typeProjectsListOrgPoliciesCall

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

func (*ProjectsListOrgPoliciesCall)Context

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

func (*ProjectsListOrgPoliciesCall)Do

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

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

func (*ProjectsListOrgPoliciesCall)Header

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

func (*ProjectsListOrgPoliciesCall)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.

typeProjectsService

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

funcNewProjectsService

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService)ClearOrgPolicy

func (r *ProjectsService) ClearOrgPolicy(resourcestring, clearorgpolicyrequest *ClearOrgPolicyRequest) *ProjectsClearOrgPolicyCall

ClearOrgPolicy: Clears a `Policy` from a resource.

- resource: Name of the resource for the `Policy` to clear.

func (*ProjectsService)Create

func (r *ProjectsService) Create(project *Project) *ProjectsCreateCall

Create: Request that a new Project be created. The result is an Operationwhich can be used to track the creation process. This process usually takesa few seconds, but can sometimes take much longer. The tracking Operation isautomatically deleted after a few hours, so there is no need to callDeleteOperation. Authorization requires the Google IAM permission`resourcemanager.projects.create` on the specified parent for the newproject. The parent is identified by a specified ResourceId, which mustinclude both an ID and a type, such as organization. This method does notassociate the new project with a billing account. You can set or update thebilling account associated with a project using the[`projects.updateBillingInfo`](/billing/reference/rest/v1/projects/updateBillingInfo) method.

func (*ProjectsService)Delete

func (r *ProjectsService) Delete(projectIdstring) *ProjectsDeleteCall

Delete: Marks the Project identified by the specified `project_id` (forexample, `my-project-123`) for deletion. This method will only affect theProject if it has a lifecycle state of ACTIVE. This method changes theProject's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletionstarts at an unspecified time, at which point the Project is no longeraccessible. Until the deletion completes, you can check the lifecycle statechecked by retrieving the Project with GetProject, and the Project remainsvisible to ListProjects. However, you cannot update the project. After thedeletion completes, the Project is not retrievable by the GetProject andListProjects methods. The caller must have delete permissions for thisProject.

- projectId: The Project ID (for example, `foo-bar-123`).

func (*ProjectsService)Get

func (r *ProjectsService) Get(projectIdstring) *ProjectsGetCall

Get: Retrieves the Project identified by the specified `project_id` (forexample, `my-project-123`). The caller must have read permissions for thisProject.

- projectId: The Project ID (for example, `my-project-123`).

func (*ProjectsService)GetAncestry

func (r *ProjectsService) GetAncestry(projectIdstring, getancestryrequest *GetAncestryRequest) *ProjectsGetAncestryCall

GetAncestry: Gets a list of ancestors in the resource hierarchy for theProject identified by the specified `project_id` (for example,`my-project-123`). The caller must have read permissions for this Project.

- projectId: The Project ID (for example, `my-project-123`).

func (*ProjectsService)GetEffectiveOrgPolicy

func (r *ProjectsService) GetEffectiveOrgPolicy(resourcestring, geteffectiveorgpolicyrequest *GetEffectiveOrgPolicyRequest) *ProjectsGetEffectiveOrgPolicyCall

GetEffectiveOrgPolicy: Gets the effective `Policy` on a resource. This isthe result of merging `Policies` in the resource hierarchy. The returned`Policy` will not have an `etag`set because it is a computed `Policy` acrossmultiple resources. Subtrees of Resource Manager resource hierarchy with'under:' prefix will not be expanded.

  • resource: The name of the resource to start computing the effective`Policy`.

func (*ProjectsService)GetIamPolicy

func (r *ProjectsService) GetIamPolicy(resourcestring, getiampolicyrequest *GetIamPolicyRequest) *ProjectsGetIamPolicyCall

GetIamPolicy: Returns the IAM access control policy for the specifiedProject. Permission is denied if the policy or the resource does not exist.Authorization requires the Google IAM permission`resourcemanager.projects.getIamPolicy` on the project. For additionalinformation about `resource` (e.g. my-project-id) structure andidentification, see Resource Names(https://cloud.google.com/apis/design/resource_names).

func (*ProjectsService)GetOrgPolicy

func (r *ProjectsService) GetOrgPolicy(resourcestring, getorgpolicyrequest *GetOrgPolicyRequest) *ProjectsGetOrgPolicyCall

GetOrgPolicy: Gets a `Policy` on a resource. If no `Policy` is set on theresource, a `Policy` is returned with default values including`POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The `etag` value can beused with `SetOrgPolicy()` to create or update a `Policy` duringread-modify-write.

- resource: Name of the resource the `Policy` is set on.

func (*ProjectsService)List

List: Lists Projects that the caller has the `resourcemanager.projects.get`permission on and satisfy the specified filter. This method returns Projectsin an unspecified order. This method is eventually consistent with projectmutations; this means that a newly created project may not appear in theresults or recent updates to an existing project may not be reflected in theresults. To retrieve the latest state of a project, use the GetProjectmethod. NOTE: If the request filter contains a `parent.type` and `parent.id`and the caller has the `resourcemanager.projects.list` permission on theparent, the results will be drawn from an alternate index which providesmore consistent results. In future versions of this API, this List methodwill be split into List and Search to properly capture the behavioraldifference.

func (*ProjectsService)ListAvailableOrgPolicyConstraints

func (r *ProjectsService) ListAvailableOrgPolicyConstraints(resourcestring, listavailableorgpolicyconstraintsrequest *ListAvailableOrgPolicyConstraintsRequest) *ProjectsListAvailableOrgPolicyConstraintsCall

ListAvailableOrgPolicyConstraints: Lists `Constraints` that could be appliedon the specified resource.

- resource: Name of the resource to list `Constraints` for.

func (*ProjectsService)ListOrgPolicies

func (r *ProjectsService) ListOrgPolicies(resourcestring, listorgpoliciesrequest *ListOrgPoliciesRequest) *ProjectsListOrgPoliciesCall

ListOrgPolicies: Lists all the `Policies` set for a particular resource.

- resource: Name of the resource to list Policies for.

func (*ProjectsService)SetIamPolicy

func (r *ProjectsService) SetIamPolicy(resourcestring, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSetIamPolicyCall

SetIamPolicy: Sets the IAM access control policy for the specified Project.CAUTION: This method will replace the existing policy, and cannot be used toappend additional IAM settings. NOTE: Removing service accounts frompolicies or changing their roles can render services completely inoperable.It is important to understand how the service account is being used beforeremoving or updating its roles. For additional information about `resource`(e.g. my-project-id) structure and identification, see Resource Names(https://cloud.google.com/apis/design/resource_names). The followingconstraints apply when using `setIamPolicy()`: + Project does not support`allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a`Policy`. + The owner role can be granted to a `user`, `serviceAccount`, ora group that is part of an organization. For example,group@myownpersonaldomain.com could be added as an owner to a project in themyownpersonaldomain.com organization, but not the examplepetstore.comorganization. + Service accounts can be made owners of a project directlywithout any restrictions. However, to be added as an owner, a user must beinvited via Cloud Platform console and must accept the invitation. + A usercannot be granted the owner role using `setIamPolicy()`. The user must begranted the owner role using the Cloud Platform Console and must explicitlyaccept the invitation. + You can only grant ownership of a project to amember by using the Google Cloud console. Inviting a member will deliver aninvitation email that they must accept. An invitation email is not generatedif you are granting a role other than owner, or if both the member you areinviting and the project are part of your organization. + If the project isnot part of an organization, there must be at least one owner who hasaccepted the Terms of Service (ToS) agreement in the policy. Calling`setIamPolicy()` to remove the last ToS-accepted owner from the policy willfail. This restriction also applies to legacy projects that no longer haveowners who have accepted the ToS. Edits to IAM policies will be rejecteduntil the lack of a ToS-accepting owner is rectified. If the project is partof an organization, you can remove all owners, potentially making theorganization inaccessible. Authorization requires the Google IAM permission`resourcemanager.projects.setIamPolicy` on the project

func (*ProjectsService)SetOrgPolicy

func (r *ProjectsService) SetOrgPolicy(resourcestring, setorgpolicyrequest *SetOrgPolicyRequest) *ProjectsSetOrgPolicyCall

SetOrgPolicy: Updates the specified `Policy` on the resource. Creates a new`Policy` for that `Constraint` on the resource if one does not exist. Notsupplying an `etag` on the request `Policy` results in an unconditionalwrite of the `Policy`.

- resource: Resource name of the resource to attach the `Policy`.

func (*ProjectsService)TestIamPermissions

func (r *ProjectsService) TestIamPermissions(resourcestring, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specifiedProject. For additional information about `resource` (e.g. my-project-id)structure and identification, see Resource Names(https://cloud.google.com/apis/design/resource_names). There are nopermissions required for making this API call.

func (*ProjectsService)Undelete

func (r *ProjectsService) Undelete(projectIdstring, undeleteprojectrequest *UndeleteProjectRequest) *ProjectsUndeleteCall

Undelete: Restores the Project identified by the specified `project_id` (forexample, `my-project-123`). You can only use this method for a Project thathas a lifecycle state of DELETE_REQUESTED. After deletion starts, theProject cannot be restored. The caller must have undelete permissions forthis Project.

- projectId: The project ID (for example, `foo-bar-123`).

func (*ProjectsService)Update

func (r *ProjectsService) Update(projectIdstring, project *Project) *ProjectsUpdateCall

Update: Updates the attributes of the Project identified by the specified`project_id` (for example, `my-project-123`). The caller must have modifypermissions for this Project.

- projectId: The project ID (for example, `my-project-123`).

typeProjectsSetIamPolicyCall

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

func (*ProjectsSetIamPolicyCall)Context

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

func (*ProjectsSetIamPolicyCall)Do

Do executes the "cloudresourcemanager.projects.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSetIamPolicyCall)Fields

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

func (*ProjectsSetIamPolicyCall)Header

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

typeProjectsSetOrgPolicyCall

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

func (*ProjectsSetOrgPolicyCall)Context

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

func (*ProjectsSetOrgPolicyCall)Do

Do executes the "cloudresourcemanager.projects.setOrgPolicy" call.Any non-2xx status code is an error. Response headers are in either*OrgPolicy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSetOrgPolicyCall)Fields

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

func (*ProjectsSetOrgPolicyCall)Header

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

typeProjectsTestIamPermissionsCall

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

func (*ProjectsTestIamPermissionsCall)Context

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

func (*ProjectsTestIamPermissionsCall)Do

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

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

func (*ProjectsTestIamPermissionsCall)Header

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

typeProjectsUndeleteCall

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

func (*ProjectsUndeleteCall)Context

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

func (*ProjectsUndeleteCall)Do

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

func (*ProjectsUndeleteCall)Fields

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

func (*ProjectsUndeleteCall)Header

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

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

typeProjectsUpdateCall

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

func (*ProjectsUpdateCall)Context

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

func (*ProjectsUpdateCall)Do

Do executes the "cloudresourcemanager.projects.update" call.Any non-2xx status code is an error. Response headers are in either*Project.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsUpdateCall)Fields

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

func (*ProjectsUpdateCall)Header

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

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

typeResourceId

type ResourceId struct {// Id: The type-specific id. This should correspond to the id used in the// type-specific API's.Idstring `json:"id,omitempty"`// Type: The resource type this id is for. At present, the valid types are:// "organization", "folder", and "project".Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Id") 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. "Id") 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:"-"`}

ResourceId: A container to reference an id for any resource type. A`resource` in Google Cloud Platform is a generic term for something you (adeveloper) may want to interact with through one of our API's. Some examplesare an App Engine app, a Compute Engine instance, a Cloud SQL database, andso on.

func (ResourceId)MarshalJSON

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

typeRestoreDefault

type RestoreDefault struct {}

RestoreDefault: Ignores policies set above this resource and restores the`constraint_default` enforcement behavior of the specific `Constraint` atthis resource. Suppose that `constraint_default` is set to `ALLOW` for the`Constraint` `constraints/serviceuser.services`. Suppose that organizationfoo.com sets a `Policy` at their Organization resource node that restrictsthe allowed service activations to deny all service activations. They couldthen set a `Policy` with the `policy_type` `restore_default` on severalexperimental projects, restoring the `constraint_default` enforcement of the`Constraint` for only those projects, allowing those projects to have allservices activated.

typeSearchOrganizationsRequest

type SearchOrganizationsRequest struct {// Filter: An optional query string used to filter the Organizations to return// in the response. Filter rules are case-insensitive. Organizations may be// filtered by `owner.directoryCustomerId` or by `domain`, where the domain is// a verified G Suite domain, for example: * Filter// `owner.directorycustomerid:123456789` returns Organization resources with// `owner.directory_customer_id` equal to `123456789`. * Filter// `domain:google.com` returns Organization resources corresponding to the// domain `google.com`. This field is optional.Filterstring `json:"filter,omitempty"`// PageSize: The maximum number of Organizations to return in the response. The// server can return fewer organizations than requested. If unspecified, server// picks an appropriate default.PageSizeint64 `json:"pageSize,omitempty"`// PageToken: A pagination token returned from a previous call to// `SearchOrganizations` that indicates from where listing should continue.// This field is optional.PageTokenstring `json:"pageToken,omitempty"`// ForceSendFields is a list of field names (e.g. "Filter") 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. "Filter") 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:"-"`}

SearchOrganizationsRequest: The request sent to the `SearchOrganizations`method.

func (SearchOrganizationsRequest)MarshalJSON

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

typeSearchOrganizationsResponse

type SearchOrganizationsResponse struct {// NextPageToken: A pagination token to be used to retrieve the next page of// results. If the result is too large to fit within the page size specified in// the request, this field will be set with a token that can be used to fetch// the next page of results. If this field is empty, it indicates that this// response contains the last page of results.NextPageTokenstring `json:"nextPageToken,omitempty"`// Organizations: The list of Organizations that matched the search query,// possibly paginated.Organizations []*Organization `json:"organizations,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:"-"`}

SearchOrganizationsResponse: The response returned from the`SearchOrganizations` method.

func (SearchOrganizationsResponse)MarshalJSON

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

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentFolders *FoldersServiceLiens *LiensServiceOperations *OperationsServiceOrganizations *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.

funcNewServiceadded inv0.3.0

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

NewService creates a new Service.

typeSetIamPolicyRequest

type SetIamPolicyRequest struct {// Policy: REQUIRED: The complete policy to be applied to the `resource`. The// size of the policy is limited to a few 10s of KB. An empty policy is a valid// policy but certain Google Cloud services (such as Projects) might reject// them.Policy *Policy `json:"policy,omitempty"`// UpdateMask: OPTIONAL: A FieldMask specifying which fields of the policy to// modify. Only the fields in the mask will be modified. If no mask is// provided, the following default mask is used: `paths: "bindings, etag"UpdateMaskstring `json:"updateMask,omitempty"`// ForceSendFields is a list of field names (e.g. "Policy") 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. "Policy") 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:"-"`}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (SetIamPolicyRequest)MarshalJSON

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

typeSetOrgPolicyRequest

type SetOrgPolicyRequest struct {// Policy: `Policy` to set on the resource.Policy *OrgPolicy `json:"policy,omitempty"`// ForceSendFields is a list of field names (e.g. "Policy") 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. "Policy") 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:"-"`}

SetOrgPolicyRequest: The request sent to the SetOrgPolicyRequest method.

func (SetOrgPolicyRequest)MarshalJSON

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

typeStatus

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

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

func (Status)MarshalJSON

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

typeTestIamPermissionsRequest

type TestIamPermissionsRequest struct {// Permissions: The set of permissions to check for the `resource`. Permissions// with wildcards (such as `*` or `storage.*`) are not allowed. For more// information see IAM Overview// (https://cloud.google.com/iam/docs/overview#permissions).Permissions []string `json:"permissions,omitempty"`// ForceSendFields is a list of field names (e.g. "Permissions") 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. "Permissions") 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:"-"`}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (TestIamPermissionsRequest)MarshalJSON

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

typeTestIamPermissionsResponse

type TestIamPermissionsResponse struct {// Permissions: A subset of `TestPermissionsRequest.permissions` that the// caller is allowed.Permissions []string `json:"permissions,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Permissions") 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. "Permissions") 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:"-"`}

TestIamPermissionsResponse: Response message for `TestIamPermissions`method.

func (TestIamPermissionsResponse)MarshalJSON

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

typeUndeleteFolderMetadataadded inv0.36.0

type UndeleteFolderMetadata struct {}

UndeleteFolderMetadata: A status object which is used as the `metadata`field for the `Operation` returned by `UndeleteFolder`.

typeUndeleteOrganizationMetadataadded inv0.36.0

type UndeleteOrganizationMetadata struct {}

UndeleteOrganizationMetadata: A status object which is used as the`metadata` field for the Operation returned by UndeleteOrganization.

typeUndeleteProjectMetadataadded inv0.36.0

type UndeleteProjectMetadata struct {}

UndeleteProjectMetadata: A status object which is used as the `metadata`field for the Operation returned by `UndeleteProject`.

typeUndeleteProjectRequest

type UndeleteProjectRequest struct {}

UndeleteProjectRequest: The request sent to the UndeleteProject method.

typeUpdateFolderMetadataadded inv0.36.0

type UpdateFolderMetadata struct {}

UpdateFolderMetadata: A status object which is used as the `metadata` fieldfor the Operation returned by UpdateFolder.

typeUpdateProjectMetadataadded inv0.36.0

type UpdateProjectMetadata struct {}

UpdateProjectMetadata: A status object which is used as the `metadata` fieldfor the Operation returned by UpdateProject.

typeUpdateTagKeyMetadataadded inv0.36.0

type UpdateTagKeyMetadata struct {}

UpdateTagKeyMetadata: Runtime operation information for updating a TagKey.

typeUpdateTagValueMetadataadded inv0.36.0

type UpdateTagValueMetadata struct {}

UpdateTagValueMetadata: Runtime operation information for updating aTagValue.

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