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

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/v3"...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

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)

typeCapabilityadded inv0.231.0

type Capability struct {// Name: Immutable. Identifier. The resource name of the capability. Must be in// the following form: * `folders/{folder_id}/capabilities/{capability_name}`// For example, `folders/123/capabilities/app-management` Following are the// allowed {capability_name} values: * `app-management`Namestring `json:"name,omitempty"`// Value: Required. The configured value of the capability at the given parent// resource.Valuebool `json:"value,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Capability: Representation of a Capability.

func (Capability)MarshalJSONadded inv0.231.0

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

typeCloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation

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)MarshalJSON

typeCloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation

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)MarshalJSON

typeCreateFolderMetadataadded inv0.43.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.43.0

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

typeCreateProjectMetadataadded inv0.43.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.43.0

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

typeCreateTagBindingMetadataadded inv0.45.0

type CreateTagBindingMetadata struct {}

CreateTagBindingMetadata: Runtime operation information for creating aTagValue.

typeCreateTagKeyMetadata

type CreateTagKeyMetadata struct {}

CreateTagKeyMetadata: Runtime operation information for creating a TagKey.

typeCreateTagValueMetadata

type CreateTagValueMetadata struct {}

CreateTagValueMetadata: Runtime operation information for creating aTagValue.

typeDeleteFolderMetadataadded inv0.43.0

type DeleteFolderMetadata struct {}

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

typeDeleteOrganizationMetadataadded inv0.43.0

type DeleteOrganizationMetadata struct {}

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

typeDeleteProjectMetadataadded inv0.43.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.

typeDeleteTagKeyMetadata

type DeleteTagKeyMetadata struct {}

DeleteTagKeyMetadata: Runtime operation information for deleting a TagKey.

typeDeleteTagValueMetadata

type DeleteTagValueMetadata struct {}

DeleteTagValueMetadata: Runtime operation information for deleting aTagValue.

typeEffectiveTagadded inv0.78.0

type EffectiveTag struct {// Inherited: Indicates the inheritance status of a tag value attached to the// given resource. If the tag value is inherited from one of the resource's// ancestors, inherited will be true. If false, then the tag value is directly// attached to the resource, inherited will be false.Inheritedbool `json:"inherited,omitempty"`// NamespacedTagKey: The namespaced name of the TagKey. Can be in the form// `{organization_id}/{tag_key_short_name}` or// `{project_id}/{tag_key_short_name}` or// `{project_number}/{tag_key_short_name}`.NamespacedTagKeystring `json:"namespacedTagKey,omitempty"`// NamespacedTagValue: The namespaced name of the TagValue. Can be in the form// `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or// `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or// `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.NamespacedTagValuestring `json:"namespacedTagValue,omitempty"`// TagKey: The name of the TagKey, in the format `tagKeys/{id}`, such as// `tagKeys/123`.TagKeystring `json:"tagKey,omitempty"`// TagKeyParentName: The parent name of the tag key. Must be in the format// `organizations/{organization_id}` or `projects/{project_number}`TagKeyParentNamestring `json:"tagKeyParentName,omitempty"`// TagValue: Resource name for TagValue in the format `tagValues/456`.TagValuestring `json:"tagValue,omitempty"`// ForceSendFields is a list of field names (e.g. "Inherited") 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. "Inherited") 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:"-"`}

EffectiveTag: An EffectiveTag represents a tag that applies to a resourceduring policy evaluation. Tags can be either directly bound to a resource orinherited from its ancestor. EffectiveTag contains the name andnamespaced_name of the tag value and tag key, with additional fields of`inherited` to indicate the inheritance status of the effective tag.

func (EffectiveTag)MarshalJSONadded inv0.78.0

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

typeEffectiveTagBindingCollectionadded inv0.236.0

type EffectiveTagBindingCollection struct {// EffectiveTags: Tag keys/values effectively bound to this resource, specified// in namespaced format. For example: "123/environment": "production"EffectiveTags map[string]string `json:"effectiveTags,omitempty"`// FullResourceName: The full resource name of the resource the TagBindings are// bound to. E.g. `//cloudresourcemanager.googleapis.com/projects/123`FullResourceNamestring `json:"fullResourceName,omitempty"`// Name: Identifier. The name of the EffectiveTagBindingCollection, following// the convention:// `locations/{location}/effectiveTagBindingCollections/{encoded-full-resource-n// ame}` where the encoded-full-resource-name is the UTF-8 encoded name of the// GCP resource the TagBindings are bound to. E.g.// "locations/global/effectiveTagBindingCollections/%2f%2fcloudresourcemanager.g// oogleapis.com%2fprojects%2f123"Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "EffectiveTags") 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. "EffectiveTags") 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:"-"`}

EffectiveTagBindingCollection: Represents a collection of effective tagbindings for a GCP resource.

func (EffectiveTagBindingCollection)MarshalJSONadded inv0.236.0

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

typeEffectiveTagsListCalladded inv0.78.0

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

func (*EffectiveTagsListCall)Contextadded inv0.78.0

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

func (*EffectiveTagsListCall)Doadded inv0.78.0

Do executes the "cloudresourcemanager.effectiveTags.list" call.Any non-2xx status code is an error. Response headers are in either*ListEffectiveTagsResponse.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 (*EffectiveTagsListCall)Fieldsadded inv0.78.0

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

func (*EffectiveTagsListCall)Headeradded inv0.78.0

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

func (*EffectiveTagsListCall)IfNoneMatchadded inv0.78.0

func (c *EffectiveTagsListCall) IfNoneMatch(entityTagstring) *EffectiveTagsListCall

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 (*EffectiveTagsListCall)PageSizeadded inv0.78.0

PageSize sets the optional parameter "pageSize": The maximum number ofeffective tags to return in the response. The server allows a maximum of 300effective tags to return in a single page. If unspecified, the server willuse 100 as the default.

func (*EffectiveTagsListCall)PageTokenadded inv0.78.0

func (c *EffectiveTagsListCall) PageToken(pageTokenstring) *EffectiveTagsListCall

PageToken sets the optional parameter "pageToken": A pagination tokenreturned from a previous call to `ListEffectiveTags` that indicates fromwhere this listing should continue.

func (*EffectiveTagsListCall)Pagesadded inv0.78.0

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

func (*EffectiveTagsListCall)Parentadded inv0.78.0

Parent sets the optional parameter "parent": Required. The full resourcename of a resource for which you want to list the effective tags. E.g."//cloudresourcemanager.googleapis.com/projects/123"

typeEffectiveTagsServiceadded inv0.78.0

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

funcNewEffectiveTagsServiceadded inv0.78.0

func NewEffectiveTagsService(s *Service) *EffectiveTagsService

func (*EffectiveTagsService)Listadded inv0.78.0

List: Return a list of effective tags for the given Google Cloud resource,as specified in `parent`.

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)

typeFolderadded inv0.43.0

type Folder struct {// ConfiguredCapabilities: Output only. Optional capabilities configured for// this folder (via UpdateCapability API). Example:// `folders/123/capabilities/app-management`.ConfiguredCapabilities []string `json:"configuredCapabilities,omitempty"`// CreateTime: Output only. Timestamp when the folder was created.CreateTimestring `json:"createTime,omitempty"`// DeleteTime: Output only. Timestamp when the folder was requested to be// deleted.DeleteTimestring `json:"deleteTime,omitempty"`// DisplayName: The folder's display name. A folder's display name must be// unique amongst its siblings. For example, no two folders with the same// parent can share the same display name. The display name must start and end// with a letter or digit, may contain letters, digits, spaces, hyphens and// underscores and can be no longer than 30 characters. This is captured by the// regular expression: `[\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?`.DisplayNamestring `json:"displayName,omitempty"`// Etag: Output only. A checksum computed by the server based on the current// value of the folder resource. This may be sent on update and delete requests// to ensure the client has an up-to-date value before proceeding.Etagstring `json:"etag,omitempty"`// ManagementProject: Output only. Management Project associated with this// folder (if app-management capability is enabled). Example:// `projects/google-mp-123` OUTPUT ONLY.ManagementProjectstring `json:"managementProject,omitempty"`// Name: Identifier. The resource name of the folder. Its format is// `folders/{folder_id}`, for example: "folders/1234".Namestring `json:"name,omitempty"`// Parent: Required. The folder's parent's resource name. Updates to the// folder's parent must be performed using MoveFolder.Parentstring `json:"parent,omitempty"`// State: Output only. The lifecycle state of the folder. Updates to the state// must be performed using DeleteFolder and UndeleteFolder.//// Possible values://   "STATE_UNSPECIFIED" - Unspecified state.//   "ACTIVE" - The normal and active state.//   "DELETE_REQUESTED" - The folder has been marked for deletion by the user.Statestring `json:"state,omitempty"`// Tags: Optional. Input only. Immutable. Tag keys/values directly bound to// this folder. 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"`// UpdateTime: Output only. Timestamp when the folder was last modified.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "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:"-"`}

Folder: A folder in an organization's resource hierarchy, used to organizethat organization's resources.

func (Folder)MarshalJSONadded inv0.43.0

func (sFolder) 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)

typeFoldersCapabilitiesGetCalladded inv0.231.0

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

func (*FoldersCapabilitiesGetCall)Contextadded inv0.231.0

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

func (*FoldersCapabilitiesGetCall)Doadded inv0.231.0

Do executes the "cloudresourcemanager.folders.capabilities.get" call.Any non-2xx status code is an error. Response headers are in either*Capability.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 (*FoldersCapabilitiesGetCall)Fieldsadded inv0.231.0

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

func (*FoldersCapabilitiesGetCall)Headeradded inv0.231.0

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

func (*FoldersCapabilitiesGetCall)IfNoneMatchadded inv0.231.0

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

typeFoldersCapabilitiesPatchCalladded inv0.231.0

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

func (*FoldersCapabilitiesPatchCall)Contextadded inv0.231.0

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

func (*FoldersCapabilitiesPatchCall)Doadded inv0.231.0

Do executes the "cloudresourcemanager.folders.capabilities.patch" 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 (*FoldersCapabilitiesPatchCall)Fieldsadded inv0.231.0

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

func (*FoldersCapabilitiesPatchCall)Headeradded inv0.231.0

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

func (*FoldersCapabilitiesPatchCall)UpdateMaskadded inv0.231.0

UpdateMask sets the optional parameter "updateMask": The list of fields toupdate. Only [Capability.value] can be updated.

typeFoldersCapabilitiesServiceadded inv0.231.0

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

funcNewFoldersCapabilitiesServiceadded inv0.231.0

func NewFoldersCapabilitiesService(s *Service) *FoldersCapabilitiesService

func (*FoldersCapabilitiesService)Getadded inv0.231.0

Get: Retrieves the Capability identified by the supplied resource name.

  • name: The name of the capability to get. For example,`folders/123/capabilities/app-management`.

func (*FoldersCapabilitiesService)Patchadded inv0.231.0

Patch: Updates the Capability.

  • name: Immutable. Identifier. The resource name of the capability. Must bein the following form: *`folders/{folder_id}/capabilities/{capability_name}` For example,`folders/123/capabilities/app-management` Following are the allowed{capability_name} values: * `app-management`.

typeFoldersCreateCalladded inv0.43.0

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

func (*FoldersCreateCall)Contextadded inv0.43.0

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

func (*FoldersCreateCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.folders.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 (*FoldersCreateCall)Fieldsadded inv0.43.0

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

func (*FoldersCreateCall)Headeradded inv0.43.0

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

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

typeFoldersDeleteCalladded inv0.43.0

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

func (*FoldersDeleteCall)Contextadded inv0.43.0

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

func (*FoldersDeleteCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.folders.delete" 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 (*FoldersDeleteCall)Fieldsadded inv0.43.0

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

func (*FoldersDeleteCall)Headeradded inv0.43.0

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

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

typeFoldersGetCalladded inv0.43.0

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

func (*FoldersGetCall)Contextadded inv0.43.0

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

func (*FoldersGetCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.folders.get" call.Any non-2xx status code is an error. Response headers are in either*Folder.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 (*FoldersGetCall)Fieldsadded inv0.43.0

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

func (*FoldersGetCall)Headeradded inv0.43.0

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

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

func (*FoldersGetCall)IfNoneMatchadded inv0.43.0

func (c *FoldersGetCall) IfNoneMatch(entityTagstring) *FoldersGetCall

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.

typeFoldersGetIamPolicyCalladded inv0.43.0

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

func (*FoldersGetIamPolicyCall)Contextadded inv0.43.0

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

func (*FoldersGetIamPolicyCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.folders.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 (*FoldersGetIamPolicyCall)Fieldsadded inv0.43.0

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

func (*FoldersGetIamPolicyCall)Headeradded inv0.43.0

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

typeFoldersListCalladded inv0.43.0

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

func (*FoldersListCall)Contextadded inv0.43.0

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

func (*FoldersListCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.folders.list" call.Any non-2xx status code is an error. Response headers are in either*ListFoldersResponse.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 (*FoldersListCall)Fieldsadded inv0.43.0

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

func (*FoldersListCall)Headeradded inv0.43.0

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

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

func (*FoldersListCall)IfNoneMatchadded inv0.43.0

func (c *FoldersListCall) IfNoneMatch(entityTagstring) *FoldersListCall

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 (*FoldersListCall)PageSizeadded inv0.43.0

func (c *FoldersListCall) PageSize(pageSizeint64) *FoldersListCall

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

func (*FoldersListCall)PageTokenadded inv0.43.0

func (c *FoldersListCall) PageToken(pageTokenstring) *FoldersListCall

PageToken sets the optional parameter "pageToken": A pagination tokenreturned from a previous call to `ListFolders` that indicates where thislisting should continue from.

func (*FoldersListCall)Pagesadded inv0.43.0

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

func (*FoldersListCall)Parentadded inv0.43.0

func (c *FoldersListCall) Parent(parentstring) *FoldersListCall

Parent sets the optional parameter "parent": Required. The name of theparent resource whose folders are being listed. Only children of this parentresource are listed; descendants are not listed. If the parent is a folder,use the value `folders/{folder_id}`. If the parent is an organization, usethe value `organizations/{org_id}`. Access to this method is controlled bychecking the `resourcemanager.folders.list` permission on the `parent`.

func (*FoldersListCall)ShowDeletedadded inv0.43.0

func (c *FoldersListCall) ShowDeleted(showDeletedbool) *FoldersListCall

ShowDeleted sets the optional parameter "showDeleted": Controls whetherfolders in the DELETE_REQUESTED state should be returned. Defaults to false.

typeFoldersMoveCalladded inv0.43.0

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

func (*FoldersMoveCall)Contextadded inv0.43.0

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

func (*FoldersMoveCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.folders.move" 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 (*FoldersMoveCall)Fieldsadded inv0.43.0

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

func (*FoldersMoveCall)Headeradded inv0.43.0

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

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

typeFoldersPatchCalladded inv0.43.0

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

func (*FoldersPatchCall)Contextadded inv0.43.0

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

func (*FoldersPatchCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.folders.patch" 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 (*FoldersPatchCall)Fieldsadded inv0.43.0

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

func (*FoldersPatchCall)Headeradded inv0.43.0

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

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

func (*FoldersPatchCall)UpdateMaskadded inv0.43.0

func (c *FoldersPatchCall) UpdateMask(updateMaskstring) *FoldersPatchCall

UpdateMask sets the optional parameter "updateMask": Required. Fields to beupdated. Only the `display_name` can be updated.

typeFoldersSearchCalladded inv0.43.0

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

func (*FoldersSearchCall)Contextadded inv0.43.0

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

func (*FoldersSearchCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.folders.search" call.Any non-2xx status code is an error. Response headers are in either*SearchFoldersResponse.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 (*FoldersSearchCall)Fieldsadded inv0.43.0

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

func (*FoldersSearchCall)Headeradded inv0.43.0

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

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

func (*FoldersSearchCall)IfNoneMatchadded inv0.43.0

func (c *FoldersSearchCall) IfNoneMatch(entityTagstring) *FoldersSearchCall

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 (*FoldersSearchCall)PageSizeadded inv0.43.0

func (c *FoldersSearchCall) PageSize(pageSizeint64) *FoldersSearchCall

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

func (*FoldersSearchCall)PageTokenadded inv0.43.0

func (c *FoldersSearchCall) PageToken(pageTokenstring) *FoldersSearchCall

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

func (*FoldersSearchCall)Pagesadded inv0.43.0

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

func (*FoldersSearchCall)Queryadded inv0.43.0

Query sets the optional parameter "query": Search criteria used to selectthe folders to return. If no search criteria is specified then allaccessible folders will be returned. Query expressions can be used torestrict results based upon displayName, state and parent, where theoperators `=` (`:`) `NOT`, `AND` and `OR` can be used along with the suffixwildcard symbol `*`. The `displayName` field in a query expression shoulduse escaped quotes for values that include whitespace to prevent unexpectedbehavior. ``` | Field | Description ||-------------------------|----------------------------------------| |displayName | Filters by displayName. | | parent | Filters by parent (forexample: folders/123). | | state, lifecycleState | Filters by state. | ```Some example queries are: * Query `displayName=Test*` returns Folderresources whose display name starts with "Test". * Query `state=ACTIVE`returns Folder resources with `state` set to `ACTIVE`. * Query`parent=folders/123` returns Folder resources that have `folders/123` as aparent resource. * Query `parent=folders/123 AND state=ACTIVE` returnsactive Folder resources that have `folders/123` as a parent resource. *Query `displayName=\\"Test String\\" returns Folder resources with displaynames that include both "Test" and "String".

typeFoldersServiceadded inv0.43.0

type FoldersService struct {Capabilities *FoldersCapabilitiesService// contains filtered or unexported fields}

funcNewFoldersServiceadded inv0.43.0

func NewFoldersService(s *Service) *FoldersService

func (*FoldersService)Createadded inv0.43.0

func (r *FoldersService) Create(folder *Folder) *FoldersCreateCall

Create: Creates a folder in the resource hierarchy. Returns an `Operation`which can be used to track the progress of the folder creation workflow.Upon success, the `Operation.response` field will be populated with thecreated Folder. In order to succeed, the addition of this new folder mustnot violate the folder naming, height, or fanout constraints. + The folder's`display_name` must be distinct from all other folders that share itsparent. + The addition of the folder must not cause the active folderhierarchy to exceed a height of 10. Note, the full active + deleted folderhierarchy is allowed to reach a height of 20; this provides additionalheadroom when moving folders that contain deleted folders. + The addition ofthe folder must not cause the total number of folders under its parent toexceed 300. If the operation fails due to a folder constraint violation,some errors may be returned by the `CreateFolder` request, with status code`FAILED_PRECONDITION` and an error description. Other folder constraintviolations will be communicated in the `Operation`, with the specific`PreconditionFailure` returned in the details list in the `Operation.error`field. The caller must have `resourcemanager.folders.create` permission onthe identified parent.

func (*FoldersService)Deleteadded inv0.43.0

func (r *FoldersService) Delete(namestring) *FoldersDeleteCall

Delete: Requests deletion of a folder. The folder is moved into theDELETE_REQUESTED state immediately, and is deleted approximately 30 dayslater. This method may only be called on an empty folder, where a folder isempty if it doesn't contain any folders or projects in the ACTIVE state. Ifcalled on a folder in DELETE_REQUESTED state the operation will result in ano-op success. The caller must have `resourcemanager.folders.delete`permission on the identified folder.

  • name: The resource name of the folder to be deleted. Must be of the form`folders/{folder_id}`.

func (*FoldersService)Getadded inv0.43.0

Get: Retrieves a folder identified by the supplied resource name. Validfolder resource names have the format `folders/{folder_id}` (for example,`folders/1234`). The caller must have `resourcemanager.folders.get`permission on the identified folder.

  • name: The resource name of the folder to retrieve. Must be of the form`folders/{folder_id}`.

func (*FoldersService)GetIamPolicyadded inv0.43.0

func (r *FoldersService) GetIamPolicy(resourcestring, getiampolicyrequest *GetIamPolicyRequest) *FoldersGetIamPolicyCall

GetIamPolicy: Gets the access control policy for a folder. The returnedpolicy may be empty if no such policy or resource exists. The `resource`field should be the folder's resource name, for example: "folders/1234". Thecaller must have `resourcemanager.folders.getIamPolicy` permission on theidentified folder.

func (*FoldersService)Listadded inv0.43.0

List: Lists the folders that are direct descendants of supplied parentresource. `list()` provides a strongly consistent view of the foldersunderneath the specified parent resource. `list()` returns folders sortedbased upon the (ascending) lexical ordering of their display_name. Thecaller must have `resourcemanager.folders.list` permission on the identifiedparent.

func (*FoldersService)Moveadded inv0.43.0

func (r *FoldersService) Move(namestring, movefolderrequest *MoveFolderRequest) *FoldersMoveCall

Move: Moves a folder under a new resource parent. Returns an `Operation`which can be used to track the progress of the folder move workflow. Uponsuccess, the `Operation.response` field will be populated with the movedfolder. Upon failure, a `FolderOperationError` categorizing the failurecause will be returned - if the failure occurs synchronously then the`FolderOperationError` will be returned in the `Status.details` field. If itoccurs asynchronously, then the FolderOperation will be returned in the`Operation.error` field. In addition, the `Operation.metadata` field will bepopulated with a `FolderOperation` message as an aid to stateless clients.Folder moves will be rejected if they violate either the naming, height, orfanout constraints described in the CreateFolder documentation. The callermust have `resourcemanager.folders.move` permission on the folder's currentand proposed new parent.

  • name: The resource name of the Folder to move. Must be of the formfolders/{folder_id}.

func (*FoldersService)Patchadded inv0.43.0

func (r *FoldersService) Patch(namestring, folder *Folder) *FoldersPatchCall

Patch: Updates a folder, changing its `display_name`. Changes to the folder`display_name` will be rejected if they violate either the `display_name`formatting rules or the naming constraints described in the CreateFolderdocumentation. The folder's `display_name` must start and end with a letteror digit, may contain letters, digits, spaces, hyphens and underscores andcan be between 3 and 30 characters. This is captured by the regularexpression: `\p{L}\p{N}{1,28}[\p{L}\p{N}]`. The caller must have`resourcemanager.folders.update` permission on the identified folder. If theupdate fails due to the unique name constraint then a `PreconditionFailure`explaining this violation will be returned in the Status.details field.

  • name: Identifier. The resource name of the folder. Its format is`folders/{folder_id}`, for example: "folders/1234".

func (*FoldersService)Searchadded inv0.43.0

func (r *FoldersService) Search() *FoldersSearchCall

Search: Search for folders that match specific filter criteria. `search()`provides an eventually consistent view of the folders a user has access towhich meet the specified filter criteria. This will only return folders onwhich the caller has the permission `resourcemanager.folders.get`.

func (*FoldersService)SetIamPolicyadded inv0.43.0

func (r *FoldersService) SetIamPolicy(resourcestring, setiampolicyrequest *SetIamPolicyRequest) *FoldersSetIamPolicyCall

SetIamPolicy: Sets the access control policy on a folder, replacing anyexisting policy. The `resource` field should be the folder's resource name,for example: "folders/1234". The caller must have`resourcemanager.folders.setIamPolicy` permission on the identified folder.

func (*FoldersService)TestIamPermissionsadded inv0.43.0

func (r *FoldersService) TestIamPermissions(resourcestring, testiampermissionsrequest *TestIamPermissionsRequest) *FoldersTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specifiedfolder. The `resource` field should be the folder's resource name, forexample: "folders/1234". There are no permissions required for making thisAPI call.

func (*FoldersService)Undeleteadded inv0.43.0

func (r *FoldersService) Undelete(namestring, undeletefolderrequest *UndeleteFolderRequest) *FoldersUndeleteCall

Undelete: Cancels the deletion request for a folder. This method may becalled on a folder in any state. If the folder is in the ACTIVE state theresult will be a no-op success. In order to succeed, the folder's parentmust be in the ACTIVE state. In addition, reintroducing the folder into thetree must not violate folder naming, height, and fanout constraintsdescribed in the CreateFolder documentation. The caller must have`resourcemanager.folders.undelete` permission on the identified folder.

  • name: The resource name of the folder to undelete. Must be of the form`folders/{folder_id}`.

typeFoldersSetIamPolicyCalladded inv0.43.0

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

func (*FoldersSetIamPolicyCall)Contextadded inv0.43.0

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

func (*FoldersSetIamPolicyCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.folders.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 (*FoldersSetIamPolicyCall)Fieldsadded inv0.43.0

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

func (*FoldersSetIamPolicyCall)Headeradded inv0.43.0

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

typeFoldersTestIamPermissionsCalladded inv0.43.0

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

func (*FoldersTestIamPermissionsCall)Contextadded inv0.43.0

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

func (*FoldersTestIamPermissionsCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.folders.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 (*FoldersTestIamPermissionsCall)Fieldsadded inv0.43.0

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

func (*FoldersTestIamPermissionsCall)Headeradded inv0.43.0

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

typeFoldersUndeleteCalladded inv0.43.0

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

func (*FoldersUndeleteCall)Contextadded inv0.43.0

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

func (*FoldersUndeleteCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.folders.undelete" 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 (*FoldersUndeleteCall)Fieldsadded inv0.43.0

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

func (*FoldersUndeleteCall)Headeradded inv0.43.0

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

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

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)MarshalJSON

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

typeGetPolicyOptions

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)MarshalJSON

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

typeListEffectiveTagsResponseadded inv0.78.0

type ListEffectiveTagsResponse struct {// EffectiveTags: A possibly paginated list of effective tags for the specified// resource.EffectiveTags []*EffectiveTag `json:"effectiveTags,omitempty"`// 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"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "EffectiveTags") 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. "EffectiveTags") 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:"-"`}

ListEffectiveTagsResponse: The response of ListEffectiveTags.

func (ListEffectiveTagsResponse)MarshalJSONadded inv0.78.0

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

typeListFoldersResponseadded inv0.43.0

type ListFoldersResponse struct {// Folders: A possibly paginated list of folders that are direct descendants of// the specified parent resource.Folders []*Folder `json:"folders,omitempty"`// NextPageToken: A pagination token returned from a previous call to// `ListFolders` that indicates from where listing should continue.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. "Folders") 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. "Folders") 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:"-"`}

ListFoldersResponse: The ListFolders response message.

func (ListFoldersResponse)MarshalJSONadded inv0.43.0

func (sListFoldersResponse) 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)

typeListProjectsResponseadded inv0.43.0

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 under the parent. 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. NOTE: A response may contain fewer elementsthan the request `page_size` and still have a `next_page_token`.

func (ListProjectsResponse)MarshalJSONadded inv0.43.0

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

typeListTagBindingsResponse

type ListTagBindingsResponse 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"`// TagBindings: A possibly paginated list of TagBindings for the specified// resource.TagBindings []*TagBinding `json:"tagBindings,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:"-"`}

ListTagBindingsResponse: The ListTagBindings response.

func (ListTagBindingsResponse)MarshalJSON

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

typeListTagHoldsResponseadded inv0.75.0

type ListTagHoldsResponse 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"`// TagHolds: A possibly paginated list of TagHolds.TagHolds []*TagHold `json:"tagHolds,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:"-"`}

ListTagHoldsResponse: The ListTagHolds response.

func (ListTagHoldsResponse)MarshalJSONadded inv0.75.0

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

typeListTagKeysResponse

type ListTagKeysResponse struct {// NextPageToken: A pagination token returned from a previous call to// `ListTagKeys` that indicates from where listing should continue.NextPageTokenstring `json:"nextPageToken,omitempty"`// TagKeys: List of TagKeys that live under the specified parent in the// request.TagKeys []*TagKey `json:"tagKeys,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:"-"`}

ListTagKeysResponse: The ListTagKeys response message.

func (ListTagKeysResponse)MarshalJSON

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

typeListTagValuesResponse

type ListTagValuesResponse struct {// NextPageToken: A pagination token returned from a previous call to// `ListTagValues` that indicates from where listing should continue.NextPageTokenstring `json:"nextPageToken,omitempty"`// TagValues: A possibly paginated list of TagValues that are direct// descendants of the specified parent TagKey.TagValues []*TagValue `json:"tagValues,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:"-"`}

ListTagValuesResponse: The ListTagValues response.

func (ListTagValuesResponse)MarshalJSON

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

typeLocationsEffectiveTagBindingCollectionsGetCalladded inv0.236.0

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

func (*LocationsEffectiveTagBindingCollectionsGetCall)Contextadded inv0.236.0

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

func (*LocationsEffectiveTagBindingCollectionsGetCall)Doadded inv0.236.0

Do executes the "cloudresourcemanager.locations.effectiveTagBindingCollections.get" call.Any non-2xx status code is an error. Response headers are in either*EffectiveTagBindingCollection.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 (*LocationsEffectiveTagBindingCollectionsGetCall)Fieldsadded inv0.236.0

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

func (*LocationsEffectiveTagBindingCollectionsGetCall)Headeradded inv0.236.0

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

func (*LocationsEffectiveTagBindingCollectionsGetCall)IfNoneMatchadded inv0.236.0

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

typeLocationsEffectiveTagBindingCollectionsServiceadded inv0.236.0

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

funcNewLocationsEffectiveTagBindingCollectionsServiceadded inv0.236.0

func NewLocationsEffectiveTagBindingCollectionsService(s *Service) *LocationsEffectiveTagBindingCollectionsService

func (*LocationsEffectiveTagBindingCollectionsService)Getadded inv0.236.0

Get: Returns effective tag bindings on a GCP resource.

  • name: The full name of the EffectiveTagBindingCollection in format:`locations/{location}/effectiveTagBindingCollections/{encoded-full-resource-name}` where the encoded-full-resource-name is the UTF-8 encoded name ofthe resource the TagBindings are bound to. E.g."locations/global/effectiveTagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123".

typeLocationsServiceadded inv0.236.0

type LocationsService struct {EffectiveTagBindingCollections *LocationsEffectiveTagBindingCollectionsServiceTagBindingCollections *LocationsTagBindingCollectionsService// contains filtered or unexported fields}

funcNewLocationsServiceadded inv0.236.0

func NewLocationsService(s *Service) *LocationsService

typeLocationsTagBindingCollectionsGetCalladded inv0.236.0

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

func (*LocationsTagBindingCollectionsGetCall)Contextadded inv0.236.0

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

func (*LocationsTagBindingCollectionsGetCall)Doadded inv0.236.0

Do executes the "cloudresourcemanager.locations.tagBindingCollections.get" call.Any non-2xx status code is an error. Response headers are in either*TagBindingCollection.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 (*LocationsTagBindingCollectionsGetCall)Fieldsadded inv0.236.0

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

func (*LocationsTagBindingCollectionsGetCall)Headeradded inv0.236.0

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

func (*LocationsTagBindingCollectionsGetCall)IfNoneMatchadded inv0.236.0

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

typeLocationsTagBindingCollectionsPatchCalladded inv0.236.0

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

func (*LocationsTagBindingCollectionsPatchCall)Contextadded inv0.236.0

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

func (*LocationsTagBindingCollectionsPatchCall)Doadded inv0.236.0

Do executes the "cloudresourcemanager.locations.tagBindingCollections.patch" 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 (*LocationsTagBindingCollectionsPatchCall)Fieldsadded inv0.236.0

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

func (*LocationsTagBindingCollectionsPatchCall)Headeradded inv0.236.0

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

func (*LocationsTagBindingCollectionsPatchCall)UpdateMaskadded inv0.236.0

UpdateMask sets the optional parameter "updateMask": An update mask toselectively update fields.

typeLocationsTagBindingCollectionsServiceadded inv0.236.0

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

funcNewLocationsTagBindingCollectionsServiceadded inv0.236.0

func NewLocationsTagBindingCollectionsService(s *Service) *LocationsTagBindingCollectionsService

func (*LocationsTagBindingCollectionsService)Getadded inv0.236.0

Get: Returns tag bindings directly attached to a GCP resource.

  • name: The full name of the TagBindingCollection in format:`locations/{location}/tagBindingCollections/{encoded-full-resource-name}`where the enoded-full-resource-name is the UTF-8 encoded name of theresource the TagBindings are bound to. E.g."locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123".

func (*LocationsTagBindingCollectionsService)Patchadded inv0.236.0

Patch: Updates tag bindings directly attached to a GCP resource. Update_maskcan be kept empty or "*".

  • name: Identifier. The name of the TagBindingCollection, following theconvention:`locations/{location}/tagBindingCollections/{encoded-full-resource-name}`where the encoded-full-resource-name is the UTF-8 encoded name of the GCPresource the TagBindings are bound to."locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis.com%2fprojects%2f123".

typeMoveFolderMetadataadded inv0.43.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.43.0

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

typeMoveFolderRequestadded inv0.43.0

type MoveFolderRequest struct {// DestinationParent: Required. The resource name of the folder or organization// which should be the folder's new parent. Must be of the form// `folders/{folder_id}` or `organizations/{org_id}`.DestinationParentstring `json:"destinationParent,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:"-"`}

MoveFolderRequest: The MoveFolder request message.

func (MoveFolderRequest)MarshalJSONadded inv0.43.0

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

typeMoveProjectMetadataadded inv0.43.0

type MoveProjectMetadata struct {}

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

typeMoveProjectRequestadded inv0.43.0

type MoveProjectRequest struct {// DestinationParent: Required. The new parent to move the Project under.DestinationParentstring `json:"destinationParent,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:"-"`}

MoveProjectRequest: The request sent to MoveProject method.

func (MoveProjectRequest)MarshalJSONadded inv0.43.0

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

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.

typeOrganizationadded inv0.43.0

type Organization struct {// CreateTime: Output only. Timestamp when the Organization was created.CreateTimestring `json:"createTime,omitempty"`// DeleteTime: Output only. Timestamp when the Organization was requested for// deletion.DeleteTimestring `json:"deleteTime,omitempty"`// DirectoryCustomerId: Immutable. The G Suite / Workspace customer id used in// the Directory API.DirectoryCustomerIdstring `json:"directoryCustomerId,omitempty"`// DisplayName: Output only. 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 Google Workspace customer that owns the// organization.DisplayNamestring `json:"displayName,omitempty"`// Etag: Output only. A checksum computed by the server based on the current// value of the Organization resource. This may be sent on update and delete// requests to ensure the client has an up-to-date value before proceeding.Etagstring `json:"etag,omitempty"`// Name: 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"`// State: Output only. The organization's current lifecycle state.//// Possible values://   "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.Statestring `json:"state,omitempty"`// UpdateTime: Output only. Timestamp when the Organization was last modified.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "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:"-"`}

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

func (Organization)MarshalJSONadded inv0.43.0

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

typeOrganizationsGetCalladded inv0.43.0

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

func (*OrganizationsGetCall)Contextadded inv0.43.0

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

func (*OrganizationsGetCall)Doadded inv0.43.0

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)Fieldsadded inv0.43.0

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

func (*OrganizationsGetCall)Headeradded inv0.43.0

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)IfNoneMatchadded inv0.43.0

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.

typeOrganizationsGetIamPolicyCalladded inv0.43.0

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

func (*OrganizationsGetIamPolicyCall)Contextadded inv0.43.0

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

func (*OrganizationsGetIamPolicyCall)Doadded inv0.43.0

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)Fieldsadded inv0.43.0

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

func (*OrganizationsGetIamPolicyCall)Headeradded inv0.43.0

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

typeOrganizationsSearchCalladded inv0.43.0

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

func (*OrganizationsSearchCall)Contextadded inv0.43.0

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

func (*OrganizationsSearchCall)Doadded inv0.43.0

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)Fieldsadded inv0.43.0

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

func (*OrganizationsSearchCall)Headeradded inv0.43.0

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

func (*OrganizationsSearchCall)IfNoneMatchadded inv0.43.0

func (c *OrganizationsSearchCall) IfNoneMatch(entityTagstring) *OrganizationsSearchCall

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 (*OrganizationsSearchCall)PageSizeadded inv0.43.0

PageSize sets the optional parameter "pageSize": The maximum number oforganizations to return in the response. The server can return fewerorganizations than requested. If unspecified, server picks an appropriatedefault.

func (*OrganizationsSearchCall)PageTokenadded inv0.43.0

PageToken sets the optional parameter "pageToken": A pagination tokenreturned from a previous call to `SearchOrganizations` that indicates fromwhere listing should continue.

func (*OrganizationsSearchCall)Pagesadded inv0.43.0

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

func (*OrganizationsSearchCall)Queryadded inv0.43.0

Query sets the optional parameter "query": An optional query string used tofilter the Organizations to return in the response. Query rules arecase-insensitive. ``` | Field | Description ||------------------|--------------------------------------------| |directoryCustomerId, owner.directoryCustomerId | Filters by directorycustomer id. | | domain | Filters by domain. | ``` Organizations may bequeried by `directoryCustomerId` or by `domain`, where the domain is a GSuite domain, for example: * Query `directorycustomerid:123456789` returnsOrganization resources with `owner.directory_customer_id` equal to`123456789`. * Query `domain:google.com` returns Organization resourcescorresponding to the domain `google.com`.

typeOrganizationsServiceadded inv0.43.0

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

funcNewOrganizationsServiceadded inv0.43.0

func NewOrganizationsService(s *Service) *OrganizationsService

func (*OrganizationsService)Getadded inv0.43.0

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)GetIamPolicyadded inv0.43.0

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

GetIamPolicy: Gets the access control policy for an organization resource.The policy may be empty if no such policy or resource exists. The `resource`field should be the organization's resource name, for example:"organizations/123". Authorization requires the IAM permission`resourcemanager.organizations.getIamPolicy` on the specified organization.

func (*OrganizationsService)Searchadded inv0.43.0

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, and may take a small amount of time to appear. Search will onlyreturn organizations on which the user has the permission`resourcemanager.organizations.get` or has super admin privileges.

func (*OrganizationsService)SetIamPolicyadded inv0.43.0

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, for example: "organizations/123".Authorization requires the IAM permission`resourcemanager.organizations.setIamPolicy` on the specified organization.

func (*OrganizationsService)TestIamPermissionsadded inv0.43.0

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

TestIamPermissions: Returns the permissions that a caller has on thespecified organization. The `resource` field should be the organization'sresource name, for example: "organizations/123". There are no permissionsrequired for making this API call.

typeOrganizationsSetIamPolicyCalladded inv0.43.0

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

func (*OrganizationsSetIamPolicyCall)Contextadded inv0.43.0

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

func (*OrganizationsSetIamPolicyCall)Doadded inv0.43.0

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)Fieldsadded inv0.43.0

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

func (*OrganizationsSetIamPolicyCall)Headeradded inv0.43.0

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

typeOrganizationsTestIamPermissionsCalladded inv0.43.0

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

func (*OrganizationsTestIamPermissionsCall)Contextadded inv0.43.0

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

func (*OrganizationsTestIamPermissionsCall)Doadded inv0.43.0

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)Fieldsadded inv0.43.0

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

func (*OrganizationsTestIamPermissionsCall)Headeradded inv0.43.0

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)

typeProjectadded inv0.43.0

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: Output only. Creation time.CreateTimestring `json:"createTime,omitempty"`// DeleteTime: Output only. The time at which this resource was requested for// deletion.DeleteTimestring `json:"deleteTime,omitempty"`// DisplayName: Optional. A 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`DisplayNamestring `json:"displayName,omitempty"`// Etag: Output only. A checksum computed by the server based on the current// value of the Project resource. This may be sent on update and delete// requests to ensure the client has an up-to-date value before proceeding.Etagstring `json:"etag,omitempty"`// Labels: Optional. 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\ (\[-a-z0-9\]*\[a-z0-9\])?. Label values must be// between 0 and 63 characters long and must conform to the regular expression// (\a-z\ (\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 64 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: "myBusinessDimension" : "businessValue"Labels map[string]string `json:"labels,omitempty"`// Name: Output only. The unique resource name of the project. It is an int64// generated number prefixed by "projects/". Example: `projects/415104041262`Namestring `json:"name,omitempty"`// Parent: Optional. A reference to a parent Resource. eg., `organizations/123`// or `folders/876`.Parentstring `json:"parent,omitempty"`// ProjectId: Immutable. The unique, user-assigned id of the project. It must// be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a// letter. Trailing hyphens are prohibited. Example: `tokyo-rain-123`ProjectIdstring `json:"projectId,omitempty"`// State: Output only. The project lifecycle state.//// Possible values://   "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.Statestring `json:"state,omitempty"`// 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"`// UpdateTime: Output only. The most recent time this resource was modified.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "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 entity. It is a containerfor ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platformresources.

func (Project)MarshalJSONadded inv0.43.0

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)

typeProjectsCreateCalladded inv0.43.0

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

func (*ProjectsCreateCall)Contextadded inv0.43.0

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

func (*ProjectsCreateCall)Doadded inv0.43.0

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)Fieldsadded inv0.43.0

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

func (*ProjectsCreateCall)Headeradded inv0.43.0

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

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

typeProjectsDeleteCalladded inv0.43.0

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

func (*ProjectsDeleteCall)Contextadded inv0.43.0

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

func (*ProjectsDeleteCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.projects.delete" 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 (*ProjectsDeleteCall)Fieldsadded inv0.43.0

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

func (*ProjectsDeleteCall)Headeradded inv0.43.0

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

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

typeProjectsGetCalladded inv0.43.0

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

func (*ProjectsGetCall)Contextadded inv0.43.0

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

func (*ProjectsGetCall)Doadded inv0.43.0

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)Fieldsadded inv0.43.0

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

func (*ProjectsGetCall)Headeradded inv0.43.0

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)IfNoneMatchadded inv0.43.0

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.

typeProjectsGetIamPolicyCalladded inv0.43.0

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

func (*ProjectsGetIamPolicyCall)Contextadded inv0.43.0

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

func (*ProjectsGetIamPolicyCall)Doadded inv0.43.0

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)Fieldsadded inv0.43.0

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

func (*ProjectsGetIamPolicyCall)Headeradded inv0.43.0

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

typeProjectsListCalladded inv0.43.0

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

func (*ProjectsListCall)Contextadded inv0.43.0

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

func (*ProjectsListCall)Doadded inv0.43.0

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)Fieldsadded inv0.43.0

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

func (*ProjectsListCall)Headeradded inv0.43.0

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)IfNoneMatchadded inv0.43.0

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)PageSizeadded inv0.43.0

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)PageTokenadded inv0.43.0

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)Pagesadded inv0.43.0

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

func (*ProjectsListCall)Parentadded inv0.43.0

func (c *ProjectsListCall) Parent(parentstring) *ProjectsListCall

Parent sets the optional parameter "parent": Required. The name of theparent resource whose projects are being listed. Only children of thisparent resource are listed; descendants are not listed. If the parent is afolder, use the value `folders/{folder_id}`. If the parent is anorganization, use the value `organizations/{org_id}`.

func (*ProjectsListCall)ShowDeletedadded inv0.43.0

func (c *ProjectsListCall) ShowDeleted(showDeletedbool) *ProjectsListCall

ShowDeleted sets the optional parameter "showDeleted": Indicate thatprojects in the `DELETE_REQUESTED` state should also be returned. Normallyonly `ACTIVE` projects are returned.

typeProjectsMoveCalladded inv0.43.0

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

func (*ProjectsMoveCall)Contextadded inv0.43.0

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

func (*ProjectsMoveCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.projects.move" 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 (*ProjectsMoveCall)Fieldsadded inv0.43.0

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

func (*ProjectsMoveCall)Headeradded inv0.43.0

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

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

typeProjectsPatchCalladded inv0.43.0

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

func (*ProjectsPatchCall)Contextadded inv0.43.0

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

func (*ProjectsPatchCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.projects.patch" 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 (*ProjectsPatchCall)Fieldsadded inv0.43.0

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

func (*ProjectsPatchCall)Headeradded inv0.43.0

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

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

func (*ProjectsPatchCall)UpdateMaskadded inv0.43.0

func (c *ProjectsPatchCall) UpdateMask(updateMaskstring) *ProjectsPatchCall

UpdateMask sets the optional parameter "updateMask": An update mask toselectively update fields.

typeProjectsSearchCalladded inv0.43.0

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

func (*ProjectsSearchCall)Contextadded inv0.43.0

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

func (*ProjectsSearchCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.projects.search" call.Any non-2xx status code is an error. Response headers are in either*SearchProjectsResponse.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 (*ProjectsSearchCall)Fieldsadded inv0.43.0

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

func (*ProjectsSearchCall)Headeradded inv0.43.0

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

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

func (*ProjectsSearchCall)IfNoneMatchadded inv0.43.0

func (c *ProjectsSearchCall) IfNoneMatch(entityTagstring) *ProjectsSearchCall

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 (*ProjectsSearchCall)PageSizeadded inv0.43.0

func (c *ProjectsSearchCall) PageSize(pageSizeint64) *ProjectsSearchCall

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 (*ProjectsSearchCall)PageTokenadded inv0.43.0

func (c *ProjectsSearchCall) PageToken(pageTokenstring) *ProjectsSearchCall

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

func (*ProjectsSearchCall)Pagesadded inv0.43.0

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

func (*ProjectsSearchCall)Queryadded inv0.43.0

Query sets the optional parameter "query": A query string for searching forprojects that the caller has `resourcemanager.projects.get` permission to.If multiple fields are included in the query, then it will return resultsthat match any of the fields. Some eligible fields are: ``` | Field |Description ||-------------------------|----------------------------------------------| |displayName, name | Filters by displayName. | | parent | Project's parent(for example: folders/123, organizations/*). Prefer parent field overparent.type and parent.id.| | parent.type | Parent's type: `folder` or`organization`. | | parent.id | Parent's id number (for example: 123) | |id, projectId | Filters by projectId. | | state, lifecycleState | Filters bystate. | | labels | Filters by label name or value. | | labels.\ (where*key* is the name of a label) | Filters by label name.| ``` Searchexpressions are case insensitive. Some examples 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`. | ```If no query is specified, the call will return projects for which the userhas the `resourcemanager.projects.get` permission.

typeProjectsServiceadded inv0.43.0

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

funcNewProjectsServiceadded inv0.43.0

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService)Createadded inv0.43.0

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

Create: Request that a new project be created. The result is an `Operation`which can be used to track the creation process. This process usually takesa few seconds, but can sometimes take much longer. The tracking `Operation`is automatically deleted after a few hours, so there is no need to call`DeleteOperation`.

func (*ProjectsService)Deleteadded inv0.43.0

Delete: Marks the project identified by the specified `name` (for example,`projects/415104041262`) 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,ListProjects, and SearchProjects methods. The caller must have`resourcemanager.projects.delete` permissions for this project.

- name: The name of the Project (for example, `projects/415104041262`).

func (*ProjectsService)Getadded inv0.43.0

Get: Retrieves the project identified by the specified `name` (for example,`projects/415104041262`). The caller must have`resourcemanager.projects.get` permission for this project.

- name: The name of the project (for example, `projects/415104041262`).

func (*ProjectsService)GetIamPolicyadded inv0.43.0

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

GetIamPolicy: Returns the IAM access control policy for the specifiedproject, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123.Permission is denied if the policy or the resource do not exist.

func (*ProjectsService)Listadded inv0.43.0

List: Lists projects that are direct children of the specified folder ororganization resource. `list()` provides a strongly consistent view of theprojects underneath the specified parent resource. `list()` returns projectssorted based upon the (ascending) lexical ordering of their `display_name`.The caller must have `resourcemanager.projects.list` permission on theidentified parent.

func (*ProjectsService)Moveadded inv0.43.0

func (r *ProjectsService) Move(namestring, moveprojectrequest *MoveProjectRequest) *ProjectsMoveCall

Move: Move a project to another place in your resource hierarchy, under anew resource parent. Returns an operation which can be used to track theprocess of the project move workflow. Upon success, the `Operation.response`field will be populated with the moved project. The caller must have`resourcemanager.projects.move` permission on the project, on the project'scurrent and proposed new parent. If project has no current parent, or itcurrently does not have an associated organization resource, you will alsoneed the `resourcemanager.projects.setIamPolicy` permission in the project.

- name: The name of the project to move.

func (*ProjectsService)Patchadded inv0.43.0

func (r *ProjectsService) Patch(namestring, project *Project) *ProjectsPatchCall

Patch: Updates the `display_name` and labels of the project identified bythe specified `name` (for example, `projects/415104041262`). Deleting alllabels requires an update mask for labels field. The caller must have`resourcemanager.projects.update` permission for this project.

  • name: Output only. The unique resource name of the project. It is an int64generated number prefixed by "projects/". Example: `projects/415104041262`.

func (*ProjectsService)Searchadded inv0.43.0

Search: Search for projects that the caller has the`resourcemanager.projects.get` permission on, and also satisfy the specifiedquery. This method returns projects in an unspecified order. This method iseventually consistent with project mutations; this means that a newlycreated project may not appear in the results or recent updates to anexisting project may not be reflected in the results. To retrieve the lateststate of a project, use the GetProject method.

func (*ProjectsService)SetIamPolicyadded inv0.43.0

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

SetIamPolicy: Sets the IAM access control policy for the specified project,in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. CAUTION:This method will replace the existing policy, and cannot be used to appendadditional IAM settings. Note: Removing service accounts from policies orchanging their roles can render services completely inoperable. It isimportant to understand how the service account is being used beforeremoving or updating its roles. The following constraints apply when using`setIamPolicy()`: + Project does not support `allUsers` and`allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + Theowner role can be granted to a `user`, `serviceAccount`, or a group that ispart of an organization. For example, group@myownpersonaldomain.com could beadded as an owner to a project in the myownpersonaldomain.com organization,but not the examplepetstore.com organization. + Service accounts can be madeowners of a project directly without any restrictions. However, to be addedas an owner, a user must be invited using the Cloud Platform console andmust accept the invitation. + A user cannot be granted the owner role using`setIamPolicy()`. The user must be granted the owner role using the CloudPlatform Console and must explicitly accept the invitation. + Invitations togrant the owner role cannot be sent using `setIamPolicy()`; they must besent only using the Cloud Platform Console. + If the project is not part ofan organization, there must be at least one owner who has accepted the Termsof Service (ToS) agreement in the policy. Calling `setIamPolicy()` to removethe last ToS-accepted owner from the policy will fail. This restriction alsoapplies to legacy projects that no longer have owners who have accepted theToS. Edits to IAM policies will be rejected until the lack of aToS-accepting owner is rectified. If the project is part of an organization,you can remove all owners, potentially making the organization inaccessible.

func (*ProjectsService)TestIamPermissionsadded inv0.43.0

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

TestIamPermissions: Returns permissions that a caller has on the specifiedproject, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123..

func (*ProjectsService)Undeleteadded inv0.43.0

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

Undelete: Restores the project identified by the specified `name` (forexample, `projects/415104041262`). You can only use this method for aproject that has a lifecycle state of DELETE_REQUESTED. After deletionstarts, the project cannot be restored. The caller must have`resourcemanager.projects.undelete` permission for this project.

  • name: The name of the project (for example, `projects/415104041262`).Required.

typeProjectsSetIamPolicyCalladded inv0.43.0

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

func (*ProjectsSetIamPolicyCall)Contextadded inv0.43.0

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

func (*ProjectsSetIamPolicyCall)Doadded inv0.43.0

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)Fieldsadded inv0.43.0

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

func (*ProjectsSetIamPolicyCall)Headeradded inv0.43.0

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

typeProjectsTestIamPermissionsCalladded inv0.43.0

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

func (*ProjectsTestIamPermissionsCall)Contextadded inv0.43.0

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

func (*ProjectsTestIamPermissionsCall)Doadded inv0.43.0

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)Fieldsadded inv0.43.0

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

func (*ProjectsTestIamPermissionsCall)Headeradded inv0.43.0

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

typeProjectsUndeleteCalladded inv0.43.0

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

func (*ProjectsUndeleteCall)Contextadded inv0.43.0

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

func (*ProjectsUndeleteCall)Doadded inv0.43.0

Do executes the "cloudresourcemanager.projects.undelete" 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 (*ProjectsUndeleteCall)Fieldsadded inv0.43.0

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

func (*ProjectsUndeleteCall)Headeradded inv0.43.0

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

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

typeSearchFoldersResponseadded inv0.43.0

type SearchFoldersResponse struct {// Folders: A possibly paginated folder search results. the specified parent// resource.Folders []*Folder `json:"folders,omitempty"`// NextPageToken: A pagination token returned from a previous call to// `SearchFolders` that indicates from where searching should continue.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. "Folders") 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. "Folders") 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:"-"`}

SearchFoldersResponse: The response message for searching folders.

func (SearchFoldersResponse)MarshalJSONadded inv0.43.0

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

typeSearchOrganizationsResponseadded inv0.43.0

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)MarshalJSONadded inv0.43.0

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

typeSearchProjectsResponseadded inv0.43.0

type SearchProjectsResponse 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 query. 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:"-"`}

SearchProjectsResponse: A page of the response received from theSearchProjects method. A paginated response where more pages are availablehas `next_page_token` set. This token can be used in a subsequent request toretrieve the next request page.

func (SearchProjectsResponse)MarshalJSONadded inv0.43.0

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

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentEffectiveTags *EffectiveTagsServiceFolders *FoldersServiceLiens *LiensServiceLocations *LocationsServiceOperations *OperationsServiceOrganizations *OrganizationsServiceProjects *ProjectsServiceTagBindings *TagBindingsServiceTagKeys *TagKeysServiceTagValues *TagValuesService// contains filtered or unexported fields}

funcNewdeprecated

func New(client *http.Client) (*Service,error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

funcNewService

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

NewService creates a new Service.

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)

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)

typeTagBinding

type TagBinding struct {// Name: Output only. The name of the TagBinding. This is a String of the form:// `tagBindings/{full-resource-name}/{tag-value-name}` (e.g.// `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagVa// lues/456`).Namestring `json:"name,omitempty"`// Parent: The full resource name of the resource the TagValue is bound to.// E.g. `//cloudresourcemanager.googleapis.com/projects/123`Parentstring `json:"parent,omitempty"`// TagValue: The TagValue of the TagBinding. Must be of the form// `tagValues/456`.TagValuestring `json:"tagValue,omitempty"`// TagValueNamespacedName: The namespaced name for the TagValue of the// TagBinding. Must be in the format// `{parent_id}/{tag_key_short_name}/{short_name}`. For methods that support// TagValue namespaced name, only one of tag_value_namespaced_name or tag_value// may be filled. Requests with both fields will be rejected.TagValueNamespacedNamestring `json:"tagValueNamespacedName,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TagBinding: A TagBinding represents a connection between a TagValue and acloud resource Once a TagBinding is created, the TagValue is applied to allthe descendants of the Google Cloud resource.

func (TagBinding)MarshalJSON

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

typeTagBindingCollectionadded inv0.236.0

type TagBindingCollection struct {// Etag: Optional. A checksum based on the current bindings which can be passed// to prevent race conditions. This field is always set in server responses.Etagstring `json:"etag,omitempty"`// FullResourceName: The full resource name of the resource the TagBindings are// bound to. E.g. `//cloudresourcemanager.googleapis.com/projects/123`FullResourceNamestring `json:"fullResourceName,omitempty"`// Name: Identifier. The name of the TagBindingCollection, following the// convention:// `locations/{location}/tagBindingCollections/{encoded-full-resource-name}`// where the encoded-full-resource-name is the UTF-8 encoded name of the GCP// resource the TagBindings are bound to.// "locations/global/tagBindingCollections/%2f%2fcloudresourcemanager.googleapis// .com%2fprojects%2f123"Namestring `json:"name,omitempty"`// Tags: Tag keys/values directly bound to this resource, specified in// namespaced format. For example: "123/environment": "production"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. "Etag") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Etag") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TagBindingCollection: Represents a collection of tags directly bound to aGCP resource.

func (TagBindingCollection)MarshalJSONadded inv0.236.0

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

typeTagBindingsCreateCall

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

func (*TagBindingsCreateCall)Context

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

func (*TagBindingsCreateCall)Do

Do executes the "cloudresourcemanager.tagBindings.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 (*TagBindingsCreateCall)Fields

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

func (*TagBindingsCreateCall)Header

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

func (*TagBindingsCreateCall)ValidateOnly

func (c *TagBindingsCreateCall) ValidateOnly(validateOnlybool) *TagBindingsCreateCall

ValidateOnly sets the optional parameter "validateOnly": Set to true toperform the validations necessary for creating the resource, but notactually perform the action.

typeTagBindingsDeleteCall

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

func (*TagBindingsDeleteCall)Context

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

func (*TagBindingsDeleteCall)Do

Do executes the "cloudresourcemanager.tagBindings.delete" 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 (*TagBindingsDeleteCall)Fields

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

func (*TagBindingsDeleteCall)Header

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

typeTagBindingsListCall

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

func (*TagBindingsListCall)Context

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

func (*TagBindingsListCall)Do

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

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

func (*TagBindingsListCall)Header

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

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

func (*TagBindingsListCall)IfNoneMatch

func (c *TagBindingsListCall) IfNoneMatch(entityTagstring) *TagBindingsListCall

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

func (c *TagBindingsListCall) PageSize(pageSizeint64) *TagBindingsListCall

PageSize sets the optional parameter "pageSize": The maximum number ofTagBindings to return in the response. The server allows a maximum of 300TagBindings to return. If unspecified, the server will use 100 as thedefault.

func (*TagBindingsListCall)PageToken

func (c *TagBindingsListCall) PageToken(pageTokenstring) *TagBindingsListCall

PageToken sets the optional parameter "pageToken": A pagination tokenreturned from a previous call to `ListTagBindings` that indicates where thislisting should continue from.

func (*TagBindingsListCall)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 (*TagBindingsListCall)Parent

Parent sets the optional parameter "parent": Required. The full resourcename of a resource for which you want to list existing TagBindings. E.g."//cloudresourcemanager.googleapis.com/projects/123"

typeTagBindingsService

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

funcNewTagBindingsService

func NewTagBindingsService(s *Service) *TagBindingsService

func (*TagBindingsService)Create

func (r *TagBindingsService) Create(tagbinding *TagBinding) *TagBindingsCreateCall

Create: Creates a TagBinding between a TagValue and a Google Cloud resource.

func (*TagBindingsService)Delete

Delete: Deletes a TagBinding.

  • name: The name of the TagBinding. This is a String of the form:`tagBindings/{id}` (e.g.`tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).

func (*TagBindingsService)List

List: Lists the TagBindings for the given Google Cloud resource, asspecified with `parent`. NOTE: The `parent` field is expected to be a fullresource name:https://cloud.google.com/apis/design/resource_names#full_resource_name

typeTagHoldadded inv0.75.0

type TagHold struct {// CreateTime: Output only. The time this TagHold was created.CreateTimestring `json:"createTime,omitempty"`// HelpLink: Optional. A URL where an end user can learn more about removing// this hold. E.g.// `https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managi// ng`HelpLinkstring `json:"helpLink,omitempty"`// Holder: Required. The name of the resource where the TagValue is being used.// Must be less than 200 characters. E.g.// `//compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instan// ceGroupManagers/instance-group`Holderstring `json:"holder,omitempty"`// Name: Output only. The resource name of a TagHold. This is a String of the// form: `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}` (e.g.// `tagValues/123/tagHolds/456`). This resource name is generated by the// server.Namestring `json:"name,omitempty"`// Origin: Optional. An optional string representing the origin of this// request. This field should include human-understandable information to// distinguish origins from each other. Must be less than 200 characters. E.g.// `migs-35678234`Originstring `json:"origin,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:"-"`}

TagHold: A TagHold represents the use of a TagValue that is not captured byTagBindings. If a TagValue has any TagHolds, deletion will be blocked. Thisresource is intended to be created in the same cloud location as the`holder`.

func (TagHold)MarshalJSONadded inv0.75.0

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

typeTagKey

type TagKey struct {// AllowedValuesRegex: Optional. Regular expression constraint for freeform tag// values. If present, it implicitly allows freeform values (constrained by the// regex).AllowedValuesRegexstring `json:"allowedValuesRegex,omitempty"`// CreateTime: Output only. Creation time.CreateTimestring `json:"createTime,omitempty"`// Description: Optional. User-assigned description of the TagKey. Must not// exceed 256 characters. Read-write.Descriptionstring `json:"description,omitempty"`// Etag: Optional. Entity tag which users can pass to prevent race conditions.// This field is always set in server responses. See UpdateTagKeyRequest for// details.Etagstring `json:"etag,omitempty"`// Name: Immutable. The resource name for a TagKey. Must be in the format// `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for// the TagKey.Namestring `json:"name,omitempty"`// NamespacedName: Output only. Immutable. Namespaced name of the TagKey.NamespacedNamestring `json:"namespacedName,omitempty"`// Parent: Immutable. The resource name of the TagKey's parent. A TagKey can be// parented by an Organization or a Project. For a TagKey parented by an// Organization, its parent must be in the form `organizations/{org_id}`. For a// TagKey parented by a Project, its parent can be in the form// `projects/{project_id}` or `projects/{project_number}`.Parentstring `json:"parent,omitempty"`// Purpose: Optional. A purpose denotes that this Tag is intended for use in// policies of a specific policy engine, and will involve that policy engine in// management operations involving this Tag. A purpose does not grant a policy// engine exclusive rights to the Tag, and it may be referenced by other policy// engines. A purpose cannot be changed once set.//// Possible values://   "PURPOSE_UNSPECIFIED" - Unspecified purpose.//   "GCE_FIREWALL" - Purpose for Compute Engine firewalls. A corresponding// `purpose_data` should be set for the network the tag is intended for. The// key should be `network` and the value should be in ## either of these two// formats:// `https://www.googleapis.com/compute/{compute_version}/projects/{project_id}/g// lobal/networks/{network_id}` - `{project_id}/{network_name}` ## Examples:// `https://www.googleapis.com/compute/staging_v1/projects/fail-closed-load-test// ing/global/networks/6992953698831725600` -// `fail-closed-load-testing/load-testing-network`//   "DATA_GOVERNANCE" - Purpose for data governance. Tag Values created under// a key with this purpose may have Tag Value children. No `purpose_data`// should be set.Purposestring `json:"purpose,omitempty"`// PurposeData: Optional. Purpose data corresponds to the policy system that// the tag is intended for. See documentation for `Purpose` for formatting of// this field. Purpose data cannot be changed once set.PurposeData map[string]string `json:"purposeData,omitempty"`// ShortName: Required. Immutable. The user friendly name for a TagKey. The// short name should be unique for TagKeys within the same tag namespace. The// short name must be 1-256 characters, beginning and ending with an// alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots// (.), and alphanumerics between.ShortNamestring `json:"shortName,omitempty"`// UpdateTime: Output only. Update time.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AllowedValuesRegex") 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. "AllowedValuesRegex") 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:"-"`}

TagKey: A TagKey, used to group a set of TagValues.

func (TagKey)MarshalJSON

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

typeTagKeysCreateCall

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

func (*TagKeysCreateCall)Context

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

func (*TagKeysCreateCall)Do

Do executes the "cloudresourcemanager.tagKeys.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 (*TagKeysCreateCall)Fields

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

func (*TagKeysCreateCall)Header

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

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

func (*TagKeysCreateCall)ValidateOnly

func (c *TagKeysCreateCall) ValidateOnly(validateOnlybool) *TagKeysCreateCall

ValidateOnly sets the optional parameter "validateOnly": Set to true toperform validations necessary for creating the resource, but not actuallyperform the action.

typeTagKeysDeleteCall

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

func (*TagKeysDeleteCall)Context

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

func (*TagKeysDeleteCall)Do

Do executes the "cloudresourcemanager.tagKeys.delete" 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 (*TagKeysDeleteCall)Etag

Etag sets the optional parameter "etag": The etag known to the client forthe expected state of the TagKey. This is to be used for optimisticconcurrency.

func (*TagKeysDeleteCall)Fields

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

func (*TagKeysDeleteCall)Header

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

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

func (*TagKeysDeleteCall)ValidateOnly

func (c *TagKeysDeleteCall) ValidateOnly(validateOnlybool) *TagKeysDeleteCall

ValidateOnly sets the optional parameter "validateOnly": Set as true toperform validations necessary for deletion, but not actually perform theaction.

typeTagKeysGetCall

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

func (*TagKeysGetCall)Context

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

func (*TagKeysGetCall)Do

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

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

func (*TagKeysGetCall)Header

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

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

func (*TagKeysGetCall)IfNoneMatch

func (c *TagKeysGetCall) IfNoneMatch(entityTagstring) *TagKeysGetCall

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.

typeTagKeysGetIamPolicyCall

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

func (*TagKeysGetIamPolicyCall)Context

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

func (*TagKeysGetIamPolicyCall)Do

Do executes the "cloudresourcemanager.tagKeys.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 (*TagKeysGetIamPolicyCall)Fields

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

func (*TagKeysGetIamPolicyCall)Header

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

typeTagKeysGetNamespacedCalladded inv0.117.0

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

func (*TagKeysGetNamespacedCall)Contextadded inv0.117.0

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

func (*TagKeysGetNamespacedCall)Doadded inv0.117.0

Do executes the "cloudresourcemanager.tagKeys.getNamespaced" call.Any non-2xx status code is an error. Response headers are in either*TagKey.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 (*TagKeysGetNamespacedCall)Fieldsadded inv0.117.0

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

func (*TagKeysGetNamespacedCall)Headeradded inv0.117.0

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

func (*TagKeysGetNamespacedCall)IfNoneMatchadded inv0.117.0

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

func (*TagKeysGetNamespacedCall)Nameadded inv0.117.0

Name sets the optional parameter "name": Required. A namespaced tag key namein the format `{parentId}/{tagKeyShort}`, such as `42/foo` for a key withshort name "foo" under the organization with ID 42 or `r2-d2/bar` for a keywith short name "bar" under the project `r2-d2`.

typeTagKeysListCall

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

func (*TagKeysListCall)Context

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

func (*TagKeysListCall)Do

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

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

func (*TagKeysListCall)Header

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

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

func (*TagKeysListCall)IfNoneMatch

func (c *TagKeysListCall) IfNoneMatch(entityTagstring) *TagKeysListCall

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

func (c *TagKeysListCall) PageSize(pageSizeint64) *TagKeysListCall

PageSize sets the optional parameter "pageSize": The maximum number ofTagKeys to return in the response. The server allows a maximum of 300TagKeys to return. If unspecified, the server will use 100 as the default.

func (*TagKeysListCall)PageToken

func (c *TagKeysListCall) PageToken(pageTokenstring) *TagKeysListCall

PageToken sets the optional parameter "pageToken": A pagination tokenreturned from a previous call to `ListTagKey` that indicates where thislisting should continue from.

func (*TagKeysListCall)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 (*TagKeysListCall)Parent

func (c *TagKeysListCall) Parent(parentstring) *TagKeysListCall

Parent sets the optional parameter "parent": Required. The resource name ofthe TagKey's parent. Must be of the form `organizations/{org_id}` or`projects/{project_id}` or `projects/{project_number}`

typeTagKeysPatchCall

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

func (*TagKeysPatchCall)Context

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

func (*TagKeysPatchCall)Do

Do executes the "cloudresourcemanager.tagKeys.patch" 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 (*TagKeysPatchCall)Fields

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

func (*TagKeysPatchCall)Header

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

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

func (*TagKeysPatchCall)UpdateMask

func (c *TagKeysPatchCall) UpdateMask(updateMaskstring) *TagKeysPatchCall

UpdateMask sets the optional parameter "updateMask": Fields to be updated.The mask may only contain `description` or `etag`. If omitted entirely, both`description` and `etag` are assumed to be significant.

func (*TagKeysPatchCall)ValidateOnly

func (c *TagKeysPatchCall) ValidateOnly(validateOnlybool) *TagKeysPatchCall

ValidateOnly sets the optional parameter "validateOnly": Set as true toperform validations necessary for updating the resource, but not actuallyperform the action.

typeTagKeysService

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

funcNewTagKeysService

func NewTagKeysService(s *Service) *TagKeysService

func (*TagKeysService)Create

func (r *TagKeysService) Create(tagkey *TagKey) *TagKeysCreateCall

Create: Creates a new TagKey. If another request with the same parameters issent while the original request is in process, the second request willreceive an error. A maximum of 1000 TagKeys can exist under a parent at anygiven time.

func (*TagKeysService)Delete

func (r *TagKeysService) Delete(namestring) *TagKeysDeleteCall

Delete: Deletes a TagKey. The TagKey cannot be deleted if it has any childTagValues.

  • name: The resource name of a TagKey to be deleted in the format`tagKeys/123`. The TagKey cannot be a parent of any existing TagValues orit will not be deleted successfully.

func (*TagKeysService)Get

Get: Retrieves a TagKey. This method will return `PERMISSION_DENIED` if thekey does not exist or the user does not have permission to view it.

- name: A resource name in the format `tagKeys/{id}`, such as `tagKeys/123`.

func (*TagKeysService)GetIamPolicy

func (r *TagKeysService) GetIamPolicy(resourcestring, getiampolicyrequest *GetIamPolicyRequest) *TagKeysGetIamPolicyCall

GetIamPolicy: Gets the access control policy for a TagKey. The returnedpolicy may be empty if no such policy or resource exists. The `resource`field should be the TagKey's resource name. For example, "tagKeys/1234". Thecaller must have `cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy`permission on the specified TagKey.

func (*TagKeysService)GetNamespacedadded inv0.117.0

func (r *TagKeysService) GetNamespaced() *TagKeysGetNamespacedCall

GetNamespaced: Retrieves a TagKey by its namespaced name. This method willreturn `PERMISSION_DENIED` if the key does not exist or the user does nothave permission to view it.

func (*TagKeysService)List

List: Lists all TagKeys for a parent resource.

func (*TagKeysService)Patch

func (r *TagKeysService) Patch(namestring, tagkey *TagKey) *TagKeysPatchCall

Patch: Updates the attributes of the TagKey resource.

  • name: Immutable. The resource name for a TagKey. Must be in the format`tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id forthe TagKey.

func (*TagKeysService)SetIamPolicy

func (r *TagKeysService) SetIamPolicy(resourcestring, setiampolicyrequest *SetIamPolicyRequest) *TagKeysSetIamPolicyCall

SetIamPolicy: Sets the access control policy on a TagKey, replacing anyexisting policy. The `resource` field should be the TagKey's resource name.For example, "tagKeys/1234". The caller must have`resourcemanager.tagKeys.setIamPolicy` permission on the identifiedtagValue.

func (*TagKeysService)TestIamPermissions

func (r *TagKeysService) TestIamPermissions(resourcestring, testiampermissionsrequest *TestIamPermissionsRequest) *TagKeysTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specifiedTagKey. The `resource` field should be the TagKey's resource name. Forexample, "tagKeys/1234". There are no permissions required for making thisAPI call.

typeTagKeysSetIamPolicyCall

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

func (*TagKeysSetIamPolicyCall)Context

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

func (*TagKeysSetIamPolicyCall)Do

Do executes the "cloudresourcemanager.tagKeys.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 (*TagKeysSetIamPolicyCall)Fields

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

func (*TagKeysSetIamPolicyCall)Header

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

typeTagKeysTestIamPermissionsCall

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

func (*TagKeysTestIamPermissionsCall)Context

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

func (*TagKeysTestIamPermissionsCall)Do

Do executes the "cloudresourcemanager.tagKeys.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 (*TagKeysTestIamPermissionsCall)Fields

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

func (*TagKeysTestIamPermissionsCall)Header

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

typeTagValue

type TagValue struct {// CreateTime: Output only. Creation time.CreateTimestring `json:"createTime,omitempty"`// Description: Optional. User-assigned description of the TagValue. Must not// exceed 256 characters. Read-write.Descriptionstring `json:"description,omitempty"`// Etag: Optional. Entity tag which users can pass to prevent race conditions.// This field is always set in server responses. See UpdateTagValueRequest for// details.Etagstring `json:"etag,omitempty"`// Name: Immutable. Resource name for TagValue in the format `tagValues/456`.Namestring `json:"name,omitempty"`// NamespacedName: Output only. The namespaced name of the TagValue. Can be in// the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or// `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or// `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.NamespacedNamestring `json:"namespacedName,omitempty"`// Parent: Immutable. The resource name of the new TagValue's parent TagKey.// Must be of the form `tagKeys/{tag_key_id}`.Parentstring `json:"parent,omitempty"`// ShortName: Required. Immutable. User-assigned short name for TagValue. The// short name should be unique for TagValues within the same parent TagKey. The// short name must be 256 characters or less, beginning and ending with an// alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots// (.), and alphanumerics between.ShortNamestring `json:"shortName,omitempty"`// UpdateTime: Output only. Update time.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "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:"-"`}

TagValue: A TagValue is a child of a particular TagKey. This is used togroup cloud resources for the purpose of controlling them using policies.

func (TagValue)MarshalJSON

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

typeTagValuesCreateCall

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

func (*TagValuesCreateCall)Context

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

func (*TagValuesCreateCall)Do

Do executes the "cloudresourcemanager.tagValues.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 (*TagValuesCreateCall)Fields

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

func (*TagValuesCreateCall)Header

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

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

func (*TagValuesCreateCall)ValidateOnly

func (c *TagValuesCreateCall) ValidateOnly(validateOnlybool) *TagValuesCreateCall

ValidateOnly sets the optional parameter "validateOnly": Set as true toperform the validations necessary for creating the resource, but notactually perform the action.

typeTagValuesDeleteCall

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

func (*TagValuesDeleteCall)Context

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

func (*TagValuesDeleteCall)Do

Do executes the "cloudresourcemanager.tagValues.delete" 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 (*TagValuesDeleteCall)Etag

Etag sets the optional parameter "etag": The etag known to the client forthe expected state of the TagValue. This is to be used for optimisticconcurrency.

func (*TagValuesDeleteCall)Fields

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

func (*TagValuesDeleteCall)Header

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

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

func (*TagValuesDeleteCall)ValidateOnly

func (c *TagValuesDeleteCall) ValidateOnly(validateOnlybool) *TagValuesDeleteCall

ValidateOnly sets the optional parameter "validateOnly": Set as true toperform the validations necessary for deletion, but not actually perform theaction.

typeTagValuesGetCall

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

func (*TagValuesGetCall)Context

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

func (*TagValuesGetCall)Do

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

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

func (*TagValuesGetCall)Header

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

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

func (*TagValuesGetCall)IfNoneMatch

func (c *TagValuesGetCall) IfNoneMatch(entityTagstring) *TagValuesGetCall

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.

typeTagValuesGetIamPolicyCall

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

func (*TagValuesGetIamPolicyCall)Context

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

func (*TagValuesGetIamPolicyCall)Do

Do executes the "cloudresourcemanager.tagValues.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 (*TagValuesGetIamPolicyCall)Fields

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

func (*TagValuesGetIamPolicyCall)Header

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

typeTagValuesGetNamespacedCalladded inv0.117.0

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

func (*TagValuesGetNamespacedCall)Contextadded inv0.117.0

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

func (*TagValuesGetNamespacedCall)Doadded inv0.117.0

Do executes the "cloudresourcemanager.tagValues.getNamespaced" call.Any non-2xx status code is an error. Response headers are in either*TagValue.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 (*TagValuesGetNamespacedCall)Fieldsadded inv0.117.0

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

func (*TagValuesGetNamespacedCall)Headeradded inv0.117.0

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

func (*TagValuesGetNamespacedCall)IfNoneMatchadded inv0.117.0

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

func (*TagValuesGetNamespacedCall)Nameadded inv0.117.0

Name sets the optional parameter "name": Required. A namespaced tag valuename in the following format: `{parentId}/{tagKeyShort}/{tagValueShort}`Examples: - `42/foo/abc` for a value with short name "abc" under the keywith short name "foo" under the organization with ID 42 - `r2-d2/bar/xyz`for a value with short name "xyz" under the key with short name "bar" underthe project with ID "r2-d2"

typeTagValuesListCall

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

func (*TagValuesListCall)Context

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

func (*TagValuesListCall)Do

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

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

func (*TagValuesListCall)Header

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

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

func (*TagValuesListCall)IfNoneMatch

func (c *TagValuesListCall) IfNoneMatch(entityTagstring) *TagValuesListCall

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

func (c *TagValuesListCall) PageSize(pageSizeint64) *TagValuesListCall

PageSize sets the optional parameter "pageSize": The maximum number ofTagValues to return in the response. The server allows a maximum of 300TagValues to return. If unspecified, the server will use 100 as the default.

func (*TagValuesListCall)PageToken

func (c *TagValuesListCall) PageToken(pageTokenstring) *TagValuesListCall

PageToken sets the optional parameter "pageToken": A pagination tokenreturned from a previous call to `ListTagValues` that indicates where thislisting should continue from.

func (*TagValuesListCall)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 (*TagValuesListCall)Parent

func (c *TagValuesListCall) Parent(parentstring) *TagValuesListCall

Parent sets the optional parameter "parent": Required. Resource name for theparent of the TagValues to be listed, in the format `tagKeys/123` or`tagValues/123`.

typeTagValuesPatchCall

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

func (*TagValuesPatchCall)Context

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

func (*TagValuesPatchCall)Do

Do executes the "cloudresourcemanager.tagValues.patch" 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 (*TagValuesPatchCall)Fields

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

func (*TagValuesPatchCall)Header

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

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

func (*TagValuesPatchCall)UpdateMask

func (c *TagValuesPatchCall) UpdateMask(updateMaskstring) *TagValuesPatchCall

UpdateMask sets the optional parameter "updateMask": Fields to be updated.

func (*TagValuesPatchCall)ValidateOnly

func (c *TagValuesPatchCall) ValidateOnly(validateOnlybool) *TagValuesPatchCall

ValidateOnly sets the optional parameter "validateOnly": True to performvalidations necessary for updating the resource, but not actually performthe action.

typeTagValuesService

type TagValuesService struct {TagHolds *TagValuesTagHoldsService// contains filtered or unexported fields}

funcNewTagValuesService

func NewTagValuesService(s *Service) *TagValuesService

func (*TagValuesService)Create

func (r *TagValuesService) Create(tagvalue *TagValue) *TagValuesCreateCall

Create: Creates a TagValue as a child of the specified TagKey. If a anotherrequest with the same parameters is sent while the original request is inprocess the second request will receive an error. A maximum of 1000TagValues can exist under a TagKey at any given time.

func (*TagValuesService)Delete

Delete: Deletes a TagValue. The TagValue cannot have any bindings when it isdeleted.

  • name: Resource name for TagValue to be deleted in the formattagValues/456.

func (*TagValuesService)Get

Get: Retrieves a TagValue. This method will return `PERMISSION_DENIED` ifthe value does not exist or the user does not have permission to view it.

  • name: Resource name for TagValue to be fetched in the format`tagValues/456`.

func (*TagValuesService)GetIamPolicy

func (r *TagValuesService) GetIamPolicy(resourcestring, getiampolicyrequest *GetIamPolicyRequest) *TagValuesGetIamPolicyCall

GetIamPolicy: Gets the access control policy for a TagValue. The returnedpolicy may be empty if no such policy or resource exists. The `resource`field should be the TagValue's resource name. For example: `tagValues/1234`.The caller must have the`cloudresourcemanager.googleapis.com/tagValues.getIamPolicy` permission onthe identified TagValue to get the access control policy.

func (*TagValuesService)GetNamespacedadded inv0.117.0

func (r *TagValuesService) GetNamespaced() *TagValuesGetNamespacedCall

GetNamespaced: Retrieves a TagValue by its namespaced name. This method willreturn `PERMISSION_DENIED` if the value does not exist or the user does nothave permission to view it.

func (*TagValuesService)List

List: Lists all TagValues for a specific TagKey.

func (*TagValuesService)Patch

func (r *TagValuesService) Patch(namestring, tagvalue *TagValue) *TagValuesPatchCall

Patch: Updates the attributes of the TagValue resource.

- name: Immutable. Resource name for TagValue in the format `tagValues/456`.

func (*TagValuesService)SetIamPolicy

func (r *TagValuesService) SetIamPolicy(resourcestring, setiampolicyrequest *SetIamPolicyRequest) *TagValuesSetIamPolicyCall

SetIamPolicy: Sets the access control policy on a TagValue, replacing anyexisting policy. The `resource` field should be the TagValue's resourcename. For example: `tagValues/1234`. The caller must have`resourcemanager.tagValues.setIamPolicy` permission on the identifiedtagValue.

func (*TagValuesService)TestIamPermissions

func (r *TagValuesService) TestIamPermissions(resourcestring, testiampermissionsrequest *TestIamPermissionsRequest) *TagValuesTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specifiedTagValue. The `resource` field should be the TagValue's resource name. Forexample: `tagValues/1234`. There are no permissions required for making thisAPI call.

typeTagValuesSetIamPolicyCall

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

func (*TagValuesSetIamPolicyCall)Context

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

func (*TagValuesSetIamPolicyCall)Do

Do executes the "cloudresourcemanager.tagValues.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 (*TagValuesSetIamPolicyCall)Fields

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

func (*TagValuesSetIamPolicyCall)Header

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

typeTagValuesTagHoldsCreateCalladded inv0.75.0

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

func (*TagValuesTagHoldsCreateCall)Contextadded inv0.75.0

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

func (*TagValuesTagHoldsCreateCall)Doadded inv0.75.0

Do executes the "cloudresourcemanager.tagValues.tagHolds.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 (*TagValuesTagHoldsCreateCall)Fieldsadded inv0.75.0

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

func (*TagValuesTagHoldsCreateCall)Headeradded inv0.75.0

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

func (*TagValuesTagHoldsCreateCall)ValidateOnlyadded inv0.75.0

func (c *TagValuesTagHoldsCreateCall) ValidateOnly(validateOnlybool) *TagValuesTagHoldsCreateCall

ValidateOnly sets the optional parameter "validateOnly": Set to true toperform the validations necessary for creating the resource, but notactually perform the action.

typeTagValuesTagHoldsDeleteCalladded inv0.75.0

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

func (*TagValuesTagHoldsDeleteCall)Contextadded inv0.75.0

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

func (*TagValuesTagHoldsDeleteCall)Doadded inv0.75.0

Do executes the "cloudresourcemanager.tagValues.tagHolds.delete" 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 (*TagValuesTagHoldsDeleteCall)Fieldsadded inv0.75.0

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

func (*TagValuesTagHoldsDeleteCall)Headeradded inv0.75.0

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

func (*TagValuesTagHoldsDeleteCall)ValidateOnlyadded inv0.75.0

func (c *TagValuesTagHoldsDeleteCall) ValidateOnly(validateOnlybool) *TagValuesTagHoldsDeleteCall

ValidateOnly sets the optional parameter "validateOnly": Set to true toperform the validations necessary for deleting the resource, but notactually perform the action.

typeTagValuesTagHoldsListCalladded inv0.75.0

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

func (*TagValuesTagHoldsListCall)Contextadded inv0.75.0

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

func (*TagValuesTagHoldsListCall)Doadded inv0.75.0

Do executes the "cloudresourcemanager.tagValues.tagHolds.list" call.Any non-2xx status code is an error. Response headers are in either*ListTagHoldsResponse.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 (*TagValuesTagHoldsListCall)Fieldsadded inv0.75.0

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

func (*TagValuesTagHoldsListCall)Filteradded inv0.75.0

Filter sets the optional parameter "filter": Criteria used to select asubset of TagHolds parented by the TagValue to return. This field followsthe syntax defined by aip.dev/160; the `holder` and `origin` fields aresupported for filtering. Currently only `AND` syntax is supported. Someexample queries are: * `holder =//compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group` * `origin = 35678234` * `holder =//compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group AND origin = 35678234`

func (*TagValuesTagHoldsListCall)Headeradded inv0.75.0

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

func (*TagValuesTagHoldsListCall)IfNoneMatchadded inv0.75.0

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

func (*TagValuesTagHoldsListCall)PageSizeadded inv0.75.0

PageSize sets the optional parameter "pageSize": The maximum number ofTagHolds to return in the response. The server allows a maximum of 300TagHolds to return. If unspecified, the server will use 100 as the default.

func (*TagValuesTagHoldsListCall)PageTokenadded inv0.75.0

PageToken sets the optional parameter "pageToken": A pagination tokenreturned from a previous call to `ListTagHolds` that indicates where thislisting should continue from.

func (*TagValuesTagHoldsListCall)Pagesadded inv0.75.0

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

typeTagValuesTagHoldsServiceadded inv0.75.0

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

funcNewTagValuesTagHoldsServiceadded inv0.75.0

func NewTagValuesTagHoldsService(s *Service) *TagValuesTagHoldsService

func (*TagValuesTagHoldsService)Createadded inv0.75.0

Create: Creates a TagHold. Returns ALREADY_EXISTS if a TagHold with the sameresource and origin exists under the same TagValue.

  • parent: The resource name of the TagHold's parent TagValue. Must be of theform: `tagValues/{tag-value-id}`.

func (*TagValuesTagHoldsService)Deleteadded inv0.75.0

Delete: Deletes a TagHold.

  • name: The resource name of the TagHold to delete. Must be of the form:`tagValues/{tag-value-id}/tagHolds/{tag-hold-id}`.

func (*TagValuesTagHoldsService)Listadded inv0.75.0

List: Lists TagHolds under a TagValue.

  • parent: The resource name of the parent TagValue. Must be of the form:`tagValues/{tag-value-id}`.

typeTagValuesTestIamPermissionsCall

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

func (*TagValuesTestIamPermissionsCall)Context

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

func (*TagValuesTestIamPermissionsCall)Do

Do executes the "cloudresourcemanager.tagValues.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 (*TagValuesTestIamPermissionsCall)Fields

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

func (*TagValuesTestIamPermissionsCall)Header

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

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

type UndeleteFolderMetadata struct {}

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

typeUndeleteFolderRequestadded inv0.43.0

type UndeleteFolderRequest struct {}

UndeleteFolderRequest: The UndeleteFolder request message.

typeUndeleteOrganizationMetadataadded inv0.43.0

type UndeleteOrganizationMetadata struct {}

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

typeUndeleteProjectMetadataadded inv0.43.0

type UndeleteProjectMetadata struct {}

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

typeUndeleteProjectRequestadded inv0.43.0

type UndeleteProjectRequest struct {}

UndeleteProjectRequest: The request sent to the UndeleteProject method.

typeUpdateFolderMetadataadded inv0.43.0

type UpdateFolderMetadata struct {}

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

typeUpdateProjectMetadataadded inv0.43.0

type UpdateProjectMetadata struct {}

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

typeUpdateTagKeyMetadata

type UpdateTagKeyMetadata struct {}

UpdateTagKeyMetadata: Runtime operation information for updating a TagKey.

typeUpdateTagValueMetadata

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