Package cloudresourcemanager

import "google.golang.org/api/cloudresourcemanager/v3"
...
ctx := context.Background()
cloudresourcemanagerService, err := cloudresourcemanager.NewService(ctx)

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

cloudresourcemanagerService, err := cloudresourcemanager.NewService(ctx, option.WithAPIKey("AIza..."))

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

Constants

OAuth2 scopes used by this API.

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 Account
    CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
)

type AuditConfig ¶

AuditConfig: Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple 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" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.

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.
    Service string `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:"-"`
}

func (*AuditConfig) MarshalJSON ¶

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

type AuditLogConfig ¶

AuditLogConfig: Provides the configuration for logging a type of permissions. 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, while exempting jose@example.com from DATA_READ logging.

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 list
    LogType string `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:"-"`
}

func (*AuditLogConfig) MarshalJSON ¶

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

type Binding ¶

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

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).
    Role string `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:"-"`
}

func (*Binding) MarshalJSON ¶

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

type CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation ¶

CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation: Metadata describing a long running folder operation

type CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation struct {
    // DestinationParent: The resource name of the folder or organization we are
    // either creating the folder under or moving the folder to.
    DestinationParent string `json:"destinationParent,omitempty"`
    // DisplayName: The display name of the folder.
    DisplayName string `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.
    OperationType string `json:"operationType,omitempty"`
    // SourceParent: The resource name of the folder's parent. Only applicable when
    // the operation_type is MOVE.
    SourceParent string `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:"-"`
}

func (*CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation) MarshalJSON ¶

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

type CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation ¶

CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation: Metadata describing a long running folder operation

type CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation struct {
    // DestinationParent: The resource name of the folder or organization we are
    // either creating the folder under or moving the folder to.
    DestinationParent string `json:"destinationParent,omitempty"`
    // DisplayName: The display name of the folder.
    DisplayName string `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.
    OperationType string `json:"operationType,omitempty"`
    // SourceParent: The resource name of the folder's parent. Only applicable when
    // the operation_type is MOVE.
    SourceParent string `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:"-"`
}

func (*CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation) MarshalJSON ¶

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

type CreateFolderMetadata ¶

CreateFolderMetadata: Metadata pertaining to the Folder creation process.

type CreateFolderMetadata struct {
    // DisplayName: The display name of the folder.
    DisplayName string `json:"displayName,omitempty"`
    // Parent: The resource name of the folder or organization we are creating the
    // folder under.
    Parent string `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:"-"`
}

func (*CreateFolderMetadata) MarshalJSON ¶

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

type CreateProjectMetadata ¶

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

type CreateProjectMetadata struct {
    // CreateTime: Creation time of the project creation workflow.
    CreateTime string `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.
    Gettable bool `json:"gettable,omitempty"`
    // Ready: True if the project creation process is complete.
    Ready bool `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:"-"`
}

func (*CreateProjectMetadata) MarshalJSON ¶

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

type CreateTagBindingMetadata ¶

CreateTagBindingMetadata: Runtime operation information for creating a TagValue.

type CreateTagBindingMetadata struct {
}

type CreateTagKeyMetadata ¶

CreateTagKeyMetadata: Runtime operation information for creating a TagKey.

type CreateTagKeyMetadata struct {
}

type CreateTagValueMetadata ¶

CreateTagValueMetadata: Runtime operation information for creating a TagValue.

type CreateTagValueMetadata struct {
}

type DeleteFolderMetadata ¶

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

type DeleteFolderMetadata struct {
}

type DeleteOrganizationMetadata ¶

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

type DeleteOrganizationMetadata struct {
}

type DeleteProjectMetadata ¶

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

type DeleteProjectMetadata struct {
}

type DeleteTagBindingMetadata ¶

DeleteTagBindingMetadata: Runtime operation information for deleting a TagBinding.

type DeleteTagBindingMetadata struct {
}

type DeleteTagKeyMetadata ¶

DeleteTagKeyMetadata: Runtime operation information for deleting a TagKey.

type DeleteTagKeyMetadata struct {
}

type DeleteTagValueMetadata ¶

DeleteTagValueMetadata: Runtime operation information for deleting a TagValue.

type DeleteTagValueMetadata struct {
}

type EffectiveTag ¶

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

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.
    Inherited bool `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}`.
    NamespacedTagKey string `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}`.
    NamespacedTagValue string `json:"namespacedTagValue,omitempty"`
    // TagKey: The name of the TagKey, in the format `tagKeys/{id}`, such as
    // `tagKeys/123`.
    TagKey string `json:"tagKey,omitempty"`
    // TagKeyParentName: The parent name of the tag key. Must be in the format
    // `organizations/{organization_id}` or `projects/{project_number}`
    TagKeyParentName string `json:"tagKeyParentName,omitempty"`
    // TagValue: Resource name for TagValue in the format `tagValues/456`.
    TagValue string `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:"-"`
}

func (*EffectiveTag) MarshalJSON ¶

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

type EffectiveTagsListCall ¶

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

func (*EffectiveTagsListCall) Context ¶

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

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

func (*EffectiveTagsListCall) Do ¶

func (c *EffectiveTagsListCall) Do(opts ...googleapi.CallOption) (*ListEffectiveTagsResponse, error)

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*EffectiveTagsListCall) Fields ¶

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

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

func (*EffectiveTagsListCall) Header ¶

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

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

func (*EffectiveTagsListCall) IfNoneMatch ¶

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

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

func (*EffectiveTagsListCall) PageSize ¶

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

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

func (*EffectiveTagsListCall) PageToken ¶

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

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

func (*EffectiveTagsListCall) Pages ¶

func (c *EffectiveTagsListCall) Pages(ctx context.Context, f func(*ListEffectiveTagsResponse) error) error

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

func (*EffectiveTagsListCall) Parent ¶

func (c *EffectiveTagsListCall) Parent(parent string) *EffectiveTagsListCall

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

type EffectiveTagsService ¶

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

func NewEffectiveTagsService ¶

func NewEffectiveTagsService(s *Service) *EffectiveTagsService

func (*EffectiveTagsService) List ¶

func (r *EffectiveTagsService) List() *EffectiveTagsListCall

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

type Empty ¶

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

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

type Expr ¶

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

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.
    Description string `json:"description,omitempty"`
    // Expression: Textual representation of an expression in Common Expression
    // Language syntax.
    Expression string `json:"expression,omitempty"`
    // Location: Optional. String indicating the location of the expression for
    // error reporting, e.g. a file name and a position in the file.
    Location string `json:"location,omitempty"`
    // Title: Optional. Title for the expression, i.e. a short string describing
    // its purpose. This can be used e.g. in UIs which allow to enter the
    // expression.
    Title string `json:"title,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Description") to
    // unconditionally include in API requests. By default, fields with empty 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:"-"`
}

func (*Expr) MarshalJSON ¶

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

type Folder ¶

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

type Folder struct {
    // CreateTime: Output only. Timestamp when the folder was created.
    CreateTime string `json:"createTime,omitempty"`
    // DeleteTime: Output only. Timestamp when the folder was requested to be
    // deleted.
    DeleteTime string `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}])?`.
    DisplayName string `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.
    Etag string `json:"etag,omitempty"`
    // Name: Output only. The resource name of the folder. Its format is
    // `folders/{folder_id}`, for example: "folders/1234".
    Name string `json:"name,omitempty"`
    // Parent: Required. The folder's parent's resource name. Updates to the
    // folder's parent must be performed using MoveFolder.
    Parent string `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.
    State string `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.
    UpdateTime string `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:"-"`
}

func (*Folder) MarshalJSON ¶

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

type FolderOperation ¶

FolderOperation: Metadata describing a long running folder operation

type FolderOperation struct {
    // DestinationParent: The resource name of the folder or organization we are
    // either creating the folder under or moving the folder to.
    DestinationParent string `json:"destinationParent,omitempty"`
    // DisplayName: The display name of the folder.
    DisplayName string `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.
    OperationType string `json:"operationType,omitempty"`
    // SourceParent: The resource name of the folder's parent. Only applicable when
    // the operation_type is MOVE.
    SourceParent string `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:"-"`
}

func (*FolderOperation) MarshalJSON ¶

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

type FolderOperationError ¶

FolderOperationError: A classification of the Folder Operation error.

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.
    ErrorMessageId string `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:"-"`
}

func (*FolderOperationError) MarshalJSON ¶

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

type FoldersCreateCall ¶

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

func (*FoldersCreateCall) Context ¶

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

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

func (*FoldersCreateCall) Do ¶

func (c *FoldersCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersCreateCall) Fields ¶

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

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

func (*FoldersCreateCall) Header ¶

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

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

type FoldersDeleteCall ¶

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

func (*FoldersDeleteCall) Context ¶

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

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

func (*FoldersDeleteCall) Do ¶

func (c *FoldersDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersDeleteCall) Fields ¶

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

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

func (*FoldersDeleteCall) Header ¶

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

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

type FoldersGetCall ¶

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

func (*FoldersGetCall) Context ¶

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

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

func (*FoldersGetCall) Do ¶

func (c *FoldersGetCall) Do(opts ...googleapi.CallOption) (*Folder, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersGetCall) Fields ¶

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

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

func (*FoldersGetCall) Header ¶

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

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

func (*FoldersGetCall) IfNoneMatch ¶

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

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

type FoldersGetIamPolicyCall ¶

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

func (*FoldersGetIamPolicyCall) Context ¶

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

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

func (*FoldersGetIamPolicyCall) Do ¶

func (c *FoldersGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersGetIamPolicyCall) Fields ¶

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

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

func (*FoldersGetIamPolicyCall) Header ¶

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

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

type FoldersListCall ¶

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

func (*FoldersListCall) Context ¶

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

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

func (*FoldersListCall) Do ¶

func (c *FoldersListCall) Do(opts ...googleapi.CallOption) (*ListFoldersResponse, error)

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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersListCall) Fields ¶

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

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

func (*FoldersListCall) Header ¶

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

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

func (*FoldersListCall) IfNoneMatch ¶

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

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

func (*FoldersListCall) PageSize ¶

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

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

func (*FoldersListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from.

func (*FoldersListCall) Pages ¶

func (c *FoldersListCall) Pages(ctx context.Context, f func(*ListFoldersResponse) error) error

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

func (*FoldersListCall) Parent ¶

func (c *FoldersListCall) Parent(parent string) *FoldersListCall

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

func (*FoldersListCall) ShowDeleted ¶

func (c *FoldersListCall) ShowDeleted(showDeleted bool) *FoldersListCall

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

type FoldersMoveCall ¶

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

func (*FoldersMoveCall) Context ¶

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

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

func (*FoldersMoveCall) Do ¶

func (c *FoldersMoveCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersMoveCall) Fields ¶

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

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

func (*FoldersMoveCall) Header ¶

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

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

type FoldersPatchCall ¶

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

func (*FoldersPatchCall) Context ¶

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

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

func (*FoldersPatchCall) Do ¶

func (c *FoldersPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersPatchCall) Fields ¶

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

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

func (*FoldersPatchCall) Header ¶

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

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

func (*FoldersPatchCall) UpdateMask ¶

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

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

type FoldersSearchCall ¶

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

func (*FoldersSearchCall) Context ¶

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

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

func (*FoldersSearchCall) Do ¶

func (c *FoldersSearchCall) Do(opts ...googleapi.CallOption) (*SearchFoldersResponse, error)

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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersSearchCall) Fields ¶

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

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

func (*FoldersSearchCall) Header ¶

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

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

func (*FoldersSearchCall) IfNoneMatch ¶

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

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

func (*FoldersSearchCall) PageSize ¶

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

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

func (*FoldersSearchCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to `SearchFolders` that indicates from where search should continue.

func (*FoldersSearchCall) Pages ¶

func (c *FoldersSearchCall) Pages(ctx context.Context, f func(*SearchFoldersResponse) error) error

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

func (*FoldersSearchCall) Query ¶

func (c *FoldersSearchCall) Query(query string) *FoldersSearchCall

Query sets the optional parameter "query": Search criteria used to select the folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR` can be used along with the suffix wildcard symbol `*`. The `displayName` field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. ``` | Field | Description | |-------------------------|----------------------------------------| | displayName | Filters by displayName. | | parent | Filters by parent (for example: folders/123). | | state, lifecycleState | Filters by state. | ``` Some example queries are: * Query `displayName=Test*` returns Folder resources 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 a parent resource. * Query `parent=folders/123 AND state=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource. * Query `displayName=\\"Test String\\" returns Folder resources with display names that include both "Test" and "String".

type FoldersService ¶

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

func NewFoldersService ¶

func NewFoldersService(s *Service) *FoldersService

func (*FoldersService) Create ¶

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 the created Folder. In order to succeed, the addition of this new folder must not violate the folder naming, height, or fanout constraints. + The folder's `display_name` must be distinct from all other folders that share its parent. + The addition of the folder must not cause the active folder hierarchy to exceed a height of 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; this provides additional headroom when moving folders that contain deleted folders. + The addition of the folder must not cause the total number of folders under its parent to exceed 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 constraint violations 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 on the identified parent.

func (*FoldersService) Delete ¶

func (r *FoldersService) Delete(name string) *FoldersDeleteCall

Delete: Requests deletion of a folder. The folder is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on an empty folder, where a folder is empty if it doesn't contain any folders or projects in the ACTIVE state. If called on a folder in DELETE_REQUESTED state the operation will result in a no-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) Get ¶

func (r *FoldersService) Get(name string) *FoldersGetCall

Get: Retrieves a folder identified by the supplied resource name. Valid folder 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) GetIamPolicy ¶

func (r *FoldersService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *FoldersGetIamPolicyCall

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

• resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*FoldersService) List ¶

func (r *FoldersService) List() *FoldersListCall

List: Lists the folders that are direct descendants of supplied parent resource. `list()` provides a strongly consistent view of the folders underneath the specified parent resource. `list()` returns folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have `resourcemanager.folders.list` permission on the identified parent.

func (*FoldersService) Move ¶

func (r *FoldersService) Move(name string, 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. Upon success, the `Operation.response` field will be populated with the moved folder. Upon failure, a `FolderOperationError` categorizing the failure cause will be returned - if the failure occurs synchronously then the `FolderOperationError` will be returned in the `Status.details` field. If it occurs asynchronously, then the FolderOperation will be returned in the `Operation.error` field. In addition, the `Operation.metadata` field will be populated with a `FolderOperation` message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height, or fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.move` permission on the folder's current and proposed new parent.

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

func (*FoldersService) Patch ¶

func (r *FoldersService) Patch(name string, 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 CreateFolder documentation. The folder's `display_name` must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is captured by the regular expression: `\p{L}\p{N}{1,28}[\p{L}\p{N}]`. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a `PreconditionFailure` explaining this violation will be returned in the Status.details field.

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

func (*FoldersService) Search ¶

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 to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`.

func (*FoldersService) SetIamPolicy ¶

func (r *FoldersService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *FoldersSetIamPolicyCall

SetIamPolicy: Sets the access control policy on a folder, replacing any existing 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.

• resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*FoldersService) TestIamPermissions ¶

func (r *FoldersService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *FoldersTestIamPermissionsCall

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

• resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*FoldersService) Undelete ¶

func (r *FoldersService) Undelete(name string, undeletefolderrequest *UndeleteFolderRequest) *FoldersUndeleteCall

Undelete: Cancels the deletion request for a folder. This method may be called on a folder in any state. If the folder is in the ACTIVE state the result will be a no-op success. In order to succeed, the folder's parent must be in the ACTIVE state. In addition, reintroducing the folder into the tree must not violate folder naming, height, and fanout constraints described 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}`.

type FoldersSetIamPolicyCall ¶

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

func (*FoldersSetIamPolicyCall) Context ¶

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

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

func (*FoldersSetIamPolicyCall) Do ¶

func (c *FoldersSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersSetIamPolicyCall) Fields ¶

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

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

func (*FoldersSetIamPolicyCall) Header ¶

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

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

type FoldersTestIamPermissionsCall ¶

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

func (*FoldersTestIamPermissionsCall) Context ¶

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

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

func (*FoldersTestIamPermissionsCall) Do ¶

func (c *FoldersTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersTestIamPermissionsCall) Fields ¶

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

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

func (*FoldersTestIamPermissionsCall) Header ¶

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

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

type FoldersUndeleteCall ¶

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

func (*FoldersUndeleteCall) Context ¶

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

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

func (*FoldersUndeleteCall) Do ¶

func (c *FoldersUndeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersUndeleteCall) Fields ¶

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

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

func (*FoldersUndeleteCall) Header ¶

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

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

type GetIamPolicyRequest ¶

GetIamPolicyRequest: Request message for `GetIamPolicy` method.

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

func (*GetIamPolicyRequest) MarshalJSON ¶

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

type GetPolicyOptions ¶

GetPolicyOptions: Encapsulates settings provided to GetIamPolicy.

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).
    RequestedPolicyVersion int64 `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:"-"`
}

func (*GetPolicyOptions) MarshalJSON ¶

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

type Lien ¶

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

type Lien struct {
    // CreateTime: The creation time of this Lien.
    CreateTime string `json:"createTime,omitempty"`
    // Name: A system-generated unique identifier for this Lien. Example:
    // `liens/1234abcd`
    Name string `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'
    Origin string `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`
    Parent string `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'
    Reason string `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:"-"`
}

func (*Lien) MarshalJSON ¶

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

type LiensCreateCall ¶

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

func (*LiensCreateCall) Context ¶

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

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*LiensCreateCall) Fields ¶

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

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

func (*LiensCreateCall) Header ¶

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

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

type LiensDeleteCall ¶

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

func (*LiensDeleteCall) Context ¶

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

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

func (*LiensDeleteCall) Do ¶

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

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*LiensDeleteCall) Fields ¶

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

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

func (*LiensDeleteCall) Header ¶

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

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

type LiensGetCall ¶

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

func (*LiensGetCall) Context ¶

func (c *LiensGetCall) Context(ctx context.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether 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. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*LiensGetCall) Header ¶

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

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

func (*LiensGetCall) IfNoneMatch ¶

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

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

type LiensListCall ¶

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

func (*LiensListCall) Context ¶

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

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

func (*LiensListCall) Do ¶

func (c *LiensListCall) Do(opts ...googleapi.CallOption) (*ListLiensResponse, error)

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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*LiensListCall) Fields ¶

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

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

func (*LiensListCall) Header ¶

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

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

func (*LiensListCall) IfNoneMatch ¶

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

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

func (*LiensListCall) PageSize ¶

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

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

func (*LiensListCall) PageToken ¶

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

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

func (*LiensListCall) Pages ¶

func (c *LiensListCall) Pages(ctx context.Context, f func(*ListLiensResponse) error) error

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

func (*LiensListCall) Parent ¶

func (c *LiensListCall) Parent(parent string) *LiensListCall

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

type LiensService ¶

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

func NewLiensService ¶

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 the number of Liens which may be applied.

func (*LiensService) Delete ¶

func (r *LiensService) Delete(nameid string) *LiensDeleteCall

Delete: Delete a Lien by `name`. Callers of this method will require permission 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(nameid string) *LiensGetCall

Get: Retrieve a Lien by `name`. Callers of this method will require permission 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 this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`.

type ListEffectiveTagsResponse ¶

ListEffectiveTagsResponse: The response of ListEffectiveTags.

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

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

func (*ListEffectiveTagsResponse) MarshalJSON ¶

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

type ListFoldersResponse ¶

ListFoldersResponse: The ListFolders response message.

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

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

func (*ListFoldersResponse) MarshalJSON ¶

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

type ListLiensResponse ¶

ListLiensResponse: The response message for Liens.ListLiens.

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

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

func (*ListLiensResponse) MarshalJSON ¶

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

type ListProjectsResponse ¶

ListProjectsResponse: A page of the response received from the ListProjects method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page. NOTE: A response may contain fewer elements than the request `page_size` and still have a `next_page_token`.

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.
    NextPageToken string `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:"-"`
}

func (*ListProjectsResponse) MarshalJSON ¶

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

type ListTagBindingsResponse ¶

ListTagBindingsResponse: The ListTagBindings response.

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.
    NextPageToken string `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:"-"`
}

func (*ListTagBindingsResponse) MarshalJSON ¶

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

type ListTagHoldsResponse ¶

ListTagHoldsResponse: The ListTagHolds response.

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.
    NextPageToken string `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:"-"`
}

func (*ListTagHoldsResponse) MarshalJSON ¶

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

type ListTagKeysResponse ¶

ListTagKeysResponse: The ListTagKeys response message.

type ListTagKeysResponse struct {
    // NextPageToken: A pagination token returned from a previous call to
    // `ListTagKeys` that indicates from where listing should continue.
    NextPageToken string `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:"-"`
}

func (*ListTagKeysResponse) MarshalJSON ¶

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

type ListTagValuesResponse ¶

ListTagValuesResponse: The ListTagValues response.

type ListTagValuesResponse struct {
    // NextPageToken: A pagination token returned from a previous call to
    // `ListTagValues` that indicates from where listing should continue. This is
    // currently not used, but the server may at any point start supplying a valid
    // token.
    NextPageToken string `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:"-"`
}

func (*ListTagValuesResponse) MarshalJSON ¶

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

type MoveFolderMetadata ¶

MoveFolderMetadata: Metadata pertaining to the folder move process.

type MoveFolderMetadata struct {
    // DestinationParent: The resource name of the folder or organization to move
    // the folder to.
    DestinationParent string `json:"destinationParent,omitempty"`
    // DisplayName: The display name of the folder.
    DisplayName string `json:"displayName,omitempty"`
    // SourceParent: The resource name of the folder's parent.
    SourceParent string `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:"-"`
}

func (*MoveFolderMetadata) MarshalJSON ¶

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

type MoveFolderRequest ¶

MoveFolderRequest: The MoveFolder request message.

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}`.
    DestinationParent string `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:"-"`
}

func (*MoveFolderRequest) MarshalJSON ¶

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

type MoveProjectMetadata ¶

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

type MoveProjectMetadata struct {
}

type MoveProjectRequest ¶

MoveProjectRequest: The request sent to MoveProject method.

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

func (*MoveProjectRequest) MarshalJSON ¶

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

type Operation ¶

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

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.
    Done bool `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.
    Metadata googleapi.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}`.
    Name string `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`.
    Response googleapi.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:"-"`
}

func (*Operation) MarshalJSON ¶

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

type OperationsGetCall ¶

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

func (*OperationsGetCall) Context ¶

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

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

func (*OperationsGetCall) Do ¶

func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsGetCall) Fields ¶

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

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

func (*OperationsGetCall) Header ¶

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

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

func (*OperationsGetCall) IfNoneMatch ¶

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

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

type OperationsService ¶

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

func NewOperationsService ¶

func NewOperationsService(s *Service) *OperationsService

func (*OperationsService) Get ¶

func (r *OperationsService) Get(name string) *OperationsGetCall

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

- name: The name of the operation resource.

type Organization ¶

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

type Organization struct {
    // CreateTime: Output only. Timestamp when the Organization was created.
    CreateTime string `json:"createTime,omitempty"`
    // DeleteTime: Output only. Timestamp when the Organization was requested for
    // deletion.
    DeleteTime string `json:"deleteTime,omitempty"`
    // DirectoryCustomerId: Immutable. The G Suite / Workspace customer id used in
    // the Directory API.
    DirectoryCustomerId string `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.
    DisplayName string `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.
    Etag string `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".
    Name string `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.
    State string `json:"state,omitempty"`
    // UpdateTime: Output only. Timestamp when the Organization was last modified.
    UpdateTime string `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:"-"`
}

func (*Organization) MarshalJSON ¶

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

type OrganizationsGetCall ¶

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

func (*OrganizationsGetCall) Context ¶

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

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

func (*OrganizationsGetCall) Do ¶

func (c *OrganizationsGetCall) Do(opts ...googleapi.CallOption) (*Organization, error)

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 check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsGetCall) Fields ¶

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

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

func (*OrganizationsGetCall) Header ¶

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

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

func (*OrganizationsGetCall) IfNoneMatch ¶

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

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

type OrganizationsGetIamPolicyCall ¶

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

func (*OrganizationsGetIamPolicyCall) Context ¶

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

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

func (*OrganizationsGetIamPolicyCall) Do ¶

func (c *OrganizationsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsGetIamPolicyCall) Fields ¶

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

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

func (*OrganizationsGetIamPolicyCall) Header ¶

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

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

type OrganizationsSearchCall ¶

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

func (*OrganizationsSearchCall) Context ¶

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

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

func (*OrganizationsSearchCall) Do ¶

func (c *OrganizationsSearchCall) Do(opts ...googleapi.CallOption) (*SearchOrganizationsResponse, error)

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsSearchCall) Fields ¶

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

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

func (*OrganizationsSearchCall) Header ¶

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

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

func (*OrganizationsSearchCall) IfNoneMatch ¶

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

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

func (*OrganizationsSearchCall) PageSize ¶

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

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

func (*OrganizationsSearchCall) PageToken ¶

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

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

func (*OrganizationsSearchCall) Pages ¶

func (c *OrganizationsSearchCall) Pages(ctx context.Context, f func(*SearchOrganizationsResponse) error) error

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

func (*OrganizationsSearchCall) Query ¶

func (c *OrganizationsSearchCall) Query(query string) *OrganizationsSearchCall

Query sets the optional parameter "query": An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive. ``` | Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. | ``` Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Query `directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Query `domain:google.com` returns Organization resources corresponding to the domain `google.com`.

type OrganizationsService ¶

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

func NewOrganizationsService ¶

func NewOrganizationsService(s *Service) *OrganizationsService

func (*OrganizationsService) Get ¶

func (r *OrganizationsService) Get(name string) *OrganizationsGetCall

Get: Fetches an organization resource identified by the specified resource name.

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

func (*OrganizationsService) GetIamPolicy ¶

func (r *OrganizationsService) GetIamPolicy(resource string, 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.

• resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*OrganizationsService) Search ¶

func (r *OrganizationsService) Search() *OrganizationsSearchCall

Search: Searches organization resources that are visible to the user and satisfy the specified filter. This method returns organizations in an unspecified order. New organizations do not necessarily appear at the end of the results, and may take a small amount of time to appear. Search will only return organizations on which the user has the permission `resourcemanager.organizations.get` or has super admin privileges.

func (*OrganizationsService) SetIamPolicy ¶

func (r *OrganizationsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *OrganizationsSetIamPolicyCall

SetIamPolicy: Sets the access control policy on an organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, for example: "organizations/123". Authorization requires the IAM permission `resourcemanager.organizations.setIamPolicy` on the specified organization.

• resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*OrganizationsService) TestIamPermissions ¶

func (r *OrganizationsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *OrganizationsTestIamPermissionsCall

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

• resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

type OrganizationsSetIamPolicyCall ¶

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

func (*OrganizationsSetIamPolicyCall) Context ¶

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

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

func (*OrganizationsSetIamPolicyCall) Do ¶

func (c *OrganizationsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsSetIamPolicyCall) Fields ¶

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

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

func (*OrganizationsSetIamPolicyCall) Header ¶

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

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

type OrganizationsTestIamPermissionsCall ¶

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

func (*OrganizationsTestIamPermissionsCall) Context ¶

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

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

func (*OrganizationsTestIamPermissionsCall) Do ¶

func (c *OrganizationsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsTestIamPermissionsCall) Fields ¶

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

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

func (*OrganizationsTestIamPermissionsCall) Header ¶

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

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

type Policy ¶

Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "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.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer 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 ``` For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

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.
    Etag string `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).
    Version int64 `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:"-"`
}

func (*Policy) MarshalJSON ¶

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

type Project ¶

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

type Project struct {
    // CreateTime: Output only. Creation time.
    CreateTime string `json:"createTime,omitempty"`
    // DeleteTime: Output only. The time at which this resource was requested for
    // deletion.
    DeleteTime string `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`
    DisplayName string `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.
    Etag string `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`
    Name string `json:"name,omitempty"`
    // Parent: Optional. A reference to a parent Resource. eg., `organizations/123`
    // or `folders/876`.
    Parent string `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`
    ProjectId string `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.
    State string `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.
    UpdateTime string `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:"-"`
}

func (*Project) MarshalJSON ¶

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

type ProjectCreationStatus ¶

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

type ProjectCreationStatus struct {
    // CreateTime: Creation time of the project creation workflow.
    CreateTime string `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.
    Gettable bool `json:"gettable,omitempty"`
    // Ready: True if the project creation process is complete.
    Ready bool `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:"-"`
}

func (*ProjectCreationStatus) MarshalJSON ¶

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

type ProjectsCreateCall ¶

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

func (*ProjectsCreateCall) Context ¶

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

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

func (*ProjectsCreateCall) Do ¶

func (c *ProjectsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsCreateCall) Fields ¶

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

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

func (*ProjectsCreateCall) Header ¶

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

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

type ProjectsDeleteCall ¶

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

func (*ProjectsDeleteCall) Context ¶

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

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

func (*ProjectsDeleteCall) Do ¶

func (c *ProjectsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDeleteCall) Fields ¶

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

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

func (*ProjectsDeleteCall) Header ¶

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

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

type ProjectsGetCall ¶

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

func (*ProjectsGetCall) Context ¶

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

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

func (*ProjectsGetCall) Do ¶

func (c *ProjectsGetCall) Do(opts ...googleapi.CallOption) (*Project, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGetCall) Fields ¶

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

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

func (*ProjectsGetCall) Header ¶

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

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

func (*ProjectsGetCall) IfNoneMatch ¶

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

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

type ProjectsGetIamPolicyCall ¶

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

func (*ProjectsGetIamPolicyCall) Context ¶

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

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

func (*ProjectsGetIamPolicyCall) Do ¶

func (c *ProjectsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGetIamPolicyCall) Fields ¶

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

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

func (*ProjectsGetIamPolicyCall) Header ¶

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

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

type ProjectsListCall ¶

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

func (*ProjectsListCall) Context ¶

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

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

func (*ProjectsListCall) Do ¶

func (c *ProjectsListCall) Do(opts ...googleapi.CallOption) (*ListProjectsResponse, error)

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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsListCall) Fields ¶

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

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

func (*ProjectsListCall) Header ¶

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

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

func (*ProjectsListCall) IfNoneMatch ¶

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

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

func (*ProjectsListCall) PageSize ¶

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

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

func (*ProjectsListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.

func (*ProjectsListCall) Pages ¶

func (c *ProjectsListCall) Pages(ctx context.Context, f func(*ListProjectsResponse) error) error

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

func (*ProjectsListCall) Parent ¶

func (c *ProjectsListCall) Parent(parent string) *ProjectsListCall

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

func (*ProjectsListCall) ShowDeleted ¶

func (c *ProjectsListCall) ShowDeleted(showDeleted bool) *ProjectsListCall

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

type ProjectsMoveCall ¶

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

func (*ProjectsMoveCall) Context ¶

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

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

func (*ProjectsMoveCall) Do ¶

func (c *ProjectsMoveCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsMoveCall) Fields ¶

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

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

func (*ProjectsMoveCall) Header ¶

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

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

type ProjectsPatchCall ¶

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

func (*ProjectsPatchCall) Context ¶

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

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

func (*ProjectsPatchCall) Do ¶

func (c *ProjectsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPatchCall) Fields ¶

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

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

func (*ProjectsPatchCall) Header ¶

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

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

func (*ProjectsPatchCall) UpdateMask ¶

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

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

type ProjectsSearchCall ¶

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

func (*ProjectsSearchCall) Context ¶

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

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

func (*ProjectsSearchCall) Do ¶

func (c *ProjectsSearchCall) Do(opts ...googleapi.CallOption) (*SearchProjectsResponse, error)

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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSearchCall) Fields ¶

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

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

func (*ProjectsSearchCall) Header ¶

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

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

func (*ProjectsSearchCall) IfNoneMatch ¶

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

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

func (*ProjectsSearchCall) PageSize ¶

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

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

func (*ProjectsSearchCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.

func (*ProjectsSearchCall) Pages ¶

func (c *ProjectsSearchCall) Pages(ctx context.Context, f func(*SearchProjectsResponse) error) error

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

func (*ProjectsSearchCall) Query ¶

func (c *ProjectsSearchCall) Query(query string) *ProjectsSearchCall

Query sets the optional parameter "query": A query string for searching for projects that the caller has `resourcemanager.projects.get` permission to. If multiple fields are included in the query, then it will return results that 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 over parent.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 by state. | | labels | Filters by label name or value. | | labels.\ (where *key* is the name of a label) | Filters by label name.| ``` Search expressions are case insensitive. Some examples queries: ``` | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with "how". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `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 user has the `resourcemanager.projects.get` permission.

type ProjectsService ¶

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

func NewProjectsService ¶

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService) Create ¶

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 takes a 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) Delete ¶

func (r *ProjectsService) Delete(name string) *ProjectsDeleteCall

Delete: Marks the project identified by the specified `name` (for example, `projects/415104041262`) for deletion. This method will only affect the project if it has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with GetProject, and the project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the project is not retrievable by the GetProject, ListProjects, and SearchProjects methods. This method behaves idempotently, such that deleting a `DELETE_REQUESTED` project will not cause an error, but also won't do anything. The caller must have `resourcemanager.projects.delete` permissions for this project.

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

func (*ProjectsService) Get ¶

func (r *ProjectsService) Get(name string) *ProjectsGetCall

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) GetIamPolicy ¶

func (r *ProjectsService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *ProjectsGetIamPolicyCall

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

• resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsService) List ¶

func (r *ProjectsService) List() *ProjectsListCall

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

func (*ProjectsService) Move ¶

func (r *ProjectsService) Move(name string, moveprojectrequest *MoveProjectRequest) *ProjectsMoveCall

Move: Move a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process 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's current and proposed new parent. If project has no current parent, or it currently does not have an associated organization resource, you will also need the `resourcemanager.projects.setIamPolicy` permission in the project.

- name: The name of the project to move.

func (*ProjectsService) Patch ¶

func (r *ProjectsService) Patch(name string, project *Project) *ProjectsPatchCall

Patch: Updates the `display_name` and labels of the project identified by the specified `name` (for example, `projects/415104041262`). Deleting all labels 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 int64 generated number prefixed by "projects/". Example: `projects/415104041262`.

func (*ProjectsService) Search ¶

func (r *ProjectsService) Search() *ProjectsSearchCall

Search: Search for projects that the caller has the `resourcemanager.projects.get` permission on, and also satisfy the specified query. This method returns projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method.

func (*ProjectsService) SetIamPolicy ¶

func (r *ProjectsService) SetIamPolicy(resource string, 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 append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing 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`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible.

• resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsService) TestIamPermissions ¶

func (r *ProjectsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsTestIamPermissionsCall

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

• resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsService) Undelete ¶

func (r *ProjectsService) Undelete(name string, undeleteprojectrequest *UndeleteProjectRequest) *ProjectsUndeleteCall

Undelete: Restores the project identified by the specified `name` (for example, `projects/415104041262`). You can only use this method for a project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, 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.

type ProjectsSetIamPolicyCall ¶

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

func (*ProjectsSetIamPolicyCall) Context ¶

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

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

func (*ProjectsSetIamPolicyCall) Do ¶

func (c *ProjectsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSetIamPolicyCall) Fields ¶

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

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

func (*ProjectsSetIamPolicyCall) Header ¶

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

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

type ProjectsTestIamPermissionsCall ¶

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

func (*ProjectsTestIamPermissionsCall) Context ¶

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

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

func (*ProjectsTestIamPermissionsCall) Do ¶

func (c *ProjectsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsTestIamPermissionsCall) Fields ¶

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

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

func (*ProjectsTestIamPermissionsCall) Header ¶

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

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

type ProjectsUndeleteCall ¶

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

func (*ProjectsUndeleteCall) Context ¶

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

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

func (*ProjectsUndeleteCall) Do ¶

func (c *ProjectsUndeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsUndeleteCall) Fields ¶

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

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

func (*ProjectsUndeleteCall) Header ¶

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

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

type SearchFoldersResponse ¶

SearchFoldersResponse: The response message for searching folders.

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

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

func (*SearchFoldersResponse) MarshalJSON ¶

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

type SearchOrganizationsResponse ¶

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

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.
    NextPageToken string `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:"-"`
}

func (*SearchOrganizationsResponse) MarshalJSON ¶

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

type SearchProjectsResponse ¶

SearchProjectsResponse: A page of the response received from the SearchProjects method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.

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.
    NextPageToken string `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:"-"`
}

func (*SearchProjectsResponse) MarshalJSON ¶

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

type Service ¶

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

    EffectiveTags *EffectiveTagsService

    Folders *FoldersService

    Liens *LiensService

    Operations *OperationsService

    Organizations *OrganizationsService

    Projects *ProjectsService

    TagBindings *TagBindingsService

    TagKeys *TagKeysService

    TagValues *TagValuesService
    // contains filtered or unexported fields
}

func New ¶

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

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

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

func NewService ¶

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

NewService creates a new Service.

type SetIamPolicyRequest ¶

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

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"
    UpdateMask string `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:"-"`
}

func (*SetIamPolicyRequest) MarshalJSON ¶

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

type Status ¶

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

type Status struct {
    // Code: The status code, which should be an enum value of google.rpc.Code.
    Code int64 `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.
    Message string `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:"-"`
}

func (*Status) MarshalJSON ¶

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

type TagBinding ¶

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

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`).
    Name string `json:"name,omitempty"`
    // Parent: The full resource name of the resource the TagValue is bound to.
    // E.g. `//cloudresourcemanager.googleapis.com/projects/123`
    Parent string `json:"parent,omitempty"`
    // TagValue: The TagValue of the TagBinding. Must be of the form
    // `tagValues/456`.
    TagValue string `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.
    TagValueNamespacedName string `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:"-"`
}

func (*TagBinding) MarshalJSON ¶

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

type TagBindingsCreateCall ¶

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

func (*TagBindingsCreateCall) Context ¶

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

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

func (*TagBindingsCreateCall) Do ¶

func (c *TagBindingsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagBindingsCreateCall) Fields ¶

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

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

func (*TagBindingsCreateCall) Header ¶

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

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

func (*TagBindingsCreateCall) ValidateOnly ¶

func (c *TagBindingsCreateCall) ValidateOnly(validateOnly bool) *TagBindingsCreateCall

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

type TagBindingsDeleteCall ¶

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

func (*TagBindingsDeleteCall) Context ¶

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

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

func (*TagBindingsDeleteCall) Do ¶

func (c *TagBindingsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagBindingsDeleteCall) Fields ¶

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

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

func (*TagBindingsDeleteCall) Header ¶

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

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

type TagBindingsListCall ¶

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

func (*TagBindingsListCall) Context ¶

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

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

func (*TagBindingsListCall) Do ¶

func (c *TagBindingsListCall) Do(opts ...googleapi.CallOption) (*ListTagBindingsResponse, error)

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagBindingsListCall) Fields ¶

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

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

func (*TagBindingsListCall) Header ¶

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

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

func (*TagBindingsListCall) IfNoneMatch ¶

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

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

func (*TagBindingsListCall) PageSize ¶

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

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

func (*TagBindingsListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to `ListTagBindings` that indicates where this listing should continue from.

func (*TagBindingsListCall) Pages ¶

func (c *TagBindingsListCall) Pages(ctx context.Context, f func(*ListTagBindingsResponse) error) error

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

func (*TagBindingsListCall) Parent ¶

func (c *TagBindingsListCall) Parent(parent string) *TagBindingsListCall

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

type TagBindingsService ¶

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

func NewTagBindingsService ¶

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 ¶

func (r *TagBindingsService) Delete(name string) *TagBindingsDeleteCall

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/tag Values/456`).

func (*TagBindingsService) List ¶

func (r *TagBindingsService) List() *TagBindingsListCall

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

type TagHold ¶

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

type TagHold struct {
    // CreateTime: Output only. The time this TagHold was created.
    CreateTime string `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`
    HelpLink string `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`
    Holder string `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.
    Name string `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`
    Origin string `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:"-"`
}

func (*TagHold) MarshalJSON ¶

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

type TagKey ¶

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

type TagKey struct {
    // CreateTime: Output only. Creation time.
    CreateTime string `json:"createTime,omitempty"`
    // Description: Optional. User-assigned description of the TagKey. Must not
    // exceed 256 characters. Read-write.
    Description string `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.
    Etag string `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.
    Name string `json:"name,omitempty"`
    // NamespacedName: Output only. Immutable. Namespaced name of the TagKey.
    NamespacedName string `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}`.
    Parent string `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.
    Purpose string `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-63 characters, beginning and ending with an
    // alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots
    // (.), and alphanumerics between.
    ShortName string `json:"shortName,omitempty"`
    // UpdateTime: Output only. Update time.
    UpdateTime string `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:"-"`
}

func (*TagKey) MarshalJSON ¶

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

type TagKeysCreateCall ¶

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

func (*TagKeysCreateCall) Context ¶

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

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

func (*TagKeysCreateCall) Do ¶

func (c *TagKeysCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagKeysCreateCall) Fields ¶

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

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

func (*TagKeysCreateCall) Header ¶

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

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

func (*TagKeysCreateCall) ValidateOnly ¶

func (c *TagKeysCreateCall) ValidateOnly(validateOnly bool) *TagKeysCreateCall

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

type TagKeysDeleteCall ¶

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

func (*TagKeysDeleteCall) Context ¶

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

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

func (*TagKeysDeleteCall) Do ¶

func (c *TagKeysDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagKeysDeleteCall) Etag ¶

func (c *TagKeysDeleteCall) Etag(etag string) *TagKeysDeleteCall

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

func (*TagKeysDeleteCall) Fields ¶

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

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

func (*TagKeysDeleteCall) Header ¶

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

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

func (*TagKeysDeleteCall) ValidateOnly ¶

func (c *TagKeysDeleteCall) ValidateOnly(validateOnly bool) *TagKeysDeleteCall

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

type TagKeysGetCall ¶

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

func (*TagKeysGetCall) Context ¶

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

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

func (*TagKeysGetCall) Do ¶

func (c *TagKeysGetCall) Do(opts ...googleapi.CallOption) (*TagKey, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagKeysGetCall) Fields ¶

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

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

func (*TagKeysGetCall) Header ¶

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

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

func (*TagKeysGetCall) IfNoneMatch ¶

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

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

type TagKeysGetIamPolicyCall ¶

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

func (*TagKeysGetIamPolicyCall) Context ¶

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

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

func (*TagKeysGetIamPolicyCall) Do ¶

func (c *TagKeysGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagKeysGetIamPolicyCall) Fields ¶

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

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

func (*TagKeysGetIamPolicyCall) Header ¶

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

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

type TagKeysGetNamespacedCall ¶

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

func (*TagKeysGetNamespacedCall) Context ¶

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

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

func (*TagKeysGetNamespacedCall) Do ¶

func (c *TagKeysGetNamespacedCall) Do(opts ...googleapi.CallOption) (*TagKey, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagKeysGetNamespacedCall) Fields ¶

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

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

func (*TagKeysGetNamespacedCall) Header ¶

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

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

func (*TagKeysGetNamespacedCall) IfNoneMatch ¶

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

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

func (*TagKeysGetNamespacedCall) Name ¶

func (c *TagKeysGetNamespacedCall) Name(name string) *TagKeysGetNamespacedCall

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

type TagKeysListCall ¶

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

func (*TagKeysListCall) Context ¶

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

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

func (*TagKeysListCall) Do ¶

func (c *TagKeysListCall) Do(opts ...googleapi.CallOption) (*ListTagKeysResponse, error)

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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagKeysListCall) Fields ¶

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

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

func (*TagKeysListCall) Header ¶

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

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

func (*TagKeysListCall) IfNoneMatch ¶

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

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

func (*TagKeysListCall) PageSize ¶

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

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

func (*TagKeysListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to `ListTagKey` that indicates where this listing should continue from.

func (*TagKeysListCall) Pages ¶

func (c *TagKeysListCall) Pages(ctx context.Context, f func(*ListTagKeysResponse) error) error

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

func (*TagKeysListCall) Parent ¶

func (c *TagKeysListCall) Parent(parent string) *TagKeysListCall

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

type TagKeysPatchCall ¶

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

func (*TagKeysPatchCall) Context ¶

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

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

func (*TagKeysPatchCall) Do ¶

func (c *TagKeysPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagKeysPatchCall) Fields ¶

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

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

func (*TagKeysPatchCall) Header ¶

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

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

func (*TagKeysPatchCall) UpdateMask ¶

func (c *TagKeysPatchCall) UpdateMask(updateMask string) *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(validateOnly bool) *TagKeysPatchCall

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

type TagKeysService ¶

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

func NewTagKeysService ¶

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 is sent while the original request is in process, the second request will receive an error. A maximum of 1000 TagKeys can exist under a parent at any given time.

func (*TagKeysService) Delete ¶

func (r *TagKeysService) Delete(name string) *TagKeysDeleteCall

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

• 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 or it will not be deleted successfully.

func (*TagKeysService) Get ¶

func (r *TagKeysService) Get(name string) *TagKeysGetCall

Get: Retrieves a TagKey. This method will return `PERMISSION_DENIED` if the key 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(resource string, getiampolicyrequest *GetIamPolicyRequest) *TagKeysGetIamPolicyCall

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

• resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*TagKeysService) GetNamespaced ¶

func (r *TagKeysService) GetNamespaced() *TagKeysGetNamespacedCall

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

func (*TagKeysService) List ¶

func (r *TagKeysService) List() *TagKeysListCall

List: Lists all TagKeys for a parent resource.

func (*TagKeysService) Patch ¶

func (r *TagKeysService) Patch(name string, 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 for the TagKey.

func (*TagKeysService) SetIamPolicy ¶

func (r *TagKeysService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *TagKeysSetIamPolicyCall

SetIamPolicy: Sets the access control policy on a TagKey, replacing any existing 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 identified tagValue.

• resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*TagKeysService) TestIamPermissions ¶

func (r *TagKeysService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *TagKeysTestIamPermissionsCall

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

• resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

type TagKeysSetIamPolicyCall ¶

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

func (*TagKeysSetIamPolicyCall) Context ¶

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

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

func (*TagKeysSetIamPolicyCall) Do ¶

func (c *TagKeysSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagKeysSetIamPolicyCall) Fields ¶

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

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

func (*TagKeysSetIamPolicyCall) Header ¶

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

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

type TagKeysTestIamPermissionsCall ¶

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

func (*TagKeysTestIamPermissionsCall) Context ¶

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

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

func (*TagKeysTestIamPermissionsCall) Do ¶

func (c *TagKeysTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagKeysTestIamPermissionsCall) Fields ¶

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

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

func (*TagKeysTestIamPermissionsCall) Header ¶

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

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

type TagValue ¶

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

type TagValue struct {
    // CreateTime: Output only. Creation time.
    CreateTime string `json:"createTime,omitempty"`
    // Description: Optional. User-assigned description of the TagValue. Must not
    // exceed 256 characters. Read-write.
    Description string `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.
    Etag string `json:"etag,omitempty"`
    // Name: Immutable. Resource name for TagValue in the format `tagValues/456`.
    Name string `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}`.
    NamespacedName string `json:"namespacedName,omitempty"`
    // Parent: Immutable. The resource name of the new TagValue's parent TagKey.
    // Must be of the form `tagKeys/{tag_key_id}`.
    Parent string `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 63 characters or less, beginning and ending with an
    // alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots
    // (.), and alphanumerics between.
    ShortName string `json:"shortName,omitempty"`
    // UpdateTime: Output only. Update time.
    UpdateTime string `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:"-"`
}

func (*TagValue) MarshalJSON ¶

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

type TagValuesCreateCall ¶

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

func (*TagValuesCreateCall) Context ¶

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

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

func (*TagValuesCreateCall) Do ¶

func (c *TagValuesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagValuesCreateCall) Fields ¶

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

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

func (*TagValuesCreateCall) Header ¶

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

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

func (*TagValuesCreateCall) ValidateOnly ¶

func (c *TagValuesCreateCall) ValidateOnly(validateOnly bool) *TagValuesCreateCall

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

type TagValuesDeleteCall ¶

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

func (*TagValuesDeleteCall) Context ¶

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

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

func (*TagValuesDeleteCall) Do ¶

func (c *TagValuesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagValuesDeleteCall) Etag ¶

func (c *TagValuesDeleteCall) Etag(etag string) *TagValuesDeleteCall

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

func (*TagValuesDeleteCall) Fields ¶

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

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

func (*TagValuesDeleteCall) Header ¶

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

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

func (*TagValuesDeleteCall) ValidateOnly ¶

func (c *TagValuesDeleteCall) ValidateOnly(validateOnly bool) *TagValuesDeleteCall

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

type TagValuesGetCall ¶

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

func (*TagValuesGetCall) Context ¶

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

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

func (*TagValuesGetCall) Do ¶

func (c *TagValuesGetCall) Do(opts ...googleapi.CallOption) (*TagValue, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagValuesGetCall) Fields ¶

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

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

func (*TagValuesGetCall) Header ¶

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

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

func (*TagValuesGetCall) IfNoneMatch ¶

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

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

type TagValuesGetIamPolicyCall ¶

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

func (*TagValuesGetIamPolicyCall) Context ¶

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

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

func (*TagValuesGetIamPolicyCall) Do ¶

func (c *TagValuesGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagValuesGetIamPolicyCall) Fields ¶

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

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

func (*TagValuesGetIamPolicyCall) Header ¶

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

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

type TagValuesGetNamespacedCall ¶

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

func (*TagValuesGetNamespacedCall) Context ¶

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

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

func (*TagValuesGetNamespacedCall) Do ¶

func (c *TagValuesGetNamespacedCall) Do(opts ...googleapi.CallOption) (*TagValue, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagValuesGetNamespacedCall) Fields ¶

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

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

func (*TagValuesGetNamespacedCall) Header ¶

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

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

func (*TagValuesGetNamespacedCall) IfNoneMatch ¶

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

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

func (*TagValuesGetNamespacedCall) Name ¶

func (c *TagValuesGetNamespacedCall) Name(name string) *TagValuesGetNamespacedCall

Name sets the optional parameter "name": Required. A namespaced tag value name in the following format: `{parentId}/{tagKeyShort}/{tagValueShort}` Examples: - `42/foo/abc` for a value with short name "abc" under the key with 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" under the project with ID "r2-d2"

type TagValuesListCall ¶

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

func (*TagValuesListCall) Context ¶

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

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

func (*TagValuesListCall) Do ¶

func (c *TagValuesListCall) Do(opts ...googleapi.CallOption) (*ListTagValuesResponse, error)

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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagValuesListCall) Fields ¶

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

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

func (*TagValuesListCall) Header ¶

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

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

func (*TagValuesListCall) IfNoneMatch ¶

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

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

func (*TagValuesListCall) PageSize ¶

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

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

func (*TagValuesListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to `ListTagValues` that indicates where this listing should continue from.

func (*TagValuesListCall) Pages ¶

func (c *TagValuesListCall) Pages(ctx context.Context, f func(*ListTagValuesResponse) error) error

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

func (*TagValuesListCall) Parent ¶

func (c *TagValuesListCall) Parent(parent string) *TagValuesListCall

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

type TagValuesPatchCall ¶

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

func (*TagValuesPatchCall) Context ¶

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

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

func (*TagValuesPatchCall) Do ¶

func (c *TagValuesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagValuesPatchCall) Fields ¶

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

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

func (*TagValuesPatchCall) Header ¶

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

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

func (*TagValuesPatchCall) UpdateMask ¶

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

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

func (*TagValuesPatchCall) ValidateOnly ¶

func (c *TagValuesPatchCall) ValidateOnly(validateOnly bool) *TagValuesPatchCall

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

type TagValuesService ¶

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

func NewTagValuesService ¶

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 another request with the same parameters is sent while the original request is in process the second request will receive an error. A maximum of 1000 TagValues can exist under a TagKey at any given time.

func (*TagValuesService) Delete ¶

func (r *TagValuesService) Delete(name string) *TagValuesDeleteCall

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

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

func (*TagValuesService) Get ¶

func (r *TagValuesService) Get(name string) *TagValuesGetCall

Get: Retrieves a TagValue. This method will return `PERMISSION_DENIED` if the 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(resource string, getiampolicyrequest *GetIamPolicyRequest) *TagValuesGetIamPolicyCall

GetIamPolicy: Gets the access control policy for a TagValue. The returned policy 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 on the identified TagValue to get the access control policy.

• resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*TagValuesService) GetNamespaced ¶

func (r *TagValuesService) GetNamespaced() *TagValuesGetNamespacedCall

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

func (*TagValuesService) List ¶

func (r *TagValuesService) List() *TagValuesListCall

List: Lists all TagValues for a specific TagKey.

func (*TagValuesService) Patch ¶

func (r *TagValuesService) Patch(name string, 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(resource string, setiampolicyrequest *SetIamPolicyRequest) *TagValuesSetIamPolicyCall

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

• resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*TagValuesService) TestIamPermissions ¶

func (r *TagValuesService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *TagValuesTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specified TagValue. The `resource` field should be the TagValue's resource name. For example: `tagValues/1234`. There are no permissions required for making this API call.

• resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

type TagValuesSetIamPolicyCall ¶

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

func (*TagValuesSetIamPolicyCall) Context ¶

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

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

func (*TagValuesSetIamPolicyCall) Do ¶

func (c *TagValuesSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagValuesSetIamPolicyCall) Fields ¶

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

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

func (*TagValuesSetIamPolicyCall) Header ¶

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

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

type TagValuesTagHoldsCreateCall ¶

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

func (*TagValuesTagHoldsCreateCall) Context ¶

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

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

func (*TagValuesTagHoldsCreateCall) Do ¶

func (c *TagValuesTagHoldsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagValuesTagHoldsCreateCall) Fields ¶

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

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

func (*TagValuesTagHoldsCreateCall) Header ¶

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

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

func (*TagValuesTagHoldsCreateCall) ValidateOnly ¶

func (c *TagValuesTagHoldsCreateCall) ValidateOnly(validateOnly bool) *TagValuesTagHoldsCreateCall

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

type TagValuesTagHoldsDeleteCall ¶

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

func (*TagValuesTagHoldsDeleteCall) Context ¶

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

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

func (*TagValuesTagHoldsDeleteCall) Do ¶

func (c *TagValuesTagHoldsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagValuesTagHoldsDeleteCall) Fields ¶

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

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

func (*TagValuesTagHoldsDeleteCall) Header ¶

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

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

func (*TagValuesTagHoldsDeleteCall) ValidateOnly ¶

func (c *TagValuesTagHoldsDeleteCall) ValidateOnly(validateOnly bool) *TagValuesTagHoldsDeleteCall

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

type TagValuesTagHoldsListCall ¶

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

func (*TagValuesTagHoldsListCall) Context ¶

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

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

func (*TagValuesTagHoldsListCall) Do ¶

func (c *TagValuesTagHoldsListCall) Do(opts ...googleapi.CallOption) (*ListTagHoldsResponse, error)

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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagValuesTagHoldsListCall) Fields ¶

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

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

func (*TagValuesTagHoldsListCall) Filter ¶

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

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

func (*TagValuesTagHoldsListCall) Header ¶

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

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

func (*TagValuesTagHoldsListCall) IfNoneMatch ¶

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

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

func (*TagValuesTagHoldsListCall) PageSize ¶

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

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

func (*TagValuesTagHoldsListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to `ListTagHolds` that indicates where this listing should continue from.

func (*TagValuesTagHoldsListCall) Pages ¶

func (c *TagValuesTagHoldsListCall) Pages(ctx context.Context, f func(*ListTagHoldsResponse) error) error

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

type TagValuesTagHoldsService ¶

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

func NewTagValuesTagHoldsService ¶

func NewTagValuesTagHoldsService(s *Service) *TagValuesTagHoldsService

func (*TagValuesTagHoldsService) Create ¶

func (r *TagValuesTagHoldsService) Create(parent string, taghold *TagHold) *TagValuesTagHoldsCreateCall

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

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

func (*TagValuesTagHoldsService) Delete ¶

func (r *TagValuesTagHoldsService) Delete(name string) *TagValuesTagHoldsDeleteCall

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) List ¶

func (r *TagValuesTagHoldsService) List(parent string) *TagValuesTagHoldsListCall

List: Lists TagHolds under a TagValue.

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

type TagValuesTestIamPermissionsCall ¶

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

func (*TagValuesTestIamPermissionsCall) Context ¶

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

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

func (*TagValuesTestIamPermissionsCall) Do ¶

func (c *TagValuesTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TagValuesTestIamPermissionsCall) Fields ¶

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

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

func (*TagValuesTestIamPermissionsCall) Header ¶

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

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

type TestIamPermissionsRequest ¶

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

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

func (*TestIamPermissionsRequest) MarshalJSON ¶

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

type TestIamPermissionsResponse ¶

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

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

func (*TestIamPermissionsResponse) MarshalJSON ¶

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

type UndeleteFolderMetadata ¶

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

type UndeleteFolderMetadata struct {
}

type UndeleteFolderRequest ¶

UndeleteFolderRequest: The UndeleteFolder request message.

type UndeleteFolderRequest struct {
}

type UndeleteOrganizationMetadata ¶

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

type UndeleteOrganizationMetadata struct {
}

type UndeleteProjectMetadata ¶

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

type UndeleteProjectMetadata struct {
}

type UndeleteProjectRequest ¶

UndeleteProjectRequest: The request sent to the UndeleteProject method.

type UndeleteProjectRequest struct {
}

type UpdateFolderMetadata ¶

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

type UpdateFolderMetadata struct {
}

type UpdateProjectMetadata ¶

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

type UpdateProjectMetadata struct {
}

type UpdateTagKeyMetadata ¶

UpdateTagKeyMetadata: Runtime operation information for updating a TagKey.

type UpdateTagKeyMetadata struct {
}

type UpdateTagValueMetadata ¶

UpdateTagValueMetadata: Runtime operation information for updating a TagValue.

type UpdateTagValueMetadata struct {
}